Package org.apache.juneau.rest

Class RestOpContext

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.rest.RestOpContext

All Implemented Interfaces:

Comparable<RestOpContext>

Direct Known Subclasses:

RrpcRestOpContext

public class RestOpContext
extends Context
implements Comparable<RestOpContext>

Represents a single Java servlet/resource method annotated with @RestOp.

Notes:

• This class is thread safe and reusable.

See Also:

• RestOpContext

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RestOpContext.Builder	Builder class.

Field Summary

Fields

Modifier and Type	Field	Description
protected final BeanContext	beanContext
protected final CallLogger	callLogger
protected final RestContext	context
protected final RestConverter[]	converters
protected final DebugEnablement	debug
protected final Charset	defaultCharset
protected final NamedAttributeMap	defaultRequestAttributes
protected final PartList	defaultRequestFormData
protected final HeaderList	defaultRequestHeaders
protected final PartList	defaultRequestQueryData
protected final HeaderList	defaultResponseHeaders
protected final boolean	dotAll
protected final EncoderSet	encoders
protected final RestGuard[]	guards
protected final Map<Class<?>,ResponsePartMeta>	headerPartMetas
protected final int	hierarchyDepth
protected final String	httpMethod
protected final JsonSchemaGenerator	jsonSchemaGenerator
protected final long	maxInput
protected final Method	method
protected final RestOpInvoker	methodInvoker
protected final MethodInfo	mi
protected final RestMatcher[]	optionalMatchers
protected final ParserSet	parsers
protected final HttpPartParser	partParser
protected final HttpPartSerializer	partSerializer
protected final UrlPathMatcher[]	pathMatchers
protected final RestOpInvoker[]	postCallMethods
protected final RestOpInvoker[]	preCallMethods
protected final RestMatcher[]	requiredMatchers
protected final Map<Class<?>,ResponseBeanMeta>	responseBeanMetas
protected final ResponseBeanMeta	responseMeta
protected final SerializerSet	serializers
protected final List<MediaType>	supportedAcceptTypes
protected final List<MediaType>	supportedContentTypes

Fields inherited from class org.apache.juneau.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RestOpContext(RestOpContext.Builder builder)	Context constructor.

Method Summary

Modifier and Type	Method	Description
int	compareTo(RestOpContext o)
Context.Builder	copy()	Creates a builder from this context object.
static RestOpContext.Builder	create(Method method, RestContext context)	Creates a new builder for this object.
RestRequest	createRequest(RestSession session)	Creates a RestRequest object based on the specified incoming HttpServletRequest object.
RestResponse	createResponse(RestSession session, RestRequest req)	Creates a RestResponse object based on the specified incoming HttpServletResponse object and the request returned by createRequest(RestSession).
RestOpSession.Builder	createSession(RestSession session)	Creates a new REST operation session.
boolean	equals(Object o)
BeanContext	getBeanContext()	Returns the bean context associated with this context.
Charset	getDefaultCharset()	Returns the default charset.
NamedAttributeMap	getDefaultRequestAttributes()	Returns the default request attributes.
PartList	getDefaultRequestFormData()	Returns the default form data parameters.
HeaderList	getDefaultRequestHeaders()	Returns the default request headers.
PartList	getDefaultRequestQueryData()	Returns the default request query parameters.
HeaderList	getDefaultResponseHeaders()	Returns the default response headers.
EncoderSet	getEncoders()	Returns the compression encoders to use for this method.
String	getHttpMethod()	Returns the HTTP method name (e.g.
Method	getJavaMethod()	Returns the underlying Java method that this context belongs to.
JsonSchemaGenerator	getJsonSchemaGenerator()	Returns the JSON-Schema generator applicable to this Java method.
long	getMaxInput()	Returns the max number of bytes to process in the input content.
ParserSet	getParsers()	Returns the parsers to use for this method.
HttpPartParser	getPartParser()	Bean property getter: partParser.
HttpPartSerializer	getPartSerializer()	Bean property getter: partSerializer.
String	getPathPattern()	Returns the path pattern for this method.
ResponseBeanMeta	getResponseBeanMeta(Object o)	Returns metadata about the specified response object if it's annotated with @Response.
ResponsePartMeta	getResponseHeaderMeta(Object o)	Returns metadata about the specified response object if it's annotated with @Header.
ResponseBeanMeta	getResponseMeta()	Returns the response bean meta if this method returns a Response-annotated bean.
SerializerSet	getSerializers()	Returns the serializers to use for this method.
List<MediaType>	getSupportedAcceptTypes()	Returns a list of supported accept types.
List<MediaType>	getSupportedContentTypes()	Returns the list of supported content types.
int	hashCode()
protected int	match(RestSession session)	Identifies if this method can process the specified call.
protected FluentMap<String,Object>	properties()	Returns the properties on this bean as a map for debugging.

Methods inherited from class org.apache.juneau.Context

createBuilder, createSession, getAnnotationProvider, getSession, init, isDebug, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

dotAll

protected final boolean dotAll

hierarchyDepth

protected final int hierarchyDepth

maxInput

protected final long maxInput

beanContext

protected final BeanContext beanContext

callLogger

protected final CallLogger callLogger

defaultCharset

protected final Charset defaultCharset

debug

protected final DebugEnablement debug

encoders

protected final EncoderSet encoders

defaultRequestHeaders

protected final HeaderList defaultRequestHeaders

defaultResponseHeaders

protected final HeaderList defaultResponseHeaders

partParser

protected final HttpPartParser partParser

partSerializer

protected final HttpPartSerializer partSerializer

jsonSchemaGenerator

protected final JsonSchemaGenerator jsonSchemaGenerator

supportedAcceptTypes

protected final List<MediaType> supportedAcceptTypes

supportedContentTypes

protected final List<MediaType> supportedContentTypes

responseBeanMetas

protected final Map<Class<?>,ResponseBeanMeta> responseBeanMetas

headerPartMetas

protected final Map<Class<?>,ResponsePartMeta> headerPartMetas

method

protected final Method method

mi

protected final MethodInfo mi

defaultRequestAttributes

protected final NamedAttributeMap defaultRequestAttributes

defaultRequestFormData

protected final PartList defaultRequestFormData

defaultRequestQueryData

protected final PartList defaultRequestQueryData

parsers

protected final ParserSet parsers

context

protected final RestContext context

converters

protected final RestConverter[] converters

guards

protected final RestGuard[] guards

optionalMatchers

protected final RestMatcher[] optionalMatchers

requiredMatchers

protected final RestMatcher[] requiredMatchers

methodInvoker

protected final RestOpInvoker methodInvoker

postCallMethods

protected final RestOpInvoker[] postCallMethods

preCallMethods

protected final RestOpInvoker[] preCallMethods

responseMeta

protected final ResponseBeanMeta responseMeta

serializers

protected final SerializerSet serializers

httpMethod

protected final String httpMethod

pathMatchers

protected final UrlPathMatcher[] pathMatchers

Constructor Details

RestOpContext

protected RestOpContext(RestOpContext.Builder builder)
                 throws jakarta.servlet.ServletException

Context constructor.

Parameters:

builder - The builder for this object.

Throws:

jakarta.servlet.ServletException - If context could not be created.

Method Details

create

public static RestOpContext.Builder create(Method method,
 RestContext context)

Creates a new builder for this object.

Parameters:

method - The Java method this context belongs to.

context - The Java class context.

Returns:

A new builder.

compareTo

public int compareTo(RestOpContext o)

Specified by:

compareTo in interface Comparable<RestOpContext>

copy

public Context.Builder copy()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

copy in class Context

Returns:

A new Builder object.

createRequest

public RestRequest createRequest(RestSession session)
                          throws Exception

Creates a RestRequest object based on the specified incoming HttpServletRequest object.

Parameters:

session - The current REST call.

Returns:

The wrapped request object.

Throws:

Exception - If any errors occur trying to interpret the request.

createResponse

public RestResponse createResponse(RestSession session,
 RestRequest req)
                            throws Exception

Creates a RestResponse object based on the specified incoming HttpServletResponse object and the request returned by createRequest(RestSession).

Parameters:

session - The current REST call.

req - The REST request.

Returns:

The wrapped response object.

Throws:

Exception - If any errors occur trying to interpret the request or response.

createSession

public RestOpSession.Builder createSession(RestSession session)
                                    throws Exception

Creates a new REST operation session.

Parameters:

session - The REST session.

Returns:

A new REST operation session.

Throws:

Exception - If op session could not be created.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getBeanContext

public BeanContext getBeanContext()

Returns the bean context associated with this context.

Returns:

The bean context associated with this context.

getDefaultCharset

public Charset getDefaultCharset()

Returns the default charset.

Returns:

The default charset. Never null.

getDefaultRequestAttributes

public NamedAttributeMap getDefaultRequestAttributes()

Returns the default request attributes.

Returns:

The default request attributes. Never null.

getDefaultRequestFormData

public PartList getDefaultRequestFormData()

Returns the default form data parameters.

Returns:

The default form data parameters. Never null.

getDefaultRequestHeaders

public HeaderList getDefaultRequestHeaders()

Returns the default request headers.

Returns:

The default request headers. Never null.

getDefaultRequestQueryData

public PartList getDefaultRequestQueryData()

Returns the default request query parameters.

Returns:

The default request query parameters. Never null.

getDefaultResponseHeaders

public HeaderList getDefaultResponseHeaders()

Returns the default response headers.

Returns:

The default response headers. Never null.

getEncoders

public EncoderSet getEncoders()

Returns the compression encoders to use for this method.

Returns:

The compression encoders to use for this method.

getHttpMethod

public String getHttpMethod()

Returns the HTTP method name (e.g. "GET").

Returns:

The HTTP method name.

getJavaMethod

public Method getJavaMethod()

Returns the underlying Java method that this context belongs to.

Returns:

The underlying Java method that this context belongs to.

getJsonSchemaGenerator

public JsonSchemaGenerator getJsonSchemaGenerator()

Returns the JSON-Schema generator applicable to this Java method.

Returns:

The JSON-Schema generator applicable to this Java method.

getMaxInput

public long getMaxInput()

Returns the max number of bytes to process in the input content.

Returns:

The max number of bytes to process in the input content.

getParsers

public ParserSet getParsers()

Returns the parsers to use for this method.

Returns:

The parsers to use for this method.

getPartParser

public HttpPartParser getPartParser()

Bean property getter: partParser.

Returns:

The value of the partParser property on this bean, or null if it is not set.

getPartSerializer

public HttpPartSerializer getPartSerializer()

Bean property getter: partSerializer.

Returns:

The value of the partSerializer property on this bean, or null if it is not set.

getPathPattern

public String getPathPattern()

Returns the path pattern for this method.

Returns:

The path pattern.

getResponseBeanMeta

public ResponseBeanMeta getResponseBeanMeta(Object o)

Returns metadata about the specified response object if it's annotated with @Response.

Parameters:

o - The response POJO.

Returns:

Metadata about the specified response object, or null if it's not annotated with @Response.

getResponseHeaderMeta

public ResponsePartMeta getResponseHeaderMeta(Object o)

Returns metadata about the specified response object if it's annotated with @Header.

Parameters:

o - The response POJO.

Returns:

Metadata about the specified response object, or null if it's not annotated with @Header.

getResponseMeta

public ResponseBeanMeta getResponseMeta()

Returns the response bean meta if this method returns a Response-annotated bean.

Returns:

The response bean meta or null if it's not a Response-annotated bean.

getSerializers

public SerializerSet getSerializers()

Returns the serializers to use for this method.

Returns:

The serializers to use for this method.

getSupportedAcceptTypes

public List<MediaType> getSupportedAcceptTypes()

Returns a list of supported accept types.

Returns:

An unmodifiable list.

getSupportedContentTypes

public List<MediaType> getSupportedContentTypes()

Returns the list of supported content types.

Returns:

An unmodifiable list.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

match

protected int match(RestSession session)

Identifies if this method can process the specified call.

To process the call, the following must be true:

• Path pattern must match.
• Matchers (if any) must match.

Parameters:

session - The call to check.

Returns:

One of the following values:

• 0 - Path doesn't match.
• 1 - Path matched but matchers did not.
• 2 - Matches.

properties

protected FluentMap<String,Object> properties()

Description copied from class: Context

Returns the properties on this bean as a map for debugging.

Overrides:

properties in class Context

Returns:

The properties on this bean as a map for debugging.