com.day.cq.portlet

Interface InvocationContext

public interface InvocationContext

The invocation context of the current request.

Method Summary

Methods

Modifier and Type	Method and Description
ActionRequest	getActionRequest() Return the current action request if this is an action request.
ActionResponse	getActionResponse() Return the current action response if this is an action request.
Authenticator	getAuthenticator() Return the authenticator
EventRequest	getEventRequest() Return the current event request if this is an event request.
EventResponse	getEventResponse() Return the current event response if this is an event request.
LocaleHandler	getLocaleHandler() Return the locale handler
PortletRequest	getPortletRequest() Return the current portlet request.
PortletResponse	getPortletResponse() Return the current portlet response.
PrivilegeManager	getPrivilegeManager() Return the privilege manager
RenderRequest	getRenderRequest() Return the current render request if this is a render request.
RenderResponse	getRenderResponse() Return the current render response if this is a render request.
RequestProgressTracker	getRequestProgressTracker() Return the request progress tracker
ResourceRequest	getResourceRequest() Return the current resource request if this is a resource request.
ResourceResponse	getResourceResponse() Return the current resource response if this is a resource request.
UserState	getUserState() Get the current user state.
boolean	isActionRequest() Is this an action request?
boolean	isEventRequest() Is this an event request?
boolean	isRenderRequest() Is this a render request?
boolean	isResourceRequest() Is this a resource request?
java.lang.String	translate(java.lang.String text) Translate the message using the current resource bundle of the user.
void	update(ActionRequest request, ActionResponse response) Use new provided action request and/or response object.
void	update(EventRequest request, EventResponse response) Use new provided event request and/or response object.
void	update(RenderRequest request, RenderResponse response) Use new provided render request and/or response object.
void	update(ResourceRequest request, ResourceResponse response) Use new provided resource request and/or response object.

Method Detail

getUserState

UserState getUserState()

Get the current user state.

Returns:

The user state object.

getPortletRequest

PortletRequest getPortletRequest()

Return the current portlet request.

Returns:

The portlet request.

getPortletResponse

PortletResponse getPortletResponse()

Return the current portlet response.

Returns:

The portlet response.

isActionRequest

boolean isActionRequest()

Is this an action request?

Returns:

true if the current request is an action request.

getActionRequest

ActionRequest getActionRequest()

Return the current action request if this is an action request.

Returns:

The action request or null

getActionResponse

ActionResponse getActionResponse()

Return the current action response if this is an action request.

Returns:

The action response or null

update

void update(ActionRequest request,
          ActionResponse response)

Use new provided action request and/or response object. This allows a client to exchange the used request objects with own custom wrappers

Parameters:

request - New request object or null to use the old one.

response - New response object or null to use the old one.

Throws:

java.lang.IllegalStateException - if current request is not an action request.

isRenderRequest

boolean isRenderRequest()

Is this a render request?

Returns:

true if the current request is a render request.

getRenderRequest

RenderRequest getRenderRequest()

Return the current render request if this is a render request.

Returns:

The render request or null

getRenderResponse

RenderResponse getRenderResponse()

Return the current render response if this is a render request.

Returns:

The render response or null

update

void update(RenderRequest request,
          RenderResponse response)

Use new provided render request and/or response object. This allows a client to exchange the used request objects with own custom wrappers

Parameters:

request - New request object or null to use the old one.

response - New response object or null to use the old one.

Throws:

java.lang.IllegalStateException - if current request is not a render request.

isResourceRequest

boolean isResourceRequest()

Is this a resource request?

Returns:

true if the current request is a resource request.

getResourceRequest

ResourceRequest getResourceRequest()

Return the current resource request if this is a resource request.

Returns:

The resource request or null

getResourceResponse

ResourceResponse getResourceResponse()

Return the current resource response if this is a resource request.

Returns:

The resource response or null

update

void update(ResourceRequest request,
          ResourceResponse response)

Use new provided resource request and/or response object. This allows a client to exchange the used request objects with own custom wrappers

Parameters:

request - New request object or null to use the old one.

response - New response object or null to use the old one.

Throws:

java.lang.IllegalStateException - if current request is not a resource request.

isEventRequest

boolean isEventRequest()

Is this an event request?

Returns:

true if the current request is a event request.

Since:

5.4

getEventRequest

EventRequest getEventRequest()

Return the current event request if this is an event request.

Returns:

The event request or null

Since:

5.4

getEventResponse

EventResponse getEventResponse()

Return the current event response if this is an event request.

Returns:

The event response or null

Since:

5.4

update

void update(EventRequest request,
          EventResponse response)

Use new provided event request and/or response object. This allows a client to exchange the used request objects with own custom wrappers

Parameters:

request - New request object or null to use the old one.

response - New response object or null to use the old one.

Throws:

java.lang.IllegalStateException - if current request is not an event request.

Since:

5.4

getAuthenticator

Authenticator getAuthenticator()

Return the authenticator

Since:

5.4

getLocaleHandler

LocaleHandler getLocaleHandler()

Return the locale handler

Since:

5.4

getPrivilegeManager

PrivilegeManager getPrivilegeManager()

Return the privilege manager

Since:

5.4

translate

java.lang.String translate(java.lang.String text)

Translate the message using the current resource bundle of the user.

Since:

5.4

getRequestProgressTracker

RequestProgressTracker getRequestProgressTracker()

Return the request progress tracker

Since:

5.5