org.apache.juneau.rest

Class RestParam

java.lang.Object

org.apache.juneau.rest.RestParam

public abstract class RestParam
extends Object

REST java method parameter resolver.

Used to resolve instances of classes being passed to Java REST methods.

By default, the following parameter types can be passed into Java methods in any order:

Standard top-level objects

• Standard top-level objects
  • HttpServletRequest
  • RestRequest
  • HttpServletResponse
  • RestResponse
• Headers
  • Accept
  • AcceptCharset
  • AcceptEncoding
  • AcceptLanguage
  • Authorization
  • CacheControl
  • Connection
  • ContentLength
  • ContentType
  • Date
  • Expect
  • From
  • Host
  • IfMatch
  • IfModifiedSince
  • IfNoneMatch
  • IfRange
  • IfUnmodifiedSince
  • MaxForwards
  • Pragma
  • ProxyAuthorization
  • Range
  • Referer
  • TE
  • TimeZone
  • UserAgent
  • Upgrade
  • Via
  • Warning
• Other objects
  • Config
  • HttpMethod
  • InputStream
  • Locale
  • MessageBundle
  • OutputStream
  • Parser
  • Reader
  • RequestBody
  • RequestFormData
  • RequestHeaders
  • RequestPathMatch
  • RequestQuery
  • ResourceBundle
  • RestContext
  • RestLogger
  • RequestProperties
  • ServletInputStream
  • ServletOutputStream
  • Swagger
  • UriContext
  • UriResolver
  • Writer

See Also:

• RestContext.REST_paramResolvers
• Overview > juneau-rest-server > Java Method Parameters

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RestParam(RestParamType paramType, String name, Type type) Constructor.

Method Summary

Modifier and Type	Method and Description
protected Class<?>	forClass() Returns the parameter class type that this parameter resolver is meant for.
protected String	getName() Returns the parameter name for this parameter as shown in the Swagger doc.
protected RestParamType	getParamType() Returns the swagger parameter type for this parameter as shown in the Swagger doc.
Type	getType() Returns the parameter class type.
abstract Object	resolve(RestRequest req, RestResponse res) Resolves the parameter object.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestParam

protected RestParam(RestParamType paramType,
                    String name,
                    Type type)

Constructor.

Parameters:

paramType - The Swagger parameter type.

name - The parameter name. Can be null if parameter doesn't have a name (e.g. the request body).

type - The object type to convert the parameter to.

Method Detail

resolve

public abstract Object resolve(RestRequest req,
                               RestResponse res)
                        throws Exception

Resolves the parameter object.

Parameters:

req - The rest request.

res - The rest response.

Returns:

The resolved object.

Throws:

Exception

forClass

protected Class<?> forClass()

Returns the parameter class type that this parameter resolver is meant for.

Returns:

The parameter class type, or null if the type passed in isn't an instance of Class.

getParamType

protected RestParamType getParamType()

Returns the swagger parameter type for this parameter as shown in the Swagger doc.

Returns:

the swagger parameter type for this parameter.

getName

protected String getName()

Returns the parameter name for this parameter as shown in the Swagger doc.

Returns:

the parameter name for this parameter.

getType

public Type getType()

Returns the parameter class type.

Returns:

the parameter class type.