oracle.oud.plugin

Class RequestContext

java.lang.Object

oracle.oud.plugin.PluginContext

oracle.oud.plugin.RequestContext

public class RequestContext
extends PluginContext

This class defines a context that is associated to the request being executed. This class provides access to elements such as ClientConnection, ...

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RequestContext.ClientConnection This interface provides information on the client connection that submitted the request being processed.
static interface	RequestContext.Logger This interface provides access to the logger to append log information in the access, debug and error logs.
static interface	RequestContext.Request This interface provides information on the request being processed.
static interface	RequestContext.RequestBuilder This interface is a builder to create new Request instances.

Nested classes/interfaces inherited from class oracle.oud.plugin.PluginContext

PluginContext.ControlBuilder, PluginContext.TypeBuilder, PluginContext.Utils

Method Summary

Modifier and Type	Method and Description
RequestContext.ClientConnection	getClientConnection() Retrieves the ClientConnection associated to this context.
RequestManager	getInternalRequestManager() Returns the RequestManager instance that performs internal requests.
RequestContext.Logger	getLogger() Retrieve the logger associated to this context.
RequestContext.Request	getRequest() Returns the context request associated to this context.
RequestContext.RequestBuilder	getRequestBuilder(boolean asRoot) Retrieves the Request builder associated to this context.
RequestContext.RequestBuilder	getRequestBuilder(boolean asRoot, boolean isInternal) Retrieves the Request builder associated to this context.

Methods inherited from class oracle.oud.plugin.PluginContext

getConfiguration, getControlBuilder, getTypeBuilder, getUtils

Methods inherited from class java.lang.Object

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

Method Detail

getInternalRequestManager

public RequestManager getInternalRequestManager()

Returns the RequestManager instance that performs internal requests.

Returns:

the RequestManager instance that performs internal requests.

getRequestBuilder

public RequestContext.RequestBuilder getRequestBuilder(boolean asRoot)

Retrieves the Request builder associated to this context.

Note that only requests created from this builder can be performed with privileges of root.

Note that invoking this method as: getRequestBuilder(asRoot); is the same as invoking: getRequestBuilder(asRoot, asRoot);

Parameters:

asRoot - if true the returned RequestBuilder creates all requests with privilege of Root. If false then requests are created with the level of privilege of the current authenticated user or as anonymous if the current user is not authenticated.

Returns:

the Request builder associated to this context.

getRequestBuilder

public RequestContext.RequestBuilder getRequestBuilder(boolean asRoot,
                                                       boolean isInternal)

Retrieves the Request builder associated to this context.

Note that only requests created from this builder can be performed with privileges of root.

The isInternal parameter flags the requests built from the returned RequestBuilder with the specified value. See Request.isInternal() for more information.

Parameters:

asRoot - if true the returned RequestBuilder creates all requests with privilege of Root. If false then requests are created with the level of privilege of the current authenticated user or as anonymous if the current user is not authenticated.

isInternal - if true the returned RequestBuilder creates all requests as internal requests. If false then created requests are not tagged as internal requests and have a lower level of privilege.

Returns:

the Request builder associated to this context.

getLogger

public RequestContext.Logger getLogger()

Retrieve the logger associated to this context.

Returns:

the logger associated to this context.

getClientConnection

public RequestContext.ClientConnection getClientConnection()

Retrieves the ClientConnection associated to this context.

Returns:

the ClientConnection associated to this context.

getRequest

public RequestContext.Request getRequest()

Returns the context request associated to this context.

Returns:

the context request associated to this context.