org.apache.juneau.rest.vars

Class RequestVar

java.lang.Object

org.apache.juneau.svl.Var

org.apache.juneau.svl.SimpleVar

org.apache.juneau.svl.MultipartResolvingVar

org.apache.juneau.rest.vars.RequestVar

public class RequestVar
extends MultipartResolvingVar

Request attribute variable resolver.

The format for this var is "$R{key1[,key2...]}".
When multiple keys are used, returns the first non-null/empty value.

The possible values are:

• "contextPath" - Value returned by RestRequest.getContextPath()
• "method" - Value returned by RestRequest.getMethod()
• "methodDescription" - Value returned by RestRequest.getMethodDescription()
• "methodSummary" - Value returned by RestRequest.getMethodSummary()
• "pathInfo" - Value returned by HttpServletRequestWrapper.getPathInfo()
• "requestParentURI" - Value returned by UriContext.getRootRelativePathInfoParent()
• "requestURI" - Value returned by HttpServletRequestWrapper.getRequestURI()
• "resourceDescription" - Value returned by RestRequest.getResourceDescription()
• "resourceTitle" - See RestRequest.getResourceTitle()
• "servletParentURI" - Value returned by UriContext.getRootRelativeServletPathParent()
• "servletPath" - See RestRequest.getServletPath()
• "servletURI" - See UriContext.getRootRelativeServletPath()
• "siteName" - See RestRequest.getSiteName()

Example:

String resourceTitle = restRequest.resolveVars("$R{resourceTitle}"); String resourceTitleOrDescription = restRequest.resolveVars("$R{resourceTitle,resourceDescription}");

Notes:

• This variable resolver requires that a RestRequest object be set as a context object on the resolver or a session object on the resolver session.
• For security reasons, nested and recursive variables are not resolved.

See Also:

• Overview > juneau-rest-server > SVL Variables

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME The name of this variable.
static String	SESSION_req The name of the session or context object that identifies the RestRequest object.

Constructor Summary

Constructors

Constructor and Description
RequestVar() Constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	allowNested() Returns whether nested variables are supported by this variable.
protected boolean	allowRecurse() Returns whether variables in the resolved contents of this variable should also be resolved.
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.MultipartResolvingVar

doResolve

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

resolveTo

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

getName

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_req

public static final String SESSION_req

The name of the session or context object that identifies the RestRequest object.

See Also:

Constant Field Values

NAME

public static final String NAME

The name of this variable.

See Also:

Constant Field Values

Constructor Detail

RequestVar

public RequestVar()

Constructor.

Method Detail

allowNested

protected boolean allowNested()

Description copied from class: Var

Returns whether nested variables are supported by this variable.

For example, in "$X{$Y{xxx}}", $Y is a nested variable that will be resolved if this method returns true.

The default implementation of this method always returns true. Subclasses can override this method to override the default behavior.

Overrides:

allowNested in class Var

Returns:

true if nested variables are supported by this variable.

allowRecurse

protected boolean allowRecurse()

Description copied from class: Var

Returns whether variables in the resolved contents of this variable should also be resolved.

For example, if "$X{xxx}" resolves to "$Y{xxx}", then the $Y variable will be recursively resolved if this method returns true.

The default implementation of this method always returns true.
Subclasses can override this method to override the default behavior.

Important Note

As a general rule, variables that resolve user-entered data should not be recursively resolved as this may cause a security hole.

Overrides:

allowRecurse in class Var

Returns:

true if resolved variables should be recursively resolved.

resolve

public String resolve(VarResolverSession session,
                      String key)

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.