Repository: incubator-juneau-website Updated Branches: refs/heads/asf-site 9b48e2125 -> eb4c8dda4
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/eb4c8dda/content/site/apidocs/src-html/org/apache/juneau/rest/RestContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/rest/RestContext.html b/content/site/apidocs/src-html/org/apache/juneau/rest/RestContext.html index 9b2c065..6336ccd 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/rest/RestContext.html +++ b/content/site/apidocs/src-html/org/apache/juneau/rest/RestContext.html @@ -732,7 +732,7 @@ <span class="sourceLineNo">724</span> * <js>"editLevel: servlet:/editLevel?logger=$A{attribute.name, OFF}"</js><a name="line.724"></a> <span class="sourceLineNo">725</span> * }<a name="line.725"></a> <span class="sourceLineNo">726</span> * header={<a name="line.726"></a> -<span class="sourceLineNo">727</span> * "<h1>$L{MyLocalizedPageTitle}"</js><a name="line.727"></a> +<span class="sourceLineNo">727</span> * "&lt;h1&gt;$L{MyLocalizedPageTitle}&lt;/h1&gt;"</js><a name="line.727"></a> <span class="sourceLineNo">728</span> * },<a name="line.728"></a> <span class="sourceLineNo">729</span> * aside={<a name="line.729"></a> <span class="sourceLineNo">730</span> * <js>"$F{resources/AsideText.html}"</js><a name="line.730"></a> @@ -745,1016 +745,1021 @@ <span class="sourceLineNo">737</span> * <p><a name="line.737"></a> <span class="sourceLineNo">738</span> * The following is the default list of supported variables:<a name="line.738"></a> <span class="sourceLineNo">739</span> * <ul><a name="line.739"></a> -<span class="sourceLineNo">740</span> * <li><code>$S{systemProperty[,defaultValue]}</code> - System property. See {@link SystemPropertiesVar}.<a name="line.740"></a> +<span class="sourceLineNo">740</span> * <li><code>$C{key[,defaultValue]}</code> - Config file entry. See {@link ConfigFileVar}.<a name="line.740"></a> <span class="sourceLineNo">741</span> * <li><code>$E{envVar[,defaultValue]}</code> - Environment variable. See {@link EnvVariablesVar}.<a name="line.741"></a> -<span class="sourceLineNo">742</span> * <li><code>$C{key[,defaultValue]}</code> - Config file entry. See {@link ConfigFileVar}.<a name="line.742"></a> -<span class="sourceLineNo">743</span> * <li><code>$F{key[,defaultValue]}</code> - File resource. See {@link FileVar}.<a name="line.743"></a> +<span class="sourceLineNo">742</span> * <li><code>$F{key[,defaultValue]}</code> - File resource. See {@link FileVar}.<a name="line.742"></a> +<span class="sourceLineNo">743</span> * <li><code>$I{key[,defaultValue]}</code> - Servlet init parameter. See {@link ServletInitParamVar}.<a name="line.743"></a> <span class="sourceLineNo">744</span> * <li><code>$L{key[,args...]}</code> - Localized message. See {@link LocalizationVar}.<a name="line.744"></a> <span class="sourceLineNo">745</span> * <li><code>$R{key[,args...]}</code> - Request variable. See {@link RequestVar}.<a name="line.745"></a> -<span class="sourceLineNo">746</span> * <li><code>$SA{contentType,key[,defaultValue]}</code> - Serialized request attribute. See {@link SerializedRequestAttrVar}.<a name="line.746"></a> -<span class="sourceLineNo">747</span> * <li><code>$I{key[,defaultValue]}</code> - Servlet init parameter. See {@link ServletInitParamVar}.<a name="line.747"></a> +<span class="sourceLineNo">746</span> * <li><code>$S{systemProperty[,defaultValue]}</code> - System property. See {@link SystemPropertiesVar}.<a name="line.746"></a> +<span class="sourceLineNo">747</span> * <li><code>$SA{contentType,key[,defaultValue]}</code> - Serialized request attribute. See {@link SerializedRequestAttrVar}.<a name="line.747"></a> <span class="sourceLineNo">748</span> * <li><code>$U{uri}</code> - URI resolver. See {@link UrlVar}.<a name="line.748"></a> <span class="sourceLineNo">749</span> * <li><code>$UE{uriPart}</code> - URL-Encoder. See {@link UrlEncodeVar}.<a name="line.749"></a> <span class="sourceLineNo">750</span> * <li><code>$W{widgetName}</code> - HTML widget variable. See {@link WidgetVar}.<a name="line.750"></a> -<span class="sourceLineNo">751</span> * <li><code>$IF{booleanArg,thenValue[,elseValue]}</code> - If/else variable. See {@link IfVar}.<a name="line.751"></a> -<span class="sourceLineNo">752</span> * <li><code>$SW{stringArg(,pattern,thenValue)+[,elseValue]}</code> - Switch variable. See {@link SwitchVar}.<a name="line.752"></a> +<span class="sourceLineNo">751</span> * <p><a name="line.751"></a> +<span class="sourceLineNo">752</span> *<a name="line.752"></a> <span class="sourceLineNo">753</span> * <p><a name="line.753"></a> -<span class="sourceLineNo">754</span> *<a name="line.754"></a> -<span class="sourceLineNo">755</span> * <p><a name="line.755"></a> -<span class="sourceLineNo">756</span> * The list of variables can be extended using the {@link RestConfig#addVars(Class...)} method.<a name="line.756"></a> -<span class="sourceLineNo">757</span> * For example, this is used to add support for the Args and Manifest-File variables in the microservice<a name="line.757"></a> -<span class="sourceLineNo">758</span> * <code>Resource</code> class.<a name="line.758"></a> +<span class="sourceLineNo">754</span> * The following syntax variables are also provided:<a name="line.754"></a> +<span class="sourceLineNo">755</span> * <ul><a name="line.755"></a> +<span class="sourceLineNo">756</span> * <li><code>$IF{booleanArg,thenValue[,elseValue]}</code> - If/else variable. See {@link IfVar}.<a name="line.756"></a> +<span class="sourceLineNo">757</span> * <li><code>$SW{stringArg(,pattern,thenValue)+[,elseValue]}</code> - Switch variable. See {@link SwitchVar}.<a name="line.757"></a> +<span class="sourceLineNo">758</span> * </ul><a name="line.758"></a> <span class="sourceLineNo">759</span> *<a name="line.759"></a> -<span class="sourceLineNo">760</span> * @return The var resolver in use by this resource.<a name="line.760"></a> -<span class="sourceLineNo">761</span> */<a name="line.761"></a> -<span class="sourceLineNo">762</span> public VarResolver getVarResolver() {<a name="line.762"></a> -<span class="sourceLineNo">763</span> return varResolver;<a name="line.763"></a> -<span class="sourceLineNo">764</span> }<a name="line.764"></a> -<span class="sourceLineNo">765</span><a name="line.765"></a> -<span class="sourceLineNo">766</span> /**<a name="line.766"></a> -<span class="sourceLineNo">767</span> * Returns the config file associated with this servlet.<a name="line.767"></a> -<span class="sourceLineNo">768</span> *<a name="line.768"></a> -<span class="sourceLineNo">769</span> * <p><a name="line.769"></a> -<span class="sourceLineNo">770</span> * The config file is identified via one of the following:<a name="line.770"></a> -<span class="sourceLineNo">771</span> * <ul><a name="line.771"></a> -<span class="sourceLineNo">772</span> * <li>{@link RestResource#config() @RestResource.config()} annotation.<a name="line.772"></a> -<span class="sourceLineNo">773</span> * <li>{@link RestConfig#setConfigFile(ConfigFile)} method.<a name="line.773"></a> -<span class="sourceLineNo">774</span> * </ul><a name="line.774"></a> -<span class="sourceLineNo">775</span> *<a name="line.775"></a> -<span class="sourceLineNo">776</span> * @return The resolving config file associated with this servlet. Never <jk>null</jk>.<a name="line.776"></a> -<span class="sourceLineNo">777</span> */<a name="line.777"></a> -<span class="sourceLineNo">778</span> public ConfigFile getConfigFile() {<a name="line.778"></a> -<span class="sourceLineNo">779</span> return configFile;<a name="line.779"></a> -<span class="sourceLineNo">780</span> }<a name="line.780"></a> -<span class="sourceLineNo">781</span><a name="line.781"></a> -<span class="sourceLineNo">782</span> /**<a name="line.782"></a> -<span class="sourceLineNo">783</span> * Resolve a static resource file.<a name="line.783"></a> -<span class="sourceLineNo">784</span> *<a name="line.784"></a> -<span class="sourceLineNo">785</span> * <p><a name="line.785"></a> -<span class="sourceLineNo">786</span> * The location of static resources are defined via one of the following:<a name="line.786"></a> -<span class="sourceLineNo">787</span> * <ul><a name="line.787"></a> -<span class="sourceLineNo">788</span> * <li>{@link RestResource#staticFiles() @RestResource.staticFiles()} annotation.<a name="line.788"></a> -<span class="sourceLineNo">789</span> * <li>{@link RestConfig#addStaticFiles(Class, String)} method.<a name="line.789"></a> -<span class="sourceLineNo">790</span> * </ul><a name="line.790"></a> -<span class="sourceLineNo">791</span> *<a name="line.791"></a> -<span class="sourceLineNo">792</span> * @param pathInfo The unencoded path info.<a name="line.792"></a> -<span class="sourceLineNo">793</span> * @return The resource, or <jk>null</jk> if the resource could not be resolved.<a name="line.793"></a> -<span class="sourceLineNo">794</span> * @throws IOException<a name="line.794"></a> -<span class="sourceLineNo">795</span> */<a name="line.795"></a> -<span class="sourceLineNo">796</span> public StreamResource resolveStaticFile(String pathInfo) throws IOException {<a name="line.796"></a> -<span class="sourceLineNo">797</span> if (! staticFilesCache.containsKey(pathInfo)) {<a name="line.797"></a> -<span class="sourceLineNo">798</span> String p = urlDecode(trimSlashes(pathInfo));<a name="line.798"></a> -<span class="sourceLineNo">799</span> if (p.indexOf("..") != -1)<a name="line.799"></a> -<span class="sourceLineNo">800</span> throw new RestException(SC_NOT_FOUND, "Invalid path");<a name="line.800"></a> -<span class="sourceLineNo">801</span> for (Map.Entry<String,String> e : staticFilesMap.entrySet()) {<a name="line.801"></a> -<span class="sourceLineNo">802</span> String key = trimSlashes(e.getKey());<a name="line.802"></a> -<span class="sourceLineNo">803</span> if (p.startsWith(key)) {<a name="line.803"></a> -<span class="sourceLineNo">804</span> String remainder = (p.equals(key) ? "" : p.substring(key.length()));<a name="line.804"></a> -<span class="sourceLineNo">805</span> if (remainder.isEmpty() || remainder.startsWith("/")) {<a name="line.805"></a> -<span class="sourceLineNo">806</span> String p2 = trimSlashes(e.getValue()) + remainder;<a name="line.806"></a> -<span class="sourceLineNo">807</span> InputStream is = getResource(p2, null);<a name="line.807"></a> -<span class="sourceLineNo">808</span> if (is != null) {<a name="line.808"></a> -<span class="sourceLineNo">809</span> try {<a name="line.809"></a> -<span class="sourceLineNo">810</span> int i = p2.lastIndexOf('/');<a name="line.810"></a> -<span class="sourceLineNo">811</span> String name = (i == -1 ? p2 : p2.substring(i+1));<a name="line.811"></a> -<span class="sourceLineNo">812</span> String mediaType = mimetypesFileTypeMap.getContentType(name);<a name="line.812"></a> -<span class="sourceLineNo">813</span> ObjectMap headers = new ObjectMap().append("Cache-Control", "max-age=86400, public");<a name="line.813"></a> -<span class="sourceLineNo">814</span> staticFilesCache.put(pathInfo, new StreamResource(MediaType.forString(mediaType), headers, is));<a name="line.814"></a> -<span class="sourceLineNo">815</span> return staticFilesCache.get(pathInfo);<a name="line.815"></a> -<span class="sourceLineNo">816</span> } finally {<a name="line.816"></a> -<span class="sourceLineNo">817</span> is.close();<a name="line.817"></a> -<span class="sourceLineNo">818</span> }<a name="line.818"></a> -<span class="sourceLineNo">819</span> }<a name="line.819"></a> -<span class="sourceLineNo">820</span> }<a name="line.820"></a> -<span class="sourceLineNo">821</span> }<a name="line.821"></a> -<span class="sourceLineNo">822</span> }<a name="line.822"></a> -<span class="sourceLineNo">823</span> }<a name="line.823"></a> -<span class="sourceLineNo">824</span> return staticFilesCache.get(pathInfo);<a name="line.824"></a> -<span class="sourceLineNo">825</span> }<a name="line.825"></a> -<span class="sourceLineNo">826</span><a name="line.826"></a> -<span class="sourceLineNo">827</span> /**<a name="line.827"></a> -<span class="sourceLineNo">828</span> * Same as {@link Class#getResourceAsStream(String)} except if it doesn't find the resource on this class, searches<a name="line.828"></a> -<span class="sourceLineNo">829</span> * up the parent hierarchy chain.<a name="line.829"></a> -<span class="sourceLineNo">830</span> *<a name="line.830"></a> -<span class="sourceLineNo">831</span> * <p><a name="line.831"></a> -<span class="sourceLineNo">832</span> * If the resource cannot be found in the classpath, then an attempt is made to look in the JVM working directory.<a name="line.832"></a> -<span class="sourceLineNo">833</span> *<a name="line.833"></a> -<span class="sourceLineNo">834</span> * <p><a name="line.834"></a> -<span class="sourceLineNo">835</span> * If the <code>locale</code> is specified, then we look for resources whose name matches that locale.<a name="line.835"></a> -<span class="sourceLineNo">836</span> * For example, if looking for the resource <js>"MyResource.txt"</js> for the Japanese locale, we will look for<a name="line.836"></a> -<span class="sourceLineNo">837</span> * files in the following order:<a name="line.837"></a> -<span class="sourceLineNo">838</span> * <ol><a name="line.838"></a> -<span class="sourceLineNo">839</span> * <li><js>"MyResource_ja_JP.txt"</js><a name="line.839"></a> -<span class="sourceLineNo">840</span> * <li><js>"MyResource_ja.txt"</js><a name="line.840"></a> -<span class="sourceLineNo">841</span> * <li><js>"MyResource.txt"</js><a name="line.841"></a> -<span class="sourceLineNo">842</span> * </ol><a name="line.842"></a> -<span class="sourceLineNo">843</span> *<a name="line.843"></a> -<span class="sourceLineNo">844</span> * @param name The resource name.<a name="line.844"></a> -<span class="sourceLineNo">845</span> * @param locale Optional locale.<a name="line.845"></a> -<span class="sourceLineNo">846</span> * @return An input stream of the resource, or <jk>null</jk> if the resource could not be found.<a name="line.846"></a> -<span class="sourceLineNo">847</span> * @throws IOException<a name="line.847"></a> -<span class="sourceLineNo">848</span> */<a name="line.848"></a> -<span class="sourceLineNo">849</span> protected InputStream getResource(String name, Locale locale) throws IOException {<a name="line.849"></a> -<span class="sourceLineNo">850</span> return resourceFinder.getResourceAsStream(name, locale);<a name="line.850"></a> -<span class="sourceLineNo">851</span> }<a name="line.851"></a> -<span class="sourceLineNo">852</span><a name="line.852"></a> -<span class="sourceLineNo">853</span> /**<a name="line.853"></a> -<span class="sourceLineNo">854</span> * Reads the input stream from {@link #getResource(String, Locale)} into a String.<a name="line.854"></a> -<span class="sourceLineNo">855</span> *<a name="line.855"></a> -<span class="sourceLineNo">856</span> * @param name The resource name.<a name="line.856"></a> -<span class="sourceLineNo">857</span> * @param locale Optional locale.<a name="line.857"></a> -<span class="sourceLineNo">858</span> * @return The contents of the stream as a string, or <jk>null</jk> if the resource could not be found.<a name="line.858"></a> -<span class="sourceLineNo">859</span> * @throws IOException If resource could not be found.<a name="line.859"></a> -<span class="sourceLineNo">860</span> */<a name="line.860"></a> -<span class="sourceLineNo">861</span> public String getResourceAsString(String name, Locale locale) throws IOException {<a name="line.861"></a> -<span class="sourceLineNo">862</span> return resourceFinder.getResourceAsString(name, locale);<a name="line.862"></a> -<span class="sourceLineNo">863</span> }<a name="line.863"></a> -<span class="sourceLineNo">864</span><a name="line.864"></a> -<span class="sourceLineNo">865</span> /**<a name="line.865"></a> -<span class="sourceLineNo">866</span> * Reads the input stream from {@link #getResource(String, Locale)} and parses it into a POJO using the parser<a name="line.866"></a> -<span class="sourceLineNo">867</span> * matched by the specified media type.<a name="line.867"></a> -<span class="sourceLineNo">868</span> *<a name="line.868"></a> -<span class="sourceLineNo">869</span> * <p><a name="line.869"></a> -<span class="sourceLineNo">870</span> * Useful if you want to load predefined POJOs from JSON files in your classpath.<a name="line.870"></a> -<span class="sourceLineNo">871</span> *<a name="line.871"></a> -<span class="sourceLineNo">872</span> * @param c The class type of the POJO to create.<a name="line.872"></a> -<span class="sourceLineNo">873</span> * @param mediaType The media type of the data in the stream (e.g. <js>"text/json"</js>)<a name="line.873"></a> -<span class="sourceLineNo">874</span> * @param name The resource name (e.g. "htdocs/styles.css").<a name="line.874"></a> -<span class="sourceLineNo">875</span> * @param locale Optional locale.<a name="line.875"></a> -<span class="sourceLineNo">876</span> * @return The parsed resource, or <jk>null</jk> if the resource could not be found.<a name="line.876"></a> -<span class="sourceLineNo">877</span> * @throws IOException<a name="line.877"></a> -<span class="sourceLineNo">878</span> * @throws ServletException If the media type was unknown or the input could not be parsed into a POJO.<a name="line.878"></a> -<span class="sourceLineNo">879</span> */<a name="line.879"></a> -<span class="sourceLineNo">880</span> public <T> T getResource(Class<T> c, MediaType mediaType, String name, Locale locale) throws IOException, ServletException {<a name="line.880"></a> -<span class="sourceLineNo">881</span> InputStream is = getResource(name, locale);<a name="line.881"></a> -<span class="sourceLineNo">882</span> if (is == null)<a name="line.882"></a> -<span class="sourceLineNo">883</span> return null;<a name="line.883"></a> -<span class="sourceLineNo">884</span> try {<a name="line.884"></a> -<span class="sourceLineNo">885</span> Parser p = parsers.getParser(mediaType);<a name="line.885"></a> -<span class="sourceLineNo">886</span> if (p != null) {<a name="line.886"></a> -<span class="sourceLineNo">887</span> try {<a name="line.887"></a> -<span class="sourceLineNo">888</span> if (p.isReaderParser())<a name="line.888"></a> -<span class="sourceLineNo">889</span> return p.parse(new InputStreamReader(is, UTF8), c);<a name="line.889"></a> -<span class="sourceLineNo">890</span> return p.parse(is, c);<a name="line.890"></a> -<span class="sourceLineNo">891</span> } catch (ParseException e) {<a name="line.891"></a> -<span class="sourceLineNo">892</span> throw new ServletException("Could not parse resource '' as media type '"+mediaType+"'.");<a name="line.892"></a> -<span class="sourceLineNo">893</span> }<a name="line.893"></a> -<span class="sourceLineNo">894</span> }<a name="line.894"></a> -<span class="sourceLineNo">895</span> throw new ServletException("Unknown media type '"+mediaType+"'");<a name="line.895"></a> -<span class="sourceLineNo">896</span> } catch (Exception e) {<a name="line.896"></a> -<span class="sourceLineNo">897</span> throw new ServletException("Could not parse resource with name '"+name+"'", e);<a name="line.897"></a> -<span class="sourceLineNo">898</span> }<a name="line.898"></a> -<span class="sourceLineNo">899</span> }<a name="line.899"></a> -<span class="sourceLineNo">900</span><a name="line.900"></a> -<span class="sourceLineNo">901</span> /**<a name="line.901"></a> -<span class="sourceLineNo">902</span> * Returns the path for this resource as defined by the {@link RestResource#path()} annotation or<a name="line.902"></a> -<span class="sourceLineNo">903</span> * {@link RestConfig#setPath(String)} method concatenated with those on all parent classes.<a name="line.903"></a> -<span class="sourceLineNo">904</span> *<a name="line.904"></a> -<span class="sourceLineNo">905</span> * <p><a name="line.905"></a> -<span class="sourceLineNo">906</span> * If path is not specified, returns <js>"/"</js>.<a name="line.906"></a> -<span class="sourceLineNo">907</span> *<a name="line.907"></a> -<span class="sourceLineNo">908</span> * <p><a name="line.908"></a> -<span class="sourceLineNo">909</span> * Path always starts with <js>"/"</js>.<a name="line.909"></a> -<span class="sourceLineNo">910</span> *<a name="line.910"></a> -<span class="sourceLineNo">911</span> * @return The servlet path.<a name="line.911"></a> -<span class="sourceLineNo">912</span> */<a name="line.912"></a> -<span class="sourceLineNo">913</span> public String getPath() {<a name="line.913"></a> -<span class="sourceLineNo">914</span> return fullPath;<a name="line.914"></a> -<span class="sourceLineNo">915</span> }<a name="line.915"></a> -<span class="sourceLineNo">916</span><a name="line.916"></a> -<span class="sourceLineNo">917</span> /**<a name="line.917"></a> -<span class="sourceLineNo">918</span> * The HTML page header contents.<a name="line.918"></a> -<span class="sourceLineNo">919</span> *<a name="line.919"></a> -<span class="sourceLineNo">920</span> * <p><a name="line.920"></a> -<span class="sourceLineNo">921</span> * Defined by the {@link HtmlDoc#header()} annotation or {@link RestConfig#setHtmlHeader(String)} method.<a name="line.921"></a> -<span class="sourceLineNo">922</span> *<a name="line.922"></a> -<span class="sourceLineNo">923</span> * @return The HTML page header contents.<a name="line.923"></a> -<span class="sourceLineNo">924</span> */<a name="line.924"></a> -<span class="sourceLineNo">925</span> public String getHtmlHeader() {<a name="line.925"></a> -<span class="sourceLineNo">926</span> return htmlHeader;<a name="line.926"></a> -<span class="sourceLineNo">927</span> }<a name="line.927"></a> -<span class="sourceLineNo">928</span><a name="line.928"></a> -<span class="sourceLineNo">929</span> /**<a name="line.929"></a> -<span class="sourceLineNo">930</span> * The HTML page nav section links.<a name="line.930"></a> -<span class="sourceLineNo">931</span> *<a name="line.931"></a> -<span class="sourceLineNo">932</span> * <p><a name="line.932"></a> -<span class="sourceLineNo">933</span> * Defined by the {@link HtmlDoc#links()} annotation or {@link RestConfig#setHtmlLinks(String[])} method.<a name="line.933"></a> -<span class="sourceLineNo">934</span> *<a name="line.934"></a> -<span class="sourceLineNo">935</span> * @return The HTML page nav section links.<a name="line.935"></a> -<span class="sourceLineNo">936</span> */<a name="line.936"></a> -<span class="sourceLineNo">937</span> public String[] getHtmlLinks() {<a name="line.937"></a> -<span class="sourceLineNo">938</span> return htmlLinks;<a name="line.938"></a> -<span class="sourceLineNo">939</span> }<a name="line.939"></a> -<span class="sourceLineNo">940</span><a name="line.940"></a> -<span class="sourceLineNo">941</span> /**<a name="line.941"></a> -<span class="sourceLineNo">942</span> * The HTML page nav section contents.<a name="line.942"></a> -<span class="sourceLineNo">943</span> *<a name="line.943"></a> -<span class="sourceLineNo">944</span> * <p><a name="line.944"></a> -<span class="sourceLineNo">945</span> * Defined by the {@link HtmlDoc#nav()} annotation or {@link RestConfig#setHtmlNav(String)} method.<a name="line.945"></a> -<span class="sourceLineNo">946</span> *<a name="line.946"></a> -<span class="sourceLineNo">947</span> * @return The HTML page nav section contents.<a name="line.947"></a> -<span class="sourceLineNo">948</span> */<a name="line.948"></a> -<span class="sourceLineNo">949</span> public String getHtmlNav() {<a name="line.949"></a> -<span class="sourceLineNo">950</span> return htmlNav;<a name="line.950"></a> -<span class="sourceLineNo">951</span> }<a name="line.951"></a> -<span class="sourceLineNo">952</span><a name="line.952"></a> -<span class="sourceLineNo">953</span> /**<a name="line.953"></a> -<span class="sourceLineNo">954</span> * The HTML page aside section contents.<a name="line.954"></a> -<span class="sourceLineNo">955</span> *<a name="line.955"></a> -<span class="sourceLineNo">956</span> * <p><a name="line.956"></a> -<span class="sourceLineNo">957</span> * Defined by the {@link HtmlDoc#aside()} annotation or {@link RestConfig#setHtmlAside(String)} method.<a name="line.957"></a> -<span class="sourceLineNo">958</span> *<a name="line.958"></a> -<span class="sourceLineNo">959</span> * @return The HTML page aside section contents.<a name="line.959"></a> -<span class="sourceLineNo">960</span> */<a name="line.960"></a> -<span class="sourceLineNo">961</span> public String getHtmlAside() {<a name="line.961"></a> -<span class="sourceLineNo">962</span> return htmlAside;<a name="line.962"></a> -<span class="sourceLineNo">963</span> }<a name="line.963"></a> -<span class="sourceLineNo">964</span><a name="line.964"></a> -<span class="sourceLineNo">965</span> /**<a name="line.965"></a> -<span class="sourceLineNo">966</span> * The HTML page footer section contents.<a name="line.966"></a> -<span class="sourceLineNo">967</span> *<a name="line.967"></a> -<span class="sourceLineNo">968</span> * <p><a name="line.968"></a> -<span class="sourceLineNo">969</span> * Defined by the {@link HtmlDoc#footer()} annotation or {@link RestConfig#setHtmlFooter(String)} method.<a name="line.969"></a> -<span class="sourceLineNo">970</span> *<a name="line.970"></a> -<span class="sourceLineNo">971</span> * @return The HTML page footer section contents.<a name="line.971"></a> -<span class="sourceLineNo">972</span> */<a name="line.972"></a> -<span class="sourceLineNo">973</span> public String getHtmlFooter() {<a name="line.973"></a> -<span class="sourceLineNo">974</span> return htmlFooter;<a name="line.974"></a> -<span class="sourceLineNo">975</span> }<a name="line.975"></a> -<span class="sourceLineNo">976</span><a name="line.976"></a> -<span class="sourceLineNo">977</span> /**<a name="line.977"></a> -<span class="sourceLineNo">978</span> * The HTML page stylesheet URL.<a name="line.978"></a> -<span class="sourceLineNo">979</span> *<a name="line.979"></a> -<span class="sourceLineNo">980</span> * <p><a name="line.980"></a> -<span class="sourceLineNo">981</span> * Defined by the {@link HtmlDoc#stylesheet()} annotation or {@link RestConfig#setHtmlStylesheet(String)} method.<a name="line.981"></a> -<span class="sourceLineNo">982</span> *<a name="line.982"></a> -<span class="sourceLineNo">983</span> * @return The HTML page CSS URL.<a name="line.983"></a> -<span class="sourceLineNo">984</span> */<a name="line.984"></a> -<span class="sourceLineNo">985</span> public String getHtmlStylesheet() {<a name="line.985"></a> -<span class="sourceLineNo">986</span> return htmlStylesheet;<a name="line.986"></a> -<span class="sourceLineNo">987</span> }<a name="line.987"></a> -<span class="sourceLineNo">988</span><a name="line.988"></a> -<span class="sourceLineNo">989</span> /**<a name="line.989"></a> -<span class="sourceLineNo">990</span> * The HTML page CSS contents.<a name="line.990"></a> -<span class="sourceLineNo">991</span> *<a name="line.991"></a> -<span class="sourceLineNo">992</span> * <p><a name="line.992"></a> -<span class="sourceLineNo">993</span> * Defined by the {@link HtmlDoc#style()} annotation or {@link RestConfig#setHtmlStyle(String)} method.<a name="line.993"></a> -<span class="sourceLineNo">994</span> *<a name="line.994"></a> -<span class="sourceLineNo">995</span> * @return The HTML page CSS contents.<a name="line.995"></a> -<span class="sourceLineNo">996</span> */<a name="line.996"></a> -<span class="sourceLineNo">997</span> public String getHtmlStyle() {<a name="line.997"></a> -<span class="sourceLineNo">998</span> return htmlStyle;<a name="line.998"></a> -<span class="sourceLineNo">999</span> }<a name="line.999"></a> -<span class="sourceLineNo">1000</span><a name="line.1000"></a> -<span class="sourceLineNo">1001</span> /**<a name="line.1001"></a> -<span class="sourceLineNo">1002</span> * The HTML page Javascript contents.<a name="line.1002"></a> -<span class="sourceLineNo">1003</span> *<a name="line.1003"></a> -<span class="sourceLineNo">1004</span> * <p><a name="line.1004"></a> -<span class="sourceLineNo">1005</span> * Defined by the {@link HtmlDoc#script()} annotation or {@link RestConfig#setHtmlScript(String)} method.<a name="line.1005"></a> -<span class="sourceLineNo">1006</span> *<a name="line.1006"></a> -<span class="sourceLineNo">1007</span> * @return The HTML page Javascript contents.<a name="line.1007"></a> -<span class="sourceLineNo">1008</span> */<a name="line.1008"></a> -<span class="sourceLineNo">1009</span> public String getHtmlScript() {<a name="line.1009"></a> -<span class="sourceLineNo">1010</span> return htmlScript;<a name="line.1010"></a> -<span class="sourceLineNo">1011</span> }<a name="line.1011"></a> -<span class="sourceLineNo">1012</span><a name="line.1012"></a> -<span class="sourceLineNo">1013</span> /**<a name="line.1013"></a> -<span class="sourceLineNo">1014</span> * The HTML page nowrap setting.<a name="line.1014"></a> -<span class="sourceLineNo">1015</span> *<a name="line.1015"></a> -<span class="sourceLineNo">1016</span> * <p><a name="line.1016"></a> -<span class="sourceLineNo">1017</span> * Defined by the {@link HtmlDoc#nowrap()} annotation or {@link RestConfig#setHtmlNoWrap(boolean)} method.<a name="line.1017"></a> -<span class="sourceLineNo">1018</span> *<a name="line.1018"></a> -<span class="sourceLineNo">1019</span> * @return The HTML page nowrap setting.<a name="line.1019"></a> -<span class="sourceLineNo">1020</span> */<a name="line.1020"></a> -<span class="sourceLineNo">1021</span> public boolean getHtmlNoWrap() {<a name="line.1021"></a> -<span class="sourceLineNo">1022</span> return htmlNoWrap;<a name="line.1022"></a> -<span class="sourceLineNo">1023</span> }<a name="line.1023"></a> -<span class="sourceLineNo">1024</span><a name="line.1024"></a> -<span class="sourceLineNo">1025</span> /**<a name="line.1025"></a> -<span class="sourceLineNo">1026</span> * The HTML page template.<a name="line.1026"></a> -<span class="sourceLineNo">1027</span> *<a name="line.1027"></a> -<span class="sourceLineNo">1028</span> * <p><a name="line.1028"></a> -<span class="sourceLineNo">1029</span> * Defined by the {@link HtmlDoc#template()} annotation or {@link RestConfig#setHtmlTemplate(Class)} method.<a name="line.1029"></a> -<span class="sourceLineNo">1030</span> *<a name="line.1030"></a> -<span class="sourceLineNo">1031</span> * @return The HTML page template.<a name="line.1031"></a> -<span class="sourceLineNo">1032</span> */<a name="line.1032"></a> -<span class="sourceLineNo">1033</span> public HtmlDocTemplate getHtmlTemplate() {<a name="line.1033"></a> -<span class="sourceLineNo">1034</span> return htmlTemplate;<a name="line.1034"></a> -<span class="sourceLineNo">1035</span> }<a name="line.1035"></a> -<span class="sourceLineNo">1036</span><a name="line.1036"></a> -<span class="sourceLineNo">1037</span> /**<a name="line.1037"></a> -<span class="sourceLineNo">1038</span> * The HTML page no-results message.<a name="line.1038"></a> -<span class="sourceLineNo">1039</span> *<a name="line.1039"></a> -<span class="sourceLineNo">1040</span> * <p><a name="line.1040"></a> -<span class="sourceLineNo">1041</span> * Defined by the {@link HtmlDoc#noResultsMessage()} annotation or {@link RestConfig#setHtmlNoResultsMessage(String)}<a name="line.1041"></a> -<span class="sourceLineNo">1042</span> * method.<a name="line.1042"></a> -<span class="sourceLineNo">1043</span> *<a name="line.1043"></a> -<span class="sourceLineNo">1044</span> * @return The HTML page no-results message.<a name="line.1044"></a> -<span class="sourceLineNo">1045</span> */<a name="line.1045"></a> -<span class="sourceLineNo">1046</span> public String getHtmlNoResultsMessage() {<a name="line.1046"></a> -<span class="sourceLineNo">1047</span> return htmlNoResultsMessage;<a name="line.1047"></a> -<span class="sourceLineNo">1048</span> }<a name="line.1048"></a> -<span class="sourceLineNo">1049</span><a name="line.1049"></a> -<span class="sourceLineNo">1050</span> /**<a name="line.1050"></a> -<span class="sourceLineNo">1051</span> * The widgets used for resolving <js>"$W{...}"<js> variables.<a name="line.1051"></a> -<span class="sourceLineNo">1052</span> *<a name="line.1052"></a> -<span class="sourceLineNo">1053</span> * <p><a name="line.1053"></a> -<span class="sourceLineNo">1054</span> * Defined by the {@link HtmlDoc#widgets()} annotation or {@link RestConfig#addHtmlWidget(Class)} method.<a name="line.1054"></a> -<span class="sourceLineNo">1055</span> *<a name="line.1055"></a> -<span class="sourceLineNo">1056</span> * @return The var resolver widgets as a map with keys being the name returned by {@link Widget#getName()}.<a name="line.1056"></a> -<span class="sourceLineNo">1057</span> */<a name="line.1057"></a> -<span class="sourceLineNo">1058</span> public Map<String,Widget> getHtmlWidgets() {<a name="line.1058"></a> -<span class="sourceLineNo">1059</span> return htmlWidgets;<a name="line.1059"></a> -<span class="sourceLineNo">1060</span> }<a name="line.1060"></a> -<span class="sourceLineNo">1061</span><a name="line.1061"></a> -<span class="sourceLineNo">1062</span> /**<a name="line.1062"></a> -<span class="sourceLineNo">1063</span> * Returns the logger to use for this resource.<a name="line.1063"></a> -<span class="sourceLineNo">1064</span> *<a name="line.1064"></a> -<span class="sourceLineNo">1065</span> * <p><a name="line.1065"></a> -<span class="sourceLineNo">1066</span> * The logger for a resource is defined via one of the following:<a name="line.1066"></a> -<span class="sourceLineNo">1067</span> * <ul><a name="line.1067"></a> -<span class="sourceLineNo">1068</span> * <li>{@link RestResource#logger() @RestResource.logger()} annotation.<a name="line.1068"></a> -<span class="sourceLineNo">1069</span> * <li>{@link RestConfig#setLogger(Class)}/{@link RestConfig#setLogger(RestLogger)} methods.<a name="line.1069"></a> -<span class="sourceLineNo">1070</span> * </ul><a name="line.1070"></a> -<span class="sourceLineNo">1071</span> *<a name="line.1071"></a> -<span class="sourceLineNo">1072</span> * @return The logger to use for this resource. Never <jk>null</jk>.<a name="line.1072"></a> -<span class="sourceLineNo">1073</span> */<a name="line.1073"></a> -<span class="sourceLineNo">1074</span> public RestLogger getLogger() {<a name="line.1074"></a> -<span class="sourceLineNo">1075</span> return logger;<a name="line.1075"></a> -<span class="sourceLineNo">1076</span> }<a name="line.1076"></a> -<span class="sourceLineNo">1077</span><a name="line.1077"></a> -<span class="sourceLineNo">1078</span> /**<a name="line.1078"></a> -<span class="sourceLineNo">1079</span> * Returns the resource bundle used by this resource.<a name="line.1079"></a> -<span class="sourceLineNo">1080</span> *<a name="line.1080"></a> -<span class="sourceLineNo">1081</span> * <p><a name="line.1081"></a> -<span class="sourceLineNo">1082</span> * The resource bundle is defined via one of the following:<a name="line.1082"></a> -<span class="sourceLineNo">1083</span> * <ul><a name="line.1083"></a> -<span class="sourceLineNo">1084</span> * <li>{@link RestResource#messages() @RestResource.messages()} annotation.<a name="line.1084"></a> -<span class="sourceLineNo">1085</span> * </ul><a name="line.1085"></a> -<span class="sourceLineNo">1086</span> *<a name="line.1086"></a> -<span class="sourceLineNo">1087</span> * @return The resource bundle for this resource. Never <jk>null</jk>.<a name="line.1087"></a> -<span class="sourceLineNo">1088</span> */<a name="line.1088"></a> -<span class="sourceLineNo">1089</span> public MessageBundle getMessages() {<a name="line.1089"></a> -<span class="sourceLineNo">1090</span> return msgs;<a name="line.1090"></a> -<span class="sourceLineNo">1091</span> }<a name="line.1091"></a> -<span class="sourceLineNo">1092</span><a name="line.1092"></a> -<span class="sourceLineNo">1093</span> /**<a name="line.1093"></a> -<span class="sourceLineNo">1094</span> * Returns the REST information provider used by this resource.<a name="line.1094"></a> -<span class="sourceLineNo">1095</span> *<a name="line.1095"></a> -<span class="sourceLineNo">1096</span> * <p><a name="line.1096"></a> -<span class="sourceLineNo">1097</span> * The information provider is defined via one of the following:<a name="line.1097"></a> -<span class="sourceLineNo">1098</span> * <ul><a name="line.1098"></a> -<span class="sourceLineNo">1099</span> * <li>{@link RestResource#infoProvider() @RestResource.infoProvider()} annotation.<a name="line.1099"></a> -<span class="sourceLineNo">1100</span> * <li>{@link RestConfig#setInfoProvider(Class)}/{@link RestConfig#setInfoProvider(RestInfoProvider)} methods.<a name="line.1100"></a> -<span class="sourceLineNo">1101</span> * </ul><a name="line.1101"></a> -<span class="sourceLineNo">1102</span> *<a name="line.1102"></a> -<span class="sourceLineNo">1103</span> * @return The information provider for this resource. Never <jk>null</jk>.<a name="line.1103"></a> -<span class="sourceLineNo">1104</span> */<a name="line.1104"></a> -<span class="sourceLineNo">1105</span> public RestInfoProvider getInfoProvider() {<a name="line.1105"></a> -<span class="sourceLineNo">1106</span> return infoProvider;<a name="line.1106"></a> -<span class="sourceLineNo">1107</span> }<a name="line.1107"></a> -<span class="sourceLineNo">1108</span><a name="line.1108"></a> -<span class="sourceLineNo">1109</span> /**<a name="line.1109"></a> -<span class="sourceLineNo">1110</span> * Returns the REST call handler used by this resource.<a name="line.1110"></a> -<span class="sourceLineNo">1111</span> *<a name="line.1111"></a> -<span class="sourceLineNo">1112</span> * <p><a name="line.1112"></a> -<span class="sourceLineNo">1113</span> * The call handler is defined via one of the following:<a name="line.1113"></a> -<span class="sourceLineNo">1114</span> * <ul><a name="line.1114"></a> -<span class="sourceLineNo">1115</span> * <li>{@link RestResource#callHandler() @RestResource.callHandler()} annotation.<a name="line.1115"></a> -<span class="sourceLineNo">1116</span> * <li>{@link RestConfig#setCallHandler(Class)}/{@link RestConfig#setCallHandler(RestCallHandler)} methods.<a name="line.1116"></a> -<span class="sourceLineNo">1117</span> * </ul><a name="line.1117"></a> -<span class="sourceLineNo">1118</span> *<a name="line.1118"></a> -<span class="sourceLineNo">1119</span> * @return The call handler for this resource. Never <jk>null</jk>.<a name="line.1119"></a> -<span class="sourceLineNo">1120</span> */<a name="line.1120"></a> -<span class="sourceLineNo">1121</span> protected RestCallHandler getCallHandler() {<a name="line.1121"></a> -<span class="sourceLineNo">1122</span> return callHandler;<a name="line.1122"></a> -<span class="sourceLineNo">1123</span> }<a name="line.1123"></a> -<span class="sourceLineNo">1124</span><a name="line.1124"></a> -<span class="sourceLineNo">1125</span> /**<a name="line.1125"></a> -<span class="sourceLineNo">1126</span> * Returns a map of HTTP method names to call routers.<a name="line.1126"></a> -<span class="sourceLineNo">1127</span> *<a name="line.1127"></a> -<span class="sourceLineNo">1128</span> * @return A map with HTTP method names upper-cased as the keys, and call routers as the values.<a name="line.1128"></a> -<span class="sourceLineNo">1129</span> */<a name="line.1129"></a> -<span class="sourceLineNo">1130</span> protected Map<String,CallRouter> getCallRouters() {<a name="line.1130"></a> -<span class="sourceLineNo">1131</span> return callRouters;<a name="line.1131"></a> -<span class="sourceLineNo">1132</span> }<a name="line.1132"></a> -<span class="sourceLineNo">1133</span><a name="line.1133"></a> -<span class="sourceLineNo">1134</span> /**<a name="line.1134"></a> -<span class="sourceLineNo">1135</span> * Returns the resource object.<a name="line.1135"></a> -<span class="sourceLineNo">1136</span> *<a name="line.1136"></a> -<span class="sourceLineNo">1137</span> * <p><a name="line.1137"></a> -<span class="sourceLineNo">1138</span> * This is the instance of the class annotated with the {@link RestResource @RestResource} annotation, usually<a name="line.1138"></a> -<span class="sourceLineNo">1139</span> * an instance of {@link RestServlet}.<a name="line.1139"></a> -<span class="sourceLineNo">1140</span> *<a name="line.1140"></a> -<span class="sourceLineNo">1141</span> * @return The resource object. Never <jk>null</jk>.<a name="line.1141"></a> -<span class="sourceLineNo">1142</span> */<a name="line.1142"></a> -<span class="sourceLineNo">1143</span> public Object getResource() {<a name="line.1143"></a> -<span class="sourceLineNo">1144</span> return resource;<a name="line.1144"></a> -<span class="sourceLineNo">1145</span> }<a name="line.1145"></a> -<span class="sourceLineNo">1146</span><a name="line.1146"></a> -<span class="sourceLineNo">1147</span> /**<a name="line.1147"></a> -<span class="sourceLineNo">1148</span> * Returns the resource object as a {@link RestServlet}.<a name="line.1148"></a> -<span class="sourceLineNo">1149</span> *<a name="line.1149"></a> -<span class="sourceLineNo">1150</span> * @return<a name="line.1150"></a> -<span class="sourceLineNo">1151</span> * The resource object cast to {@link RestServlet}, or <jk>null</jk> if the resource doesn't subclass from<a name="line.1151"></a> -<span class="sourceLineNo">1152</span> * {@link RestServlet}<a name="line.1152"></a> -<span class="sourceLineNo">1153</span> */<a name="line.1153"></a> -<span class="sourceLineNo">1154</span> public RestServlet getRestServlet() {<a name="line.1154"></a> -<span class="sourceLineNo">1155</span> return resource instanceof RestServlet ? (RestServlet)resource : null;<a name="line.1155"></a> -<span class="sourceLineNo">1156</span> }<a name="line.1156"></a> -<span class="sourceLineNo">1157</span><a name="line.1157"></a> -<span class="sourceLineNo">1158</span> /**<a name="line.1158"></a> -<span class="sourceLineNo">1159</span> * Throws a {@link RestException} if an exception occurred in the constructor of this object.<a name="line.1159"></a> -<span class="sourceLineNo">1160</span> *<a name="line.1160"></a> -<span class="sourceLineNo">1161</span> * @throws RestException The initialization exception wrapped in a {@link RestException}.<a name="line.1161"></a> -<span class="sourceLineNo">1162</span> */<a name="line.1162"></a> -<span class="sourceLineNo">1163</span> protected void checkForInitException() throws RestException {<a name="line.1163"></a> -<span class="sourceLineNo">1164</span> if (initException != null)<a name="line.1164"></a> -<span class="sourceLineNo">1165</span> throw initException;<a name="line.1165"></a> -<span class="sourceLineNo">1166</span> }<a name="line.1166"></a> -<span class="sourceLineNo">1167</span><a name="line.1167"></a> -<span class="sourceLineNo">1168</span> /**<a name="line.1168"></a> -<span class="sourceLineNo">1169</span> * Returns the parent resource context (if this resource was initialized from a parent).<a name="line.1169"></a> -<span class="sourceLineNo">1170</span> *<a name="line.1170"></a> -<span class="sourceLineNo">1171</span> * <p><a name="line.1171"></a> -<span class="sourceLineNo">1172</span> * From this object, you can get access to the parent resource class itself using {@link #getResource()} or<a name="line.1172"></a> -<span class="sourceLineNo">1173</span> * {@link #getRestServlet()}<a name="line.1173"></a> -<span class="sourceLineNo">1174</span> *<a name="line.1174"></a> -<span class="sourceLineNo">1175</span> * @return The parent resource context, or <jk>null</jk> if there is no parent context.<a name="line.1175"></a> -<span class="sourceLineNo">1176</span> */<a name="line.1176"></a> -<span class="sourceLineNo">1177</span> public RestContext getParentContext() {<a name="line.1177"></a> -<span class="sourceLineNo">1178</span> return parentContext;<a name="line.1178"></a> -<span class="sourceLineNo">1179</span> }<a name="line.1179"></a> -<span class="sourceLineNo">1180</span><a name="line.1180"></a> -<span class="sourceLineNo">1181</span> /**<a name="line.1181"></a> -<span class="sourceLineNo">1182</span> * Returns the {@link BeanContext} object used for parsing path variables and header values.<a name="line.1182"></a> -<span class="sourceLineNo">1183</span> *<a name="line.1183"></a> -<span class="sourceLineNo">1184</span> * @return The bean context used for parsing path variables and header values.<a name="line.1184"></a> -<span class="sourceLineNo">1185</span> */<a name="line.1185"></a> -<span class="sourceLineNo">1186</span> public BeanContext getBeanContext() {<a name="line.1186"></a> -<span class="sourceLineNo">1187</span> return beanContext;<a name="line.1187"></a> -<span class="sourceLineNo">1188</span> }<a name="line.1188"></a> -<span class="sourceLineNo">1189</span><a name="line.1189"></a> -<span class="sourceLineNo">1190</span> /**<a name="line.1190"></a> -<span class="sourceLineNo">1191</span> * Returns the class-level properties associated with this servlet.<a name="line.1191"></a> -<span class="sourceLineNo">1192</span> *<a name="line.1192"></a> -<span class="sourceLineNo">1193</span> * <p><a name="line.1193"></a> -<span class="sourceLineNo">1194</span> * Properties at the class level are defined via one of the following:<a name="line.1194"></a> -<span class="sourceLineNo">1195</span> * <ul><a name="line.1195"></a> -<span class="sourceLineNo">1196</span> * <li>{@link RestResource#properties() @RestResource.properties()} annotation.<a name="line.1196"></a> -<span class="sourceLineNo">1197</span> * <li>{@link RestConfig#setProperty(String, Object)}/{@link RestConfig#setProperties(Map)} methods.<a name="line.1197"></a> -<span class="sourceLineNo">1198</span> * </ul><a name="line.1198"></a> -<span class="sourceLineNo">1199</span> *<a name="line.1199"></a> -<span class="sourceLineNo">1200</span> * <h5 class='section'>Notes:</h5><a name="line.1200"></a> -<span class="sourceLineNo">1201</span> * <ul><a name="line.1201"></a> -<span class="sourceLineNo">1202</span> * <li>The returned {@code Map} is mutable. Therefore, subclasses are free to override<a name="line.1202"></a> -<span class="sourceLineNo">1203</span> * or set additional initialization parameters in their {@code init()} method.<a name="line.1203"></a> -<span class="sourceLineNo">1204</span> * </ul><a name="line.1204"></a> -<span class="sourceLineNo">1205</span> *<a name="line.1205"></a> -<span class="sourceLineNo">1206</span> * @return The resource properties as an {@link ObjectMap}.<a name="line.1206"></a> -<span class="sourceLineNo">1207</span> */<a name="line.1207"></a> -<span class="sourceLineNo">1208</span> public ObjectMap getProperties() {<a name="line.1208"></a> -<span class="sourceLineNo">1209</span> return properties;<a name="line.1209"></a> -<span class="sourceLineNo">1210</span> }<a name="line.1210"></a> -<span class="sourceLineNo">1211</span><a name="line.1211"></a> -<span class="sourceLineNo">1212</span> /**<a name="line.1212"></a> -<span class="sourceLineNo">1213</span> * Returns the serializers registered with this resource.<a name="line.1213"></a> -<span class="sourceLineNo">1214</span> *<a name="line.1214"></a> -<span class="sourceLineNo">1215</span> * <p><a name="line.1215"></a> -<span class="sourceLineNo">1216</span> * Serializers at the class level are defined via one of the following:<a name="line.1216"></a> -<span class="sourceLineNo">1217</span> * <ul><a name="line.1217"></a> -<span class="sourceLineNo">1218</span> * <li>{@link RestResource#serializers() @RestResource.serializers()} annotation.<a name="line.1218"></a> -<span class="sourceLineNo">1219</span> * <li>{@link RestConfig#addSerializers(Class...)}/{@link RestConfig#addSerializers(Serializer...)} methods.<a name="line.1219"></a> -<span class="sourceLineNo">1220</span> * </ul><a name="line.1220"></a> -<span class="sourceLineNo">1221</span> *<a name="line.1221"></a> -<span class="sourceLineNo">1222</span> * @return The serializers registered with this resource.<a name="line.1222"></a> -<span class="sourceLineNo">1223</span> */<a name="line.1223"></a> -<span class="sourceLineNo">1224</span> public SerializerGroup getSerializers() {<a name="line.1224"></a> -<span class="sourceLineNo">1225</span> return serializers;<a name="line.1225"></a> -<span class="sourceLineNo">1226</span> }<a name="line.1226"></a> -<span class="sourceLineNo">1227</span><a name="line.1227"></a> -<span class="sourceLineNo">1228</span> /**<a name="line.1228"></a> -<span class="sourceLineNo">1229</span> * Returns the parsers registered with this resource.<a name="line.1229"></a> -<span class="sourceLineNo">1230</span> *<a name="line.1230"></a> -<span class="sourceLineNo">1231</span> * <p><a name="line.1231"></a> -<span class="sourceLineNo">1232</span> * Parsers at the class level are defined via one of the following:<a name="line.1232"></a> -<span class="sourceLineNo">1233</span> * <ul><a name="line.1233"></a> -<span class="sourceLineNo">1234</span> * <li>{@link RestResource#parsers() @RestResource.parsers()} annotation.<a name="line.1234"></a> -<span class="sourceLineNo">1235</span> * <li>{@link RestConfig#addParsers(Class...)}/{@link RestConfig#addParsers(Parser...)} methods.<a name="line.1235"></a> -<span class="sourceLineNo">1236</span> * </ul><a name="line.1236"></a> -<span class="sourceLineNo">1237</span> *<a name="line.1237"></a> -<span class="sourceLineNo">1238</span> * @return The parsers registered with this resource.<a name="line.1238"></a> -<span class="sourceLineNo">1239</span> */<a name="line.1239"></a> -<span class="sourceLineNo">1240</span> public ParserGroup getParsers() {<a name="line.1240"></a> -<span class="sourceLineNo">1241</span> return parsers;<a name="line.1241"></a> -<span class="sourceLineNo">1242</span> }<a name="line.1242"></a> -<span class="sourceLineNo">1243</span><a name="line.1243"></a> -<span class="sourceLineNo">1244</span> /**<a name="line.1244"></a> -<span class="sourceLineNo">1245</span> * Returns the servlet init parameter returned by {@link ServletConfig#getInitParameter(String)}.<a name="line.1245"></a> -<span class="sourceLineNo">1246</span> *<a name="line.1246"></a> -<span class="sourceLineNo">1247</span> * @param name The init parameter name.<a name="line.1247"></a> -<span class="sourceLineNo">1248</span> * @return The servlet init parameter, or <jk>null</jk> if not found.<a name="line.1248"></a> -<span class="sourceLineNo">1249</span> */<a name="line.1249"></a> -<span class="sourceLineNo">1250</span> public String getServletInitParameter(String name) {<a name="line.1250"></a> -<span class="sourceLineNo">1251</span> return config.getInitParameter(name);<a name="line.1251"></a> -<span class="sourceLineNo">1252</span> }<a name="line.1252"></a> -<span class="sourceLineNo">1253</span><a name="line.1253"></a> -<span class="sourceLineNo">1254</span> /**<a name="line.1254"></a> -<span class="sourceLineNo">1255</span> * Returns the child resources associated with this servlet.<a name="line.1255"></a> -<span class="sourceLineNo">1256</span> *<a name="line.1256"></a> -<span class="sourceLineNo">1257</span> * @return<a name="line.1257"></a> -<span class="sourceLineNo">1258</span> * An unmodifiable map of child resources.<a name="line.1258"></a> -<span class="sourceLineNo">1259</span> * Keys are the {@link RestResource#path() @RestResource.path()} annotation defined on the child resource.<a name="line.1259"></a> -<span class="sourceLineNo">1260</span> */<a name="line.1260"></a> -<span class="sourceLineNo">1261</span> public Map<String,RestContext> getChildResources() {<a name="line.1261"></a> -<span class="sourceLineNo">1262</span> return Collections.unmodifiableMap(childResources);<a name="line.1262"></a> -<span class="sourceLineNo">1263</span> }<a name="line.1263"></a> -<span class="sourceLineNo">1264</span><a name="line.1264"></a> -<span class="sourceLineNo">1265</span> /**<a name="line.1265"></a> -<span class="sourceLineNo">1266</span> * Returns the number of times this exception was thrown based on a hash of its stacktrace.<a name="line.1266"></a> -<span class="sourceLineNo">1267</span> *<a name="line.1267"></a> -<span class="sourceLineNo">1268</span> * @param e The exception to check.<a name="line.1268"></a> -<span class="sourceLineNo">1269</span> * @return<a name="line.1269"></a> -<span class="sourceLineNo">1270</span> * The number of times this exception was thrown, or <code>0</code> if <code>stackTraceHashes</code><a name="line.1270"></a> -<span class="sourceLineNo">1271</span> * setting is not enabled.<a name="line.1271"></a> -<span class="sourceLineNo">1272</span> */<a name="line.1272"></a> -<span class="sourceLineNo">1273</span> protected int getStackTraceOccurrence(Throwable e) {<a name="line.1273"></a> -<span class="sourceLineNo">1274</span> if (! useStackTraceHashes)<a name="line.1274"></a> -<span class="sourceLineNo">1275</span> return 0;<a name="line.1275"></a> -<span class="sourceLineNo">1276</span> int h = e.hashCode();<a name="line.1276"></a> -<span class="sourceLineNo">1277</span> stackTraceHashes.putIfAbsent(h, new AtomicInteger());<a name="line.1277"></a> -<span class="sourceLineNo">1278</span> return stackTraceHashes.get(h).incrementAndGet();<a name="line.1278"></a> -<span class="sourceLineNo">1279</span> }<a name="line.1279"></a> -<span class="sourceLineNo">1280</span><a name="line.1280"></a> -<span class="sourceLineNo">1281</span> /**<a name="line.1281"></a> -<span class="sourceLineNo">1282</span> * Returns the value of the {@link #REST_renderResponseStackTraces} setting.<a name="line.1282"></a> -<span class="sourceLineNo">1283</span> *<a name="line.1283"></a> -<span class="sourceLineNo">1284</span> * @return The value of the {@link #REST_renderResponseStackTraces} setting.<a name="line.1284"></a> -<span class="sourceLineNo">1285</span> */<a name="line.1285"></a> -<span class="sourceLineNo">1286</span> protected boolean isRenderResponseStackTraces() {<a name="line.1286"></a> -<span class="sourceLineNo">1287</span> return renderResponseStackTraces;<a name="line.1287"></a> -<span class="sourceLineNo">1288</span> }<a name="line.1288"></a> -<span class="sourceLineNo">1289</span><a name="line.1289"></a> -<span class="sourceLineNo">1290</span> /**<a name="line.1290"></a> -<span class="sourceLineNo">1291</span> * Returns the value of the {@link #REST_allowHeaderParams} setting.<a name="line.1291"></a> -<span class="sourceLineNo">1292</span> *<a name="line.1292"></a> -<span class="sourceLineNo">1293</span> * @return The value of the {@link #REST_allowHeaderParams} setting.<a name="line.1293"></a> -<span class="sourceLineNo">1294</span> */<a name="line.1294"></a> -<span class="sourceLineNo">1295</span> protected boolean isAllowHeaderParams() {<a name="line.1295"></a> -<span class="sourceLineNo">1296</span> return allowHeaderParams;<a name="line.1296"></a> -<span class="sourceLineNo">1297</span> }<a name="line.1297"></a> -<span class="sourceLineNo">1298</span><a name="line.1298"></a> -<span class="sourceLineNo">1299</span> /**<a name="line.1299"></a> -<span class="sourceLineNo">1300</span> * Returns the value of the {@link #REST_allowBodyParam} setting.<a name="line.1300"></a> -<span class="sourceLineNo">1301</span> *<a name="line.1301"></a> -<span class="sourceLineNo">1302</span> * @return The value of the {@link #REST_allowBodyParam} setting.<a name="line.1302"></a> -<span class="sourceLineNo">1303</span> */<a name="line.1303"></a> -<span class="sourceLineNo">1304</span> protected boolean isAllowBodyParam() {<a name="line.1304"></a> -<span class="sourceLineNo">1305</span> return allowBodyParam;<a name="line.1305"></a> -<span class="sourceLineNo">1306</span> }<a name="line.1306"></a> -<span class="sourceLineNo">1307</span><a name="line.1307"></a> -<span class="sourceLineNo">1308</span> /**<a name="line.1308"></a> -<span class="sourceLineNo">1309</span> * Returns the value of the {@link #REST_defaultCharset} setting.<a name="line.1309"></a> -<span class="sourceLineNo">1310</span> *<a name="line.1310"></a> -<span class="sourceLineNo">1311</span> * @return The value of the {@link #REST_defaultCharset} setting.<a name="line.1311"></a> -<span class="sourceLineNo">1312</span> */<a name="line.1312"></a> -<span class="sourceLineNo">1313</span> protected String getDefaultCharset() {<a name="line.1313"></a> -<span class="sourceLineNo">1314</span> return defaultCharset;<a name="line.1314"></a> -<span class="sourceLineNo">1315</span> }<a name="line.1315"></a> -<span class="sourceLineNo">1316</span><a name="line.1316"></a> -<span class="sourceLineNo">1317</span> /**<a name="line.1317"></a> -<span class="sourceLineNo">1318</span> * Returns the value of the {@link #REST_paramFormat} setting.<a name="line.1318"></a> -<span class="sourceLineNo">1319</span> *<a name="line.1319"></a> -<span class="sourceLineNo">1320</span> * @return The value of the {@link #REST_paramFormat} setting.<a name="line.1320"></a> -<span class="sourceLineNo">1321</span> */<a name="line.1321"></a> -<span class="sourceLineNo">1322</span> protected String getParamFormat() {<a name="line.1322"></a> -<span class="sourceLineNo">1323</span> return paramFormat;<a name="line.1323"></a> -<span class="sourceLineNo">1324</span> }<a name="line.1324"></a> -<span class="sourceLineNo">1325</span><a name="line.1325"></a> -<span class="sourceLineNo">1326</span> /**<a name="line.1326"></a> -<span class="sourceLineNo">1327</span> * Returns the name of the client version header name used by this resource.<a name="line.1327"></a> -<span class="sourceLineNo">1328</span> *<a name="line.1328"></a> -<span class="sourceLineNo">1329</span> * <p><a name="line.1329"></a> -<span class="sourceLineNo">1330</span> * The client version header is the name of the HTTP header on requests that identify a client version.<a name="line.1330"></a> -<span class="sourceLineNo">1331</span> *<a name="line.1331"></a> -<span class="sourceLineNo">1332</span> * <p><a name="line.1332"></a> -<span class="sourceLineNo">1333</span> * The client version header is defined via one of the following:<a name="line.1333"></a> -<span class="sourceLineNo">1334</span> * <ul><a name="line.1334"></a> -<span class="sourceLineNo">1335</span> * <li>{@link RestResource#clientVersionHeader() @RestResource.clientVersion()} annotation.<a name="line.1335"></a> -<span class="sourceLineNo">1336</span> * </ul><a name="line.1336"></a> -<span class="sourceLineNo">1337</span> *<a name="line.1337"></a> -<span class="sourceLineNo">1338</span> * @return The name of the client version header used by this resource. Never <jk>null</jk>.<a name="line.1338"></a> -<span class="sourceLineNo">1339</span> */<a name="line.1339"></a> -<span class="sourceLineNo">1340</span> protected String getClientVersionHeader() {<a name="line.1340"></a> -<span class="sourceLineNo">1341</span> return clientVersionHeader;<a name="line.1341"></a> -<span class="sourceLineNo">1342</span> }<a name="line.1342"></a> -<span class="sourceLineNo">1343</span><a name="line.1343"></a> -<span class="sourceLineNo">1344</span> /**<a name="line.1344"></a> -<span class="sourceLineNo">1345</span> * Returns <jk>true</jk> if the specified <code>Method</code> GET parameter value can be used to override<a name="line.1345"></a> -<span class="sourceLineNo">1346</span> * the method name in the HTTP header.<a name="line.1346"></a> -<span class="sourceLineNo">1347</span> *<a name="line.1347"></a> -<span class="sourceLineNo">1348</span> * @param m The method name, upper-cased.<a name="line.1348"></a> -<span class="sourceLineNo">1349</span> * @return <jk>true</jk> if this resource allows the specified method to be overridden.<a name="line.1349"></a> -<span class="sourceLineNo">1350</span> */<a name="line.1350"></a> -<span class="sourceLineNo">1351</span> protected boolean allowMethodParam(String m) {<a name="line.1351"></a> -<span class="sourceLineNo">1352</span> return (! isEmpty(m) && (allowMethodParams.contains(m) || allowMethodParams.contains("*")));<a name="line.1352"></a> -<span class="sourceLineNo">1353</span> }<a name="line.1353"></a> -<span class="sourceLineNo">1354</span><a name="line.1354"></a> -<span class="sourceLineNo">1355</span> /**<a name="line.1355"></a> -<span class="sourceLineNo">1356</span> * Returns the bean filters associated with this resource.<a name="line.1356"></a> -<span class="sourceLineNo">1357</span> *<a name="line.1357"></a> -<span class="sourceLineNo">1358</span> * <p><a name="line.1358"></a> -<span class="sourceLineNo">1359</span> * Bean filters at the class level are defined via one of the following:<a name="line.1359"></a> -<span class="sourceLineNo">1360</span> * <ul><a name="line.1360"></a> -<span class="sourceLineNo">1361</span> * <li>{@link RestResource#beanFilters() @RestResource.beanFilters()} annotation.<a name="line.1361"></a> -<span class="sourceLineNo">1362</span> * <li>{@link RestConfig#addBeanFilters(Class...)} method.<a name="line.1362"></a> -<span class="sourceLineNo">1363</span> * </ul><a name="line.1363"></a> -<span class="sourceLineNo">1364</span> *<a name="line.1364"></a> -<span class="sourceLineNo">1365</span> * @return The bean filters associated with this resource. Never <jk>null</jk>.<a name="line.1365"></a> -<span class="sourceLineNo">1366</span> */<a name="line.1366"></a> -<span class="sourceLineNo">1367</span> protected Class<?>[] getBeanFilters() {<a name="line.1367"></a> -<span class="sourceLineNo">1368</span> return beanFilters;<a name="line.1368"></a> -<span class="sourceLineNo">1369</span> }<a name="line.1369"></a> -<span class="sourceLineNo">1370</span><a name="line.1370"></a> -<span class="sourceLineNo">1371</span> /**<a name="line.1371"></a> -<span class="sourceLineNo">1372</span> * Returns the POJO swaps associated with this resource.<a name="line.1372"></a> -<span class="sourceLineNo">1373</span> *<a name="line.1373"></a> -<span class="sourceLineNo">1374</span> * <p><a name="line.1374"></a> -<span class="sourceLineNo">1375</span> * POJO swaps at the class level are defined via one of the following:<a name="line.1375"></a> -<span class="sourceLineNo">1376</span> * <ul><a name="line.1376"></a> -<span class="sourceLineNo">1377</span> * <li>{@link RestResource#pojoSwaps() @RestResource.pojoSwaps()} annotation.<a name="line.1377"></a> -<span class="sourceLineNo">1378</span> * <li>{@link RestConfig#addPojoSwaps(Class...)} method.<a name="line.1378"></a> -<span class="sourceLineNo">1379</span> * </ul><a name="line.1379"></a> -<span class="sourceLineNo">1380</span> *<a name="line.1380"></a> -<span class="sourceLineNo">1381</span> * @return The POJO swaps associated with this resource. Never <jk>null</jk>.<a name="line.1381"></a> -<span class="sourceLineNo">1382</span> */<a name="line.1382"></a> -<span class="sourceLineNo">1383</span> protected Class<?>[] getPojoSwaps() {<a name="line.1383"></a> -<span class="sourceLineNo">1384</span> return pojoSwaps;<a name="line.1384"></a> -<span class="sourceLineNo">1385</span> }<a name="line.1385"></a> -<span class="sourceLineNo">1386</span><a name="line.1386"></a> -<span class="sourceLineNo">1387</span> /**<a name="line.1387"></a> -<span class="sourceLineNo">1388</span> * Finds the {@link RestParam} instances to handle resolving objects on the calls to the specified Java method.<a name="line.1388"></a> -<span class="sourceLineNo">1389</span> *<a name="line.1389"></a> -<span class="sourceLineNo">1390</span> * @param method The Java method being called.<a name="line.1390"></a> -<span class="sourceLineNo">1391</span> * @param methodPlainParams Whether plain-params setting is specified.<a name="line.1391"></a> -<span class="sourceLineNo">1392</span> * @param pathPattern The parsed URL path pattern.<a name="line.1392"></a> -<span class="sourceLineNo">1393</span> * @return The array of resolvers.<a name="line.1393"></a> -<span class="sourceLineNo">1394</span> * @throws ServletException If an annotation usage error was detected.<a name="line.1394"></a> -<span class="sourceLineNo">1395</span> */<a name="line.1395"></a> -<span class="sourceLineNo">1396</span> protected RestParam[] findParams(Method method, boolean methodPlainParams, UrlPathPattern pathPattern) throws ServletException {<a name="line.1396"></a> -<span class="sourceLineNo">1397</span><a name="line.1397"></a> -<span class="sourceLineNo">1398</span> Type[] pt = method.getGenericParameterTypes();<a name="line.1398"></a> -<span class="sourceLineNo">1399</span> Annotation[][] pa = method.getParameterAnnotations();<a name="line.1399"></a> -<span class="sourceLineNo">1400</span> RestParam[] rp = new RestParam[pt.length];<a name="line.1400"></a> -<span class="sourceLineNo">1401</span> int attrIndex = 0;<a name="line.1401"></a> +<span class="sourceLineNo">760</span> * <p><a name="line.760"></a> +<span class="sourceLineNo">761</span> * The list of variables can be extended using the {@link RestConfig#addVars(Class...)} method.<a name="line.761"></a> +<span class="sourceLineNo">762</span> * For example, this is used to add support for the Args and Manifest-File variables in the microservice<a name="line.762"></a> +<span class="sourceLineNo">763</span> * <code>Resource</code> class.<a name="line.763"></a> +<span class="sourceLineNo">764</span> *<a name="line.764"></a> +<span class="sourceLineNo">765</span> * @return The var resolver in use by this resource.<a name="line.765"></a> +<span class="sourceLineNo">766</span> */<a name="line.766"></a> +<span class="sourceLineNo">767</span> public VarResolver getVarResolver() {<a name="line.767"></a> +<span class="sourceLineNo">768</span> return varResolver;<a name="line.768"></a> +<span class="sourceLineNo">769</span> }<a name="line.769"></a> +<span class="sourceLineNo">770</span><a name="line.770"></a> +<span class="sourceLineNo">771</span> /**<a name="line.771"></a> +<span class="sourceLineNo">772</span> * Returns the config file associated with this servlet.<a name="line.772"></a> +<span class="sourceLineNo">773</span> *<a name="line.773"></a> +<span class="sourceLineNo">774</span> * <p><a name="line.774"></a> +<span class="sourceLineNo">775</span> * The config file is identified via one of the following:<a name="line.775"></a> +<span class="sourceLineNo">776</span> * <ul><a name="line.776"></a> +<span class="sourceLineNo">777</span> * <li>{@link RestResource#config() @RestResource.config()} annotation.<a name="line.777"></a> +<span class="sourceLineNo">778</span> * <li>{@link RestConfig#setConfigFile(ConfigFile)} method.<a name="line.778"></a> +<span class="sourceLineNo">779</span> * </ul><a name="line.779"></a> +<span class="sourceLineNo">780</span> *<a name="line.780"></a> +<span class="sourceLineNo">781</span> * @return The resolving config file associated with this servlet. Never <jk>null</jk>.<a name="line.781"></a> +<span class="sourceLineNo">782</span> */<a name="line.782"></a> +<span class="sourceLineNo">783</span> public ConfigFile getConfigFile() {<a name="line.783"></a> +<span class="sourceLineNo">784</span> return configFile;<a name="line.784"></a> +<span class="sourceLineNo">785</span> }<a name="line.785"></a> +<span class="sourceLineNo">786</span><a name="line.786"></a> +<span class="sourceLineNo">787</span> /**<a name="line.787"></a> +<span class="sourceLineNo">788</span> * Resolve a static resource file.<a name="line.788"></a> +<span class="sourceLineNo">789</span> *<a name="line.789"></a> +<span class="sourceLineNo">790</span> * <p><a name="line.790"></a> +<span class="sourceLineNo">791</span> * The location of static resources are defined via one of the following:<a name="line.791"></a> +<span class="sourceLineNo">792</span> * <ul><a name="line.792"></a> +<span class="sourceLineNo">793</span> * <li>{@link RestResource#staticFiles() @RestResource.staticFiles()} annotation.<a name="line.793"></a> +<span class="sourceLineNo">794</span> * <li>{@link RestConfig#addStaticFiles(Class, String)} method.<a name="line.794"></a> +<span class="sourceLineNo">795</span> * </ul><a name="line.795"></a> +<span class="sourceLineNo">796</span> *<a name="line.796"></a> +<span class="sourceLineNo">797</span> * @param pathInfo The unencoded path info.<a name="line.797"></a> +<span class="sourceLineNo">798</span> * @return The resource, or <jk>null</jk> if the resource could not be resolved.<a name="line.798"></a> +<span class="sourceLineNo">799</span> * @throws IOException<a name="line.799"></a> +<span class="sourceLineNo">800</span> */<a name="line.800"></a> +<span class="sourceLineNo">801</span> public StreamResource resolveStaticFile(String pathInfo) throws IOException {<a name="line.801"></a> +<span class="sourceLineNo">802</span> if (! staticFilesCache.containsKey(pathInfo)) {<a name="line.802"></a> +<span class="sourceLineNo">803</span> String p = urlDecode(trimSlashes(pathInfo));<a name="line.803"></a> +<span class="sourceLineNo">804</span> if (p.indexOf("..") != -1)<a name="line.804"></a> +<span class="sourceLineNo">805</span> throw new RestException(SC_NOT_FOUND, "Invalid path");<a name="line.805"></a> +<span class="sourceLineNo">806</span> for (Map.Entry<String,String> e : staticFilesMap.entrySet()) {<a name="line.806"></a> +<span class="sourceLineNo">807</span> String key = trimSlashes(e.getKey());<a name="line.807"></a> +<span class="sourceLineNo">808</span> if (p.startsWith(key)) {<a name="line.808"></a> +<span class="sourceLineNo">809</span> String remainder = (p.equals(key) ? "" : p.substring(key.length()));<a name="line.809"></a> +<span class="sourceLineNo">810</span> if (remainder.isEmpty() || remainder.startsWith("/")) {<a name="line.810"></a> +<span class="sourceLineNo">811</span> String p2 = trimSlashes(e.getValue()) + remainder;<a name="line.811"></a> +<span class="sourceLineNo">812</span> InputStream is = getResource(p2, null);<a name="line.812"></a> +<span class="sourceLineNo">813</span> if (is != null) {<a name="line.813"></a> +<span class="sourceLineNo">814</span> try {<a name="line.814"></a> +<span class="sourceLineNo">815</span> int i = p2.lastIndexOf('/');<a name="line.815"></a> +<span class="sourceLineNo">816</span> String name = (i == -1 ? p2 : p2.substring(i+1));<a name="line.816"></a> +<span class="sourceLineNo">817</span> String mediaType = mimetypesFileTypeMap.getContentType(name);<a name="line.817"></a> +<span class="sourceLineNo">818</span> ObjectMap headers = new ObjectMap().append("Cache-Control", "max-age=86400, public");<a name="line.818"></a> +<span class="sourceLineNo">819</span> staticFilesCache.put(pathInfo, new StreamResource(MediaType.forString(mediaType), headers, is));<a name="line.819"></a> +<span class="sourceLineNo">820</span> return staticFilesCache.get(pathInfo);<a name="line.820"></a> +<span class="sourceLineNo">821</span> } finally {<a name="line.821"></a> +<span class="sourceLineNo">822</span> is.close();<a name="line.822"></a> +<span class="sourceLineNo">823</span> }<a name="line.823"></a> +<span class="sourceLineNo">824</span> }<a name="line.824"></a> +<span class="sourceLineNo">825</span> }<a name="line.825"></a> +<span class="sourceLineNo">826</span> }<a name="line.826"></a> +<span class="sourceLineNo">827</span> }<a name="line.827"></a> +<span class="sourceLineNo">828</span> }<a name="line.828"></a> +<span class="sourceLineNo">829</span> return staticFilesCache.get(pathInfo);<a name="line.829"></a> +<span class="sourceLineNo">830</span> }<a name="line.830"></a> +<span class="sourceLineNo">831</span><a name="line.831"></a> +<span class="sourceLineNo">832</span> /**<a name="line.832"></a> +<span class="sourceLineNo">833</span> * Same as {@link Class#getResourceAsStream(String)} except if it doesn't find the resource on this class, searches<a name="line.833"></a> +<span class="sourceLineNo">834</span> * up the parent hierarchy chain.<a name="line.834"></a> +<span class="sourceLineNo">835</span> *<a name="line.835"></a> +<span class="sourceLineNo">836</span> * <p><a name="line.836"></a> +<span class="sourceLineNo">837</span> * If the resource cannot be found in the classpath, then an attempt is made to look in the JVM working directory.<a name="line.837"></a> +<span class="sourceLineNo">838</span> *<a name="line.838"></a> +<span class="sourceLineNo">839</span> * <p><a name="line.839"></a> +<span class="sourceLineNo">840</span> * If the <code>locale</code> is specified, then we look for resources whose name matches that locale.<a name="line.840"></a> +<span class="sourceLineNo">841</span> * For example, if looking for the resource <js>"MyResource.txt"</js> for the Japanese locale, we will look for<a name="line.841"></a> +<span class="sourceLineNo">842</span> * files in the following order:<a name="line.842"></a> +<span class="sourceLineNo">843</span> * <ol><a name="line.843"></a> +<span class="sourceLineNo">844</span> * <li><js>"MyResource_ja_JP.txt"</js><a name="line.844"></a> +<span class="sourceLineNo">845</span> * <li><js>"MyResource_ja.txt"</js><a name="line.845"></a> +<span class="sourceLineNo">846</span> * <li><js>"MyResource.txt"</js><a name="line.846"></a> +<span class="sourceLineNo">847</span> * </ol><a name="line.847"></a> +<span class="sourceLineNo">848</span> *<a name="line.848"></a> +<span class="sourceLineNo">849</span> * @param name The resource name.<a name="line.849"></a> +<span class="sourceLineNo">850</span> * @param locale Optional locale.<a name="line.850"></a> +<span class="sourceLineNo">851</span> * @return An input stream of the resource, or <jk>null</jk> if the resource could not be found.<a name="line.851"></a> +<span class="sourceLineNo">852</span> * @throws IOException<a name="line.852"></a> +<span class="sourceLineNo">853</span> */<a name="line.853"></a> +<span class="sourceLineNo">854</span> protected InputStream getResource(String name, Locale locale) throws IOException {<a name="line.854"></a> +<span class="sourceLineNo">855</span> return resourceFinder.getResourceAsStream(name, locale);<a name="line.855"></a> +<span class="sourceLineNo">856</span> }<a name="line.856"></a> +<span class="sourceLineNo">857</span><a name="line.857"></a> +<span class="sourceLineNo">858</span> /**<a name="line.858"></a> +<span class="sourceLineNo">859</span> * Reads the input stream from {@link #getResource(String, Locale)} into a String.<a name="line.859"></a> +<span class="sourceLineNo">860</span> *<a name="line.860"></a> +<span class="sourceLineNo">861</span> * @param name The resource name.<a name="line.861"></a> +<span class="sourceLineNo">862</span> * @param locale Optional locale.<a name="line.862"></a> +<span class="sourceLineNo">863</span> * @return The contents of the stream as a string, or <jk>null</jk> if the resource could not be found.<a name="line.863"></a> +<span class="sourceLineNo">864</span> * @throws IOException If resource could not be found.<a name="line.864"></a> +<span class="sourceLineNo">865</span> */<a name="line.865"></a> +<span class="sourceLineNo">866</span> public String getResourceAsString(String name, Locale locale) throws IOException {<a name="line.866"></a> +<span class="sourceLineNo">867</span> return resourceFinder.getResourceAsString(name, locale);<a name="line.867"></a> +<span class="sourceLineNo">868</span> }<a name="line.868"></a> +<span class="sourceLineNo">869</span><a name="line.869"></a> +<span class="sourceLineNo">870</span> /**<a name="line.870"></a> +<span class="sourceLineNo">871</span> * Reads the input stream from {@link #getResource(String, Locale)} and parses it into a POJO using the parser<a name="line.871"></a> +<span class="sourceLineNo">872</span> * matched by the specified media type.<a name="line.872"></a> +<span class="sourceLineNo">873</span> *<a name="line.873"></a> +<span class="sourceLineNo">874</span> * <p><a name="line.874"></a> +<span class="sourceLineNo">875</span> * Useful if you want to load predefined POJOs from JSON files in your classpath.<a name="line.875"></a> +<span class="sourceLineNo">876</span> *<a name="line.876"></a> +<span class="sourceLineNo">877</span> * @param c The class type of the POJO to create.<a name="line.877"></a> +<span class="sourceLineNo">878</span> * @param mediaType The media type of the data in the stream (e.g. <js>"text/json"</js>)<a name="line.878"></a> +<span class="sourceLineNo">879</span> * @param name The resource name (e.g. "htdocs/styles.css").<a name="line.879"></a> +<span class="sourceLineNo">880</span> * @param locale Optional locale.<a name="line.880"></a> +<span class="sourceLineNo">881</span> * @return The parsed resource, or <jk>null</jk> if the resource could not be found.<a name="line.881"></a> +<span class="sourceLineNo">882</span> * @throws IOException<a name="line.882"></a> +<span class="sourceLineNo">883</span> * @throws ServletException If the media type was unknown or the input could not be parsed into a POJO.<a name="line.883"></a> +<span class="sourceLineNo">884</span> */<a name="line.884"></a> +<span class="sourceLineNo">885</span> public <T> T getResource(Class<T> c, MediaType mediaType, String name, Locale locale) throws IOException, ServletException {<a name="line.885"></a> +<span class="sourceLineNo">886</span> InputStream is = getResource(name, locale);<a name="line.886"></a> +<span class="sourceLineNo">887</span> if (is == null)<a name="line.887"></a> +<span class="sourceLineNo">888</span> return null;<a name="line.888"></a> +<span class="sourceLineNo">889</span> try {<a name="line.889"></a> +<span class="sourceLineNo">890</span> Parser p = parsers.getParser(mediaType);<a name="line.890"></a> +<span class="sourceLineNo">891</span> if (p != null) {<a name="line.891"></a> +<span class="sourceLineNo">892</span> try {<a name="line.892"></a> +<span class="sourceLineNo">893</span> if (p.isReaderParser())<a name="line.893"></a> +<span class="sourceLineNo">894</span> return p.parse(new InputStreamReader(is, UTF8), c);<a name="line.894"></a> +<span class="sourceLineNo">895</span> return p.parse(is, c);<a name="line.895"></a> +<span class="sourceLineNo">896</span> } catch (ParseException e) {<a name="line.896"></a> +<span class="sourceLineNo">897</span> throw new ServletException("Could not parse resource '' as media type '"+mediaType+"'.");<a name="line.897"></a> +<span class="sourceLineNo">898</span> }<a name="line.898"></a> +<span class="sourceLineNo">899</span> }<a name="line.899"></a> +<span class="sourceLineNo">900</span> throw new ServletException("Unknown media type '"+mediaType+"'");<a name="line.900"></a> +<span class="sourceLineNo">901</span> } catch (Exception e) {<a name="line.901"></a> +<span class="sourceLineNo">902</span> throw new ServletException("Could not parse resource with name '"+name+"'", e);<a name="line.902"></a> +<span class="sourceLineNo">903</span> }<a name="line.903"></a> +<span class="sourceLineNo">904</span> }<a name="line.904"></a> +<span class="sourceLineNo">905</span><a name="line.905"></a> +<span class="sourceLineNo">906</span> /**<a name="line.906"></a> +<span class="sourceLineNo">907</span> * Returns the path for this resource as defined by the {@link RestResource#path()} annotation or<a name="line.907"></a> +<span class="sourceLineNo">908</span> * {@link RestConfig#setPath(String)} method concatenated with those on all parent classes.<a name="line.908"></a> +<span class="sourceLineNo">909</span> *<a name="line.909"></a> +<span class="sourceLineNo">910</span> * <p><a name="line.910"></a> +<span class="sourceLineNo">911</span> * If path is not specified, returns <js>"/"</js>.<a name="line.911"></a> +<span class="sourceLineNo">912</span> *<a name="line.912"></a> +<span class="sourceLineNo">913</span> * <p><a name="line.913"></a> +<span class="sourceLineNo">914</span> * Path always starts with <js>"/"</js>.<a name="line.914"></a> +<span class="sourceLineNo">915</span> *<a name="line.915"></a> +<span class="sourceLineNo">916</span> * @return The servlet path.<a name="line.916"></a> +<span class="sourceLineNo">917</span> */<a name="line.917"></a> +<span class="sourceLineNo">918</span> public String getPath() {<a name="line.918"></a> +<span class="sourceLineNo">919</span> return fullPath;<a name="line.919"></a> +<span class="sourceLineNo">920</span> }<a name="line.920"></a> +<span class="sourceLineNo">921</span><a name="line.921"></a> +<span class="sourceLineNo">922</span> /**<a name="line.922"></a> +<span class="sourceLineNo">923</span> * The HTML page header contents.<a name="line.923"></a> +<span class="sourceLineNo">924</span> *<a name="line.924"></a> +<span class="sourceLineNo">925</span> * <p><a name="line.925"></a> +<span class="sourceLineNo">926</span> * Defined by the {@link HtmlDoc#header()} annotation or {@link RestConfig#setHtmlHeader(String)} method.<a name="line.926"></a> +<span class="sourceLineNo">927</span> *<a name="line.927"></a> +<span class="sourceLineNo">928</span> * @return The HTML page header contents.<a name="line.928"></a> +<span class="sourceLineNo">929</span> */<a name="line.929"></a> +<span class="sourceLineNo">930</span> public String getHtmlHeader() {<a name="line.930"></a> +<span class="sourceLineNo">931</span> return htmlHeader;<a name="line.931"></a> +<span class="sourceLineNo">932</span> }<a name="line.932"></a> +<span class="sourceLineNo">933</span><a name="line.933"></a> +<span class="sourceLineNo">934</span> /**<a name="line.934"></a> +<span class="sourceLineNo">935</span> * The HTML page nav section links.<a name="line.935"></a> +<span class="sourceLineNo">936</span> *<a name="line.936"></a> +<span class="sourceLineNo">937</span> * <p><a name="line.937"></a> +<span class="sourceLineNo">938</span> * Defined by the {@link HtmlDoc#links()} annotation or {@link RestConfig#setHtmlLinks(String[])} method.<a name="line.938"></a> +<span class="sourceLineNo">939</span> *<a name="line.939"></a> +<span class="sourceLineNo">940</span> * @return The HTML page nav section links.<a name="line.940"></a> +<span class="sourceLineNo">941</span> */<a name="line.941"></a> +<span class="sourceLineNo">942</span> public String[] getHtmlLinks() {<a name="line.942"></a> +<span class="sourceLineNo">943</span> return htmlLinks;<a name="line.943"></a> +<span class="sourceLineNo">944</span> }<a name="line.944"></a> +<span class="sourceLineNo">945</span><a name="line.945"></a> +<span class="sourceLineNo">946</span> /**<a name="line.946"></a> +<span class="sourceLineNo">947</span> * The HTML page nav section contents.<a name="line.947"></a> +<span class="sourceLineNo">948</span> *<a name="line.948"></a> +<span class="sourceLineNo">949</span> * <p><a name="line.949"></a> +<span class="sourceLineNo">950</span> * Defined by the {@link HtmlDoc#nav()} annotation or {@link RestConfig#setHtmlNav(String)} method.<a name="line.950"></a> +<span class="sourceLineNo">951</span> *<a name="line.951"></a> +<span class="sourceLineNo">952</span> * @return The HTML page nav section contents.<a name="line.952"></a> +<span class="sourceLineNo">953</span> */<a name="line.953"></a> +<span class="sourceLineNo">954</span> public String getHtmlNav() {<a name="line.954"></a> +<span class="sourceLineNo">955</span> return htmlNav;<a name="line.955"></a> +<span class="sourceLineNo">956</span> }<a name="line.956"></a> +<span class="sourceLineNo">957</span><a name="line.957"></a> +<span class="sourceLineNo">958</span> /**<a name="line.958"></a> +<span class="sourceLineNo">959</span> * The HTML page aside section contents.<a name="line.959"></a> +<span class="sourceLineNo">960</span> *<a name="line.960"></a> +<span class="sourceLineNo">961</span> * <p><a name="line.961"></a> +<span class="sourceLineNo">962</span> * Defined by the {@link HtmlDoc#aside()} annotation or {@link RestConfig#setHtmlAside(String)} method.<a name="line.962"></a> +<span class="sourceLineNo">963</span> *<a name="line.963"></a> +<span class="sourceLineNo">964</span> * @return The HTML page aside section contents.<a name="line.964"></a> +<span class="sourceLineNo">965</span> */<a name="line.965"></a> +<span class="sourceLineNo">966</span> public String getHtmlAside() {<a name="line.966"></a> +<span class="sourceLineNo">967</span> return htmlAside;<a name="line.967"></a> +<span class="sourceLineNo">968</span> }<a name="line.968"></a> +<span class="sourceLineNo">969</span><a name="line.969"></a> +<span class="sourceLineNo">970</span> /**<a name="line.970"></a> +<span class="sourceLineNo <TRUNCATED>
