Package org.apache.juneau.rest.vars

Class RequestSwaggerVar

java.lang.Object

org.apache.juneau.svl.Var

org.apache.juneau.svl.SimpleVar

org.apache.juneau.svl.MultipartResolvingVar

org.apache.juneau.rest.vars.RequestSwaggerVar

public class RequestSwaggerVar
extends MultipartResolvingVar

Rest info variable resolver.

The format for this var is "$RS{key1[,key2...]}".

Used to resolve values returned by RestRequest.getSwagger()..
When multiple keys are used, returns the first non-null/empty value.

The possible values are:

• "contact" - Value returned by Info.getContact()
• "description" - Value returned by Info.getDescription()
• "externalDocs" - Value returned by Swagger.getExternalDocs()
• "license" - Value returned by Info.getLicense()
• "operationDescription" - Value returned by Operation.getDescription()
• "operationSummary" - Value returned by Operation.getSummary()
• "siteName" - Value returned by Info.getSiteName()
• "tags" - Value returned by Swagger.getTags()
• "termsOfService" - Value returned by Info.getTermsOfService()
• "title" - See Info.getTitle()
• "version" - See Info.getVersion()

Example:

String title = restRequest.getVarResolver().resolve("$RS{title}"); String titleOrDescription = restRequest.getVarResolver().resolve("$RS{title,description}");

Notes:

• This variable resolver requires that a RestRequest bean be available in the session bean store.
• For security reasons, nested and recursive variables are not resolved.

See Also:

• SVL Variables

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
RequestSwaggerVar()	Constructor.

Method Summary

Modifier and Type	Method	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.
boolean	canResolve(VarResolverSession session)	Returns true if this variable can be resolved in the specified session.
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 Details

NAME

public static final String NAME

The name of this variable.

See Also:

• Constant Field Values

Constructor Details

RequestSwaggerVar

public RequestSwaggerVar()

Constructor.

Method Details

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.

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)
               throws BasicHttpException,
InternalServerError

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:

BasicHttpException

InternalServerError

canResolve

public boolean canResolve(VarResolverSession session)

Description copied from class: Var

Returns true if this variable can be resolved in the specified session.

For example, some variable cannot resolve unless specific context or session objects are available.

Overrides:

canResolve in class Var

Parameters:

session - The current session.

Returns:

true if this variable can be resolved in the specified session.