atg.service.jaxrs

Class JAXRSCacheResponseFilter

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.service.jaxrs.JAXRSCacheResponseFilter

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class JAXRSCacheResponseFilter
extends GenericService

An implementation of a Jersey container response filter. This filter will release locks, handle response caching and any other post-response actions.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected LinkUtils	mLinkUtils
protected atg.service.jaxrs.RestLockService	mRestLockService
protected atg.servlet.StateManager	mStateManager property: stateManager
protected static java.lang.String	WWW_AUTHENTICATE_HEADER

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
JAXRSCacheResponseFilter()

Method Summary

Modifier and Type	Method and Description
void	addLinks(RepresentationModel pModel) Add the links into the response object.
void	filter(ContainerRequestContext pRequestCtx, ContainerResponseContext pResponseCtx) Called by Jersey to allow any manipulation of the response or post-response activity.
LinkUtils	getLinkUtils() Returns the LinkUtils
atg.service.jaxrs.RestLockService	getRestLockService() Get the restLockService.
atg.servlet.StateManager	getStateManager() Returns the state manager.
void	setLinkUtils(LinkUtils pLinkUtils) Set the LinkUtils
void	setRestLockService(atg.service.jaxrs.RestLockService pRestLockService) Set the restLockService.
void	setStateManager(atg.servlet.StateManager pStateManager) Sets the state manager.

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

WWW_AUTHENTICATE_HEADER

protected static final java.lang.String WWW_AUTHENTICATE_HEADER

See Also:

Constant Field Values

mRestLockService

protected atg.service.jaxrs.RestLockService mRestLockService

mLinkUtils

protected LinkUtils mLinkUtils

mStateManager

protected atg.servlet.StateManager mStateManager

property: stateManager

Constructor Detail

JAXRSCacheResponseFilter

public JAXRSCacheResponseFilter()

Method Detail

getRestLockService

public atg.service.jaxrs.RestLockService getRestLockService()

Get the restLockService. Used to handle locking for the request.

Returns:

the restLockSrevice

setRestLockService

public void setRestLockService(atg.service.jaxrs.RestLockService pRestLockService)

Set the restLockService. Used to handle locking for the request.

Parameters:

pRestLockService - the restLockSrevice

getLinkUtils

public LinkUtils getLinkUtils()

Returns the LinkUtils

Returns:

the link utils class to hanlde the links

setLinkUtils

public void setLinkUtils(LinkUtils pLinkUtils)

Set the LinkUtils

Parameters:

pLinkUtils - the utils class containing methods to handle link generation

getStateManager

public atg.servlet.StateManager getStateManager()

Returns the state manager. The state manager used to write any state data to the response.

Returns:

the state manager.

setStateManager

public void setStateManager(atg.servlet.StateManager pStateManager)

Sets the state manager. The state manager used to write any state data to the response.

Parameters:

pStateManager - the state manager.

filter

public void filter(ContainerRequestContext pRequestCtx,
                   ContainerResponseContext pResponseCtx)
            throws java.io.IOException

Called by Jersey to allow any manipulation of the response or post-response activity. This implementation will release locks, cache the response, and handle any other actions required post-response.

Parameters:

pRequestCtx - the request context

pResponseCtx - the response context

Throws:

java.io.IOException

addLinks

public void addLinks(RepresentationModel pModel)

Add the links into the response object. Note, for member and embedded models their 'self' link must already be set correctly before this method is invoked.

Parameters:

pModel - the representation model object