Package org.apache.juneau.rest

Class RestContext

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.rest.RestContext

public class RestContext
extends Context

Defines the initial configuration of a RestServlet or @Rest annotated object.

An extension of the ServletConfig object used during servlet initialization.

Methods are provided for overriding or augmenting the information provided by the @Rest annotation. In general, most information provided in the @Rest annotation can be specified programmatically through calls on this object.

To interact with this object, simply pass it in as a constructor argument or in an INIT hook.

// Option #1 - Pass in through constructor. public MyResource(RestContext.Builder builder) { builder .swaps(TemporalCalendarSwap.IsoLocalDateTime.class); } // Option #2 - Use an init hook. @RestInit public void init(RestContext.Builder builder) throws Exception { builder .swaps(TemporalCalendarSwap.IsoLocalDateTime.class); }

Notes:

• This class is thread safe and reusable.

See Also:

• RestContext

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	allowContentParam
protected final Set<String>	allowedHeaderParams
protected final Set<String>	allowedMethodHeaders
protected final Set<String>	allowedMethodParams
protected final BeanContext	beanContext
protected final BeanStore	beanStore
protected final RestContext.Builder	builder
protected final CallLogger	callLogger
protected final String	clientVersionHeader
protected final Config	config
protected final List<MediaType>	consumes
protected final DebugEnablement	debugEnablement
protected final Charset	defaultCharset
protected final DefaultClassList	defaultClasses
protected final NamedAttributeMap	defaultRequestAttributes
protected final HeaderList	defaultRequestHeaders
protected final HeaderList	defaultResponseHeaders
protected final DefaultSettingsMap	defaultSettings
protected final EncoderSet	encoders
protected final String	fullPath
protected final BasicHttpException	initException
protected final AtomicBoolean	initialized
protected final JsonSchemaGenerator	jsonSchemaGenerator
protected final ThreadLocal<RestSession>	localSession
protected final Logger	logger
protected final long	maxInput
protected final Messages	messages
protected final MethodExecStore	methodExecStore
protected final RestContext	parentContext
protected final ParserSet	parsers
protected final HttpPartParser	partParser
protected final HttpPartSerializer	partSerializer
protected final String	path
protected final UrlPathMatcher	pathMatcher
protected final List<MediaType>	produces
protected final boolean	renderResponseStackTraces
protected final Class<?>	resourceClass
protected final ResponseProcessor[]	responseProcessors
protected final RestChildren	restChildren
protected final Class<? extends RestOpArg>[]	restOpArgs
protected final RestOperations	restOperations
protected final BeanStore	rootBeanStore
protected final SerializerSet	serializers
protected final Instant	startTime
protected final StaticFiles	staticFiles
protected final ConcurrentHashMap<Locale,Swagger>	swaggerCache
protected final SwaggerProvider	swaggerProvider
protected final ThrownStore	thrownStore
protected final String	uriAuthority
protected final String	uriContext
protected final UriRelativity	uriRelativity
protected final UriResolution	uriResolution
protected final VarResolver	varResolver

Fields inherited from class org.apache.juneau.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Constructor	Description
RestContext(RestContext.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected Throwable	convertThrowable(Throwable t)	Method that can be subclassed to allow uncaught throwables to be treated as other types of throwables.
static RestContext.Builder	create(Class<?> resourceClass, RestContext parentContext, jakarta.servlet.ServletConfig servletConfig)	Creates a new builder for this object.
RestSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
void	destroy()	Called during servlet destruction to invoke all RestDestroy methods.
protected void	endCall(RestSession session)	Called at the end of a request to invoke all RestEndCall methods.
void	execute(Object resource, jakarta.servlet.http.HttpServletRequest r1, jakarta.servlet.http.HttpServletResponse r2)	The main service method.
protected RestOpArg[]	findRestOperationArgs(Method m, BeanStore beanStore)	Finds the RestOpArg instances to handle resolving objects on the calls to the specified Java method.
Set<String>	getAllowedHeaderParams()	Allowed header URL parameters.
Set<String>	getAllowedMethodHeaders()	Allowed method headers.
Set<String>	getAllowedMethodParams()	Allowed method URL parameters.
AnnotationWorkList	getAnnotations()	Returns the annotations applied to this context.
BeanContext	getBeanContext()	Returns the bean context associated with this context.
BeanStore	getBeanStore()	Returns the bean store associated with this context.
jakarta.servlet.ServletConfig	getBuilder()	Returns the builder that created this context.
CallLogger	getCallLogger()	Returns the call logger to use for this resource.
String	getClientVersionHeader()	Returns the name of the client version header name used by this resource.
Config	getConfig()	Returns the config file associated with this servlet.
List<MediaType>	getConsumes()	Returns the explicit list of supported content types for this resource.
DebugEnablement	getDebugEnablement()	Returns the debug enablement bean for this context.
NamedAttributeMap	getDefaultRequestAttributes()	Returns the default request attributes for this resource.
HeaderList	getDefaultRequestHeaders()	Returns the default request headers for this resource.
HeaderList	getDefaultResponseHeaders()	Returns the default response headers for this resource.
EncoderSet	getEncoders()	Returns the encoders associated with this context.
String	getFullPath()	Returns the path for this resource as defined by the @Rest(path) annotation or RestContext.Builder.path(String) method concatenated with those on all parent classes.
static final Map<Class<?>,RestContext>	getGlobalRegistry()	Returns a registry of all created RestContext objects.
JsonSchemaGenerator	getJsonSchemaGenerator()	Returns the JSON-Schema generator associated with this resource.
RestSession	getLocalSession()	Returns the HTTP call for the current request.
Logger	getLogger()	Returns the logger associated with this context.
Messages	getMessages()	Returns the resource bundle used by this resource.
protected MethodExecStats	getMethodExecStats(Method m)	Returns the time statistics gatherer for the specified method.
MethodExecStore	getMethodExecStore()	Returns the timing statistics on all method executions on this class.
ParserSet	getParsers()	Returns the parsers associated with this context.
HttpPartParser	getPartParser()	Returns the HTTP-part parser associated with this resource.
HttpPartSerializer	getPartSerializer()	Returns the HTTP-part serializer associated with this resource.
String	getPath()	Returns the path for this resource as defined by the @Rest(path) annotation or RestContext.Builder.path(String) method.
UrlPathMatcher	getPathMatcher()	Returns the path matcher for this context.
protected MethodList	getPostCallMethods()	Returns the list of methods to invoke after the actual REST method is called.
protected MethodList	getPreCallMethods()	Returns the list of methods to invoke before the actual REST method is called.
List<MediaType>	getProduces()	Returns the explicit list of supported accept types for this resource.
Object	getResource()	Returns the resource object.
Class<?>	getResourceClass()	Returns the resource class type.
RestChildren	getRestChildren()	Returns the child resources associated with this servlet.
RestOperations	getRestOperations()	Returns the REST Java methods defined in this resource.
BeanStore	getRootBeanStore()	Returns the root bean store for this context.
SerializerSet	getSerializers()	Returns the serializers associated with this context.
String	getServletInitParameter(String name)	Returns the servlet init parameter returned by ServletConfig.getInitParameter(String).
StaticFiles	getStaticFiles()	Returns the static files associated with this context.
RestContextStats	getStats()	Gives access to the internal statistics on this context.
Optional<Swagger>	getSwagger(Locale locale)	Returns the swagger for the REST resource.
SwaggerProvider	getSwaggerProvider()	Returns the Swagger provider used by this resource.
ThrownStore	getThrownStore()	Returns the stack trace database associated with this context.
String	getUriAuthority()	Returns the authority path of the resource.
String	getUriContext()	Returns the context path of the resource.
UriRelativity	getUriRelativity()	Returns the setting on how relative URIs should be interpreted as relative to.
UriResolution	getUriResolution()	Returns the setting on how relative URIs should be resolved.
VarResolver	getVarResolver()	Returns the variable resolver for this servlet.
protected void	handleError(RestSession session, Throwable e)	Method for handling response errors.
protected void	handleNotFound(RestSession session)	Handle the case where a matching method was not found.
boolean	isAllowContentParam()	Returns whether it's safe to pass the HTTP content as a "content" GET parameter.
boolean	isRenderResponseStackTraces()	Returns whether it's safe to render stack traces in HTTP responses.
protected void	postCall(RestOpSession session)	Called during a request to invoke all RestPostCall methods.
RestContext	postInit()	Called during servlet initialization to invoke all RestPostInit child-last methods.
RestContext	postInitChildFirst()	Called during servlet initialization to invoke all RestPostInit child-first methods.
protected void	preCall(RestOpSession session)	Called during a request to invoke all RestPreCall methods.
protected void	processResponse(RestOpSession opSession)	The main method for serializing POJOs passed in through the RestResponse.setContent(Object) method or returned by the Java method.
protected FluentMap<String,Object>	properties()	Returns the properties on this bean as a map for debugging.
protected void	startCall(RestSession session)	Called at the start of a request to invoke all RestStartCall methods.

Methods inherited from class org.apache.juneau.Context

copy, createBuilder, getAnnotationProvider, getSession, init, isDebug, toString

Methods inherited from class java.lang.Object

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

Field Details

allowContentParam

protected final boolean allowContentParam

renderResponseStackTraces

protected final boolean renderResponseStackTraces

maxInput

protected final long maxInput

initialized

protected final AtomicBoolean initialized

initException

protected final BasicHttpException initException

beanContext

protected final BeanContext beanContext

beanStore

protected final BeanStore beanStore

rootBeanStore

protected final BeanStore rootBeanStore

builder

protected final RestContext.Builder builder

callLogger

protected final CallLogger callLogger

defaultCharset

protected final Charset defaultCharset

resourceClass

protected final Class<?> resourceClass

restOpArgs

protected final Class<? extends RestOpArg>[] restOpArgs

swaggerCache

protected final ConcurrentHashMap<Locale,Swagger> swaggerCache

config

protected final Config config

debugEnablement

protected final DebugEnablement debugEnablement

defaultClasses

protected final DefaultClassList defaultClasses

defaultSettings

protected final DefaultSettingsMap defaultSettings

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

startTime

protected final Instant startTime

jsonSchemaGenerator

protected final JsonSchemaGenerator jsonSchemaGenerator

consumes

protected final List<MediaType> consumes

produces

protected final List<MediaType> produces

logger

protected final Logger logger

messages

protected final Messages messages

methodExecStore

protected final MethodExecStore methodExecStore

defaultRequestAttributes

protected final NamedAttributeMap defaultRequestAttributes

parsers

protected final ParserSet parsers

restChildren

protected final RestChildren restChildren

parentContext

protected final RestContext parentContext

restOperations

protected final RestOperations restOperations

responseProcessors

protected final ResponseProcessor[] responseProcessors

serializers

protected final SerializerSet serializers

allowedHeaderParams

protected final Set<String> allowedHeaderParams

allowedMethodHeaders

protected final Set<String> allowedMethodHeaders

allowedMethodParams

protected final Set<String> allowedMethodParams

staticFiles

protected final StaticFiles staticFiles

clientVersionHeader

protected final String clientVersionHeader

fullPath

protected final String fullPath

path

protected final String path

uriAuthority

protected final String uriAuthority

uriContext

protected final String uriContext

swaggerProvider

protected final SwaggerProvider swaggerProvider

thrownStore

protected final ThrownStore thrownStore

localSession

protected final ThreadLocal<RestSession> localSession

uriRelativity

protected final UriRelativity uriRelativity

uriResolution

protected final UriResolution uriResolution

pathMatcher

protected final UrlPathMatcher pathMatcher

varResolver

protected final VarResolver varResolver

Constructor Details

RestContext

public RestContext(RestContext.Builder builder)
            throws Exception

Constructor.

Parameters:

builder - The builder containing the settings for this bean.

Throws:

Exception - If any initialization problems were encountered.

Method Details

create

public static RestContext.Builder create(Class<?> resourceClass,
 RestContext parentContext,
 jakarta.servlet.ServletConfig servletConfig)
                                  throws jakarta.servlet.ServletException

Creates a new builder for this object.

Parameters:

resourceClass - The class annotated with @Rest.
Must not be null.

parentContext - The parent context if the REST bean was registered via Rest.children().
Can be null if the bean is a top-level resource.

servletConfig - The servlet config passed into the servlet by the servlet container.
Can be null if not available.
If null, then some features (such as access to servlet init params) will not be available.

Returns:

A new builder object.

Throws:

jakarta.servlet.ServletException - Something bad happened.

getGlobalRegistry

public static final Map<Class<?>,RestContext> getGlobalRegistry()

Returns a registry of all created RestContext objects.

Returns:

An unmodifiable map of resource classes to RestContext objects.

createSession

public RestSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class Context

Returns:

A new session builder.

destroy

public void destroy()

Called during servlet destruction to invoke all RestDestroy methods.

execute

public void execute(Object resource,
 jakarta.servlet.http.HttpServletRequest r1,
 jakarta.servlet.http.HttpServletResponse r2)
             throws jakarta.servlet.ServletException,
IOException

The main service method.

Subclasses can optionally override this method if they want to tailor the behavior of requests.

Parameters:

resource - The REST servlet or bean that this context defines.
Note that this bean may not be the same bean used during initialization as it may have been replaced at runtime.

r1 - The incoming HTTP servlet request object.

r2 - The incoming HTTP servlet response object.

Throws:

jakarta.servlet.ServletException - General servlet exception.

IOException - Thrown by underlying stream.

getAllowedHeaderParams

public Set<String> getAllowedHeaderParams()

Allowed header URL parameters.

See Also:

• Rest.allowedHeaderParams()
• RestContext.Builder.allowedHeaderParams(String)

Returns:

The header names allowed to be passed as URL parameters.
The set is case-insensitive ordered and unmodifiable.

getAllowedMethodHeaders

public Set<String> getAllowedMethodHeaders()

Allowed method headers.

See Also:

• Rest.allowedMethodHeaders()
• RestContext.Builder.allowedMethodHeaders(String)

Returns:

The method names allowed to be passed as X-Method headers.
The set is case-insensitive ordered and unmodifiable.

getAllowedMethodParams

public Set<String> getAllowedMethodParams()

Allowed method URL parameters.

See Also:

• Rest.allowedMethodParams()
• RestContext.Builder.allowedMethodParams(String)

Returns:

The method names allowed to be passed as method URL parameters.
The set is case-insensitive ordered and unmodifiable.

getAnnotations

public AnnotationWorkList getAnnotations()

Returns the annotations applied to this context.

Returns:

The annotations applied to this context.

getBeanContext

public BeanContext getBeanContext()

Returns the bean context associated with this context.

Returns:

The bean store associated with this context.

getBeanStore

public BeanStore getBeanStore()

Returns the bean store associated with this context.

The bean store is used for instantiating child resource classes.

Returns:

The resource resolver associated with this context.

getBuilder

public jakarta.servlet.ServletConfig getBuilder()

Returns the builder that created this context.

Returns:

The builder that created this context.

getCallLogger

public CallLogger getCallLogger()

Returns the call logger to use for this resource.

See Also:

• RestContext.Builder.callLogger()

Returns:

The call logger to use for this resource.
Never null.

getClientVersionHeader

public String getClientVersionHeader()

Returns the name of the client version header name used by this resource.

See Also:

• Rest.clientVersionHeader()
• RestContext.Builder.clientVersionHeader(String)

Returns:

The name of the client version header used by this resource.
Never null.

getConfig

public Config getConfig()

Returns the config file associated with this servlet.

The config file is identified via one of the following:

• Rest.config()
• RestContext.Builder.config(Config)

Returns:

The resolving config file associated with this servlet.
Never null.

getConsumes

public List<MediaType> getConsumes()

Returns the explicit list of supported content types for this resource.

Consists of the media types for consumption common to all operations on this class.

Can be overridden by RestContext.Builder.consumes(MediaType...).

Returns:

An unmodifiable list of supported Content-Type header values for this resource.
Never null.

getDebugEnablement

public DebugEnablement getDebugEnablement()

Returns the debug enablement bean for this context.

Returns:

The debug enablement bean for this context.

getDefaultRequestAttributes

public NamedAttributeMap getDefaultRequestAttributes()

Returns the default request attributes for this resource.

See Also:

• RestContext.Builder.defaultRequestAttributes(NamedAttribute...)

Returns:

The default request headers for this resource in an unmodifiable list.
Never null.

getDefaultRequestHeaders

public HeaderList getDefaultRequestHeaders()

Returns the default request headers for this resource.

See Also:

• RestContext.Builder.defaultRequestHeaders(org.apache.http.Header...)

Returns:

The default request headers for this resource in an unmodifiable list.
Never null.

getDefaultResponseHeaders

public HeaderList getDefaultResponseHeaders()

Returns the default response headers for this resource.

See Also:

• RestContext.Builder.defaultResponseHeaders(org.apache.http.Header...)

Returns:

The default response headers for this resource in an unmodifiable list.
Never null.

getEncoders

public EncoderSet getEncoders()

Returns the encoders associated with this context.

Returns:

The encoders associated with this context.

getFullPath

public String getFullPath()

Returns the path for this resource as defined by the @Rest(path) annotation or RestContext.Builder.path(String) method concatenated with those on all parent classes.

If path is not specified, returns "".

See Also:

• RestContext.Builder.path(String)

Returns:

The full path.

getJsonSchemaGenerator

public JsonSchemaGenerator getJsonSchemaGenerator()

Returns the JSON-Schema generator associated with this resource.

Returns:

The HTTP-part serializer associated with this resource.
Never null.

getLocalSession

public RestSession getLocalSession()

Returns the HTTP call for the current request.

Returns:

The HTTP call for the current request, never null?

Throws:

InternalServerError - If no active request exists on the current thread.

getLogger

public Logger getLogger()

Returns the logger associated with this context.

Returns:

The logger for this resource.
Never null.

getMessages

public Messages getMessages()

Returns the resource bundle used by this resource.

Returns:

The resource bundle for this resource.
Never null.

getMethodExecStore

public MethodExecStore getMethodExecStore()

Returns the timing statistics on all method executions on this class.

Returns:

The timing statistics on all method executions on this class.

getParsers

public ParserSet getParsers()

Returns the parsers associated with this context.

Returns:

The parsers associated with this context.

getPartParser

public HttpPartParser getPartParser()

Returns the HTTP-part parser associated with this resource.

Returns:

The HTTP-part parser associated with this resource.
Never null.

getPartSerializer

public HttpPartSerializer getPartSerializer()

Returns the HTTP-part serializer associated with this resource.

Returns:

The HTTP-part serializer associated with this resource.
Never null.

getPath

public String getPath()

Returns the path for this resource as defined by the @Rest(path) annotation or RestContext.Builder.path(String) method.

If path is not specified, returns "".

See Also:

• RestContext.Builder.path(String)

Returns:

The servlet path.

getPathMatcher

public UrlPathMatcher getPathMatcher()

Returns the path matcher for this context.

Returns:

The path matcher for this context.

getProduces

public List<MediaType> getProduces()

Returns the explicit list of supported accept types for this resource.

Consists of the media types for production common to all operations on this class.

Can be overridden by RestContext.Builder.produces(MediaType...).

Returns:

An unmodifiable list of supported Accept header values for this resource.
Never null.

getResource

public Object getResource()

Returns the resource object.

This is the instance of the class annotated with the @Rest annotation, usually an instance of RestServlet.

Returns:

The resource object.
Never null.

getResourceClass

public Class<?> getResourceClass()

Returns the resource class type.

Returns:

The resource class type.

getRestChildren

public RestChildren getRestChildren()

Returns the child resources associated with this servlet.

Returns:

An unmodifiable map of child resources. Keys are the @Rest(path) annotation defined on the child resource.

getRestOperations

public RestOperations getRestOperations()

Returns the REST Java methods defined in this resource.

These are the methods annotated with the @RestOp annotation.

Returns:

An unmodifiable map of Java method names to call method objects.

getRootBeanStore

public BeanStore getRootBeanStore()

Returns the root bean store for this context.

Returns:

The root bean store for this context.

getSerializers

public SerializerSet getSerializers()

Returns the serializers associated with this context.

Returns:

The serializers associated with this context.

getServletInitParameter

public String getServletInitParameter(String name)

Returns the servlet init parameter returned by ServletConfig.getInitParameter(String).

Parameters:

name - The init parameter name.

Returns:

The servlet init parameter, or null if not found.

getStaticFiles

public StaticFiles getStaticFiles()

Returns the static files associated with this context.

Returns:

The static files for this resource.
Never null.

getStats

public RestContextStats getStats()

Gives access to the internal statistics on this context.

Returns:

The context statistics.

getSwagger

public Optional<Swagger> getSwagger(Locale locale)

Returns the swagger for the REST resource.

Parameters:

locale - The locale of the swagger to return.

Returns:

The swagger as an Optional. Never null.

getSwaggerProvider

public SwaggerProvider getSwaggerProvider()

Returns the Swagger provider used by this resource.

See Also:

• RestContext.Builder.swaggerProvider(Class)
• RestContext.Builder.swaggerProvider(SwaggerProvider)

Returns:

The information provider for this resource.
Never null.

getThrownStore

public ThrownStore getThrownStore()

Returns the stack trace database associated with this context.

Returns:

The stack trace database for this resource.
Never null.

getUriAuthority

public String getUriAuthority()

Returns the authority path of the resource.

See Also:

• RestContext.Builder.uriAuthority(String)

Returns:

The authority path of this resource.
If not specified, returns the context path of the ascendant resource.

getUriContext

public String getUriContext()

Returns the context path of the resource.

See Also:

• RestContext.Builder.uriContext(String)

Returns:

The context path of this resource.
If not specified, returns the context path of the ascendant resource.

getUriRelativity

public UriRelativity getUriRelativity()

Returns the setting on how relative URIs should be interpreted as relative to.

See Also:

• RestContext.Builder.uriRelativity(UriRelativity)

Returns:

The URI-resolution relativity setting value.
Never null.

getUriResolution

public UriResolution getUriResolution()

Returns the setting on how relative URIs should be resolved.

See Also:

• RestContext.Builder.uriResolution(UriResolution)

Returns:

The URI-resolution setting value.
Never null.

getVarResolver

public VarResolver getVarResolver()

Returns the variable resolver for this servlet.

Variable resolvers are used to replace variables in property values. They can be nested arbitrarily deep. They can also return values that themselves contain other variables.

Example:

@Rest( messages="nls/Messages", properties={ @Property(name="title",value="$L{title}"), // Localized variable in Messages.properties @Property(name="javaVendor",value="$S{java.vendor,Oracle}"), // System property with default value @Property(name="foo",value="bar"), @Property(name="bar",value="baz"), @Property(name="v1",value="$R{foo}"), // Request variable. value="bar" @Property(name="v1",value="$R{foo,bar}"), // Request variable. value="bar" } ) public class MyRestResource extends BasicRestServlet {

A typical usage pattern involves using variables inside the @HtmlDocConfig annotation:

@RestGet("/{name}/*") @HtmlDocConfig( navlinks={ "up: $R{requestParentURI}", "api: servlet:/api", "stats: servlet:/stats", "editLevel: servlet:/editLevel?logger=$A{attribute.name, OFF}" } header={ "<h1>$L{MyLocalizedPageTitle}</h1>" }, aside={ "$F{resources/AsideText.html}" } ) public LoggerEntry getLogger(RestRequest req, @Path String name) throws Exception {

See Also:

• SVL Variables

Returns:

The var resolver in use by this resource.

isAllowContentParam

public boolean isAllowContentParam()

Returns whether it's safe to pass the HTTP content as a "content" GET parameter.

See Also:

• RestContext.Builder.disableContentParam()

Returns:

true if setting is enabled.

isRenderResponseStackTraces

public boolean isRenderResponseStackTraces()

Returns whether it's safe to render stack traces in HTTP responses.

Returns:

true if setting is enabled.

postInit

public RestContext postInit()
                     throws jakarta.servlet.ServletException

Called during servlet initialization to invoke all RestPostInit child-last methods.

Returns:

This object.

Throws:

jakarta.servlet.ServletException - Error occurred.

postInitChildFirst

public RestContext postInitChildFirst()
                               throws jakarta.servlet.ServletException

Called during servlet initialization to invoke all RestPostInit child-first methods.

Returns:

This object.

Throws:

jakarta.servlet.ServletException - Error occurred.

convertThrowable

protected Throwable convertThrowable(Throwable t)

Method that can be subclassed to allow uncaught throwables to be treated as other types of throwables.

The default implementation looks at the throwable class name to determine whether it can be converted to another type:

• "*AccessDenied*" - Converted to Unauthorized.
• "*Empty*","*NotFound*" - Converted to NotFound.

Parameters:

t - The thrown object.

Returns:

The converted thrown object.

endCall

protected void endCall(RestSession session)

Called at the end of a request to invoke all RestEndCall methods.

This is the very last method called in execute(Object, HttpServletRequest, HttpServletResponse).

Parameters:

session - The current request.

findRestOperationArgs

protected RestOpArg[] findRestOperationArgs(Method m,
 BeanStore beanStore)

Finds the RestOpArg instances to handle resolving objects on the calls to the specified Java method.

Parameters:

m - The Java method being called.

beanStore - The factory used for creating beans and retrieving injected beans.
Created by RestContext.Builder.beanStore().

Returns:

The array of resolvers.

getMethodExecStats

protected MethodExecStats getMethodExecStats(Method m)

Returns the time statistics gatherer for the specified method.

Parameters:

m - The method to get statistics for.

Returns:

The cached time-stats object.

getPostCallMethods

protected MethodList getPostCallMethods()

Returns the list of methods to invoke after the actual REST method is called.

Returns:

The list of methods to invoke after the actual REST method is called.

getPreCallMethods

protected MethodList getPreCallMethods()

Returns the list of methods to invoke before the actual REST method is called.

Returns:

The list of methods to invoke before the actual REST method is called.

handleError

protected void handleError(RestSession session,
 Throwable e)
                    throws IOException

Method for handling response errors.

Subclasses can override this method to provide their own custom error response handling.

Parameters:

session - The rest call.

e - The exception that occurred.

Throws:

IOException - Can be thrown if a problem occurred trying to write to the output stream.

handleNotFound

protected void handleNotFound(RestSession session)
                       throws Exception

Handle the case where a matching method was not found.

Subclasses can override this method to provide a 2nd-chance for specifying a response. The default implementation will simply throw an exception with an appropriate message.

Parameters:

session - The HTTP call.

Throws:

Exception - Any exception can be thrown.

postCall

protected void postCall(RestOpSession session)
                 throws Throwable

Called during a request to invoke all RestPostCall methods.

Parameters:

session - The current request.

Throws:

Throwable - If thrown from call methods.

preCall

protected void preCall(RestOpSession session)
                throws Throwable

Called during a request to invoke all RestPreCall methods.

Parameters:

session - The current request.

Throws:

Throwable - If thrown from call methods.

processResponse

protected void processResponse(RestOpSession opSession)
                        throws IOException,
BasicHttpException,
NotImplemented

The main method for serializing POJOs passed in through the RestResponse.setContent(Object) method or returned by the Java method.

Subclasses may override this method if they wish to modify the way the output is rendered or support other output formats.

The default implementation simply iterates through the response handlers on this resource looking for the first one whose ResponseProcessor.process(RestOpSession) method returns true.

Parameters:

opSession - The HTTP call.

Throws:

IOException - Thrown by underlying stream.

BasicHttpException - Non-200 response.

NotImplemented - No registered response processors could handle the call.

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.

startCall

protected void startCall(RestSession session)
                  throws BasicHttpException

Called at the start of a request to invoke all RestStartCall methods.

Parameters:

session - The current request.

Throws:

BasicHttpException - If thrown from call methods.