org.apache.juneau.rest.vars

Class FileVar

java.lang.Object

org.apache.juneau.svl.Var

org.apache.juneau.svl.SimpleVar

org.apache.juneau.svl.DefaultingVar

org.apache.juneau.rest.vars.FileVar

public class FileVar
extends DefaultingVar

File resource variable resolver

The format for this var is "$F{path[,defaultValue]}".

File variables resolve to the contents of resource files located on the classpath or local JVM directory. They use the RestRequest.getClasspathReaderResource(String) method to retrieve the contents of the file. That in turn uses the ClasspathResourceFinder associated with the servlet class to find the file.

The ClasspathResourceFinder is similar to Class.getResourceAsStream(String) except if it doesn't find the resource on this class, it searches up the parent hierarchy chain.

If the resource cannot be found in the classpath, then an attempt is made to look in the JVM working directory.
Path traversals outside the working directory are not allowed for security reasons.

Localized resources (based on the locale of the HTTP request) are supported. For example, if looking for the resource "MyResource.txt" for the Japanese locale, we will look for files in the following order:

1. "MyResource_ja_JP.txt"
2. "MyResource_ja.txt"
3. "MyResource.txt"

Example:

@RestResource( htmldoc=@HtmlDoc( aside="$F{resources/MyAsideMessage.html, Oops not found!}" ) )

Files of type HTML, XHTML, XML, JSON, Javascript, and CSS will be stripped of comments. This allows you to place license headers in files without them being serialized to the output.

See Also:

• Overview > juneau-svl > SVL Variables

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME The name of this variable.

Constructor Summary

Constructors

Constructor and Description
FileVar() Constructor.

Method Summary

Modifier and Type	Method and Description
String	resolve(VarResolverSession session, String key) The interface that needs to be implemented for subclasses of SimpleVar.

Methods inherited from class org.apache.juneau.svl.DefaultingVar

doResolve

Methods inherited from class org.apache.juneau.svl.SimpleVar

resolveTo

Methods inherited from class org.apache.juneau.svl.Var

allowNested, allowRecurse, getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

The name of this variable.

See Also:

Constant Field Values

Constructor Detail

FileVar

public FileVar()

Constructor.

Method Detail

resolve

public String resolve(VarResolverSession session,
                      String key)
               throws Exception

Description copied from class: Var

The interface that needs to be implemented for subclasses of SimpleVar.

Specified by:

resolve in class Var

Parameters:

session - The session object used for a single instance of a var resolution.

key - The inside argument of the variable.

Returns:

The resolved value.

Throws:

Exception - Any exception can be thrown.