atg.service.jaxrs

Class JAXRSCacheWriterInterceptor

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.service.jaxrs.JAXRSCacheWriterInterceptor

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 JAXRSCacheWriterInterceptor
extends GenericService

An implementation of a Jersey writer interceptor.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	HTTP_HEADER_EXPIRES
protected atg.service.jaxrs.RestCleanupService	mRestCleanupService property: restCleanupService
protected java.lang.String[]	mServletHeadersToCopy property: servletHeadersToCopy
protected atg.servlet.StateManager	mStateManager property: stateManager

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
JAXRSCacheWriterInterceptor()

Method Summary

Modifier and Type	Method and Description
void	aroundWriteTo(WriterInterceptorContext pCtx) Called by Jersey to allow wrapping the output stream.
protected void	cacheResponse(RestContext pRestContext, java.lang.String pOutputString) Caches the response string.
atg.service.jaxrs.ETagService	getETagService() Get ETagService.
atg.service.payloadschema.filter.FilteringManager	getFilteringManager() Gets the filtering manager
atg.service.jaxrs.RestCleanupService	getRestCleanupService() Returns the restCleanupService property.
atg.service.jaxrs.RestLockService	getRestLockService() Get the restLockService.
java.lang.String[]	getServletHeadersToCopy() Returns an array of string header names that should be copied from the servlet response to the container response context.
atg.servlet.StateManager	getStateManager() Returns the state manager.
void	setETagService(atg.service.jaxrs.ETagService pETagService) Set ETagService.
void	setFilteringManager(atg.service.payloadschema.filter.FilteringManager pFilteringManager) Sets the filtering manager
void	setRestCleanupService(atg.service.jaxrs.RestCleanupService pRestCleanupService) Sets the restCleanupService property.
void	setRestLockService(atg.service.jaxrs.RestLockService pRestLockService) Set the restLockService.
void	setServletHeadersToCopy(java.lang.String[] pServletHeadersToCopy) Sets an array of string header names that should be copied from the servlet response to the container response context.
void	setStateManager(atg.servlet.StateManager pStateManager) Sets the state manager.

Methods inherited from class atg.nucleus.GenericService

addLogListener, clearAbsoluteNameAndContext, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, isStartServiceComplete, 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

HTTP_HEADER_EXPIRES

public static final java.lang.String HTTP_HEADER_EXPIRES

See Also:

Constant Field Values

mRestCleanupService

protected atg.service.jaxrs.RestCleanupService mRestCleanupService

property: restCleanupService

mStateManager

protected atg.servlet.StateManager mStateManager

property: stateManager

mServletHeadersToCopy

protected java.lang.String[] mServletHeadersToCopy

property: servletHeadersToCopy

Constructor Detail

JAXRSCacheWriterInterceptor

public JAXRSCacheWriterInterceptor()

Method Detail

setETagService

public void setETagService(atg.service.jaxrs.ETagService pETagService)

Set ETagService. The ETagService used for ETag operations.

Parameters:

pETagService - the ETagService

getETagService

public atg.service.jaxrs.ETagService getETagService()

Get ETagService. The ETagService used for ETag operations.

Returns:

the ETagService

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

getRestCleanupService

public atg.service.jaxrs.RestCleanupService getRestCleanupService()

Returns the restCleanupService property. The rest cleanup service that will be invoked to perform cleanup tasks at the end of the rest request pipeline.

Returns:

teh rest cleanup service

setRestCleanupService

public void setRestCleanupService(atg.service.jaxrs.RestCleanupService pRestCleanupService)

Sets the restCleanupService property. The rest cleanup service that will be invoked to perform cleanup tasks at the end of the rest request pipeline.

Parameters:

pRestCleanupService - the rest cleanup service

getFilteringManager

public atg.service.payloadschema.filter.FilteringManager getFilteringManager()

Gets the filtering manager

Returns:

the filtering manager

setFilteringManager

public void setFilteringManager(atg.service.payloadschema.filter.FilteringManager pFilteringManager)

Sets the filtering manager

Parameters:

pFilteringManager - new filtering manager

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.

getServletHeadersToCopy

public java.lang.String[] getServletHeadersToCopy()

Returns an array of string header names that should be copied from the servlet response to the container response context.

Returns:

the array of header names to copy.

setServletHeadersToCopy

public void setServletHeadersToCopy(java.lang.String[] pServletHeadersToCopy)

Sets an array of string header names that should be copied from the servlet response to the container response context.

Parameters:

pServletHeadersToCopy - the array of header names to copy.

aroundWriteTo

public void aroundWriteTo(WriterInterceptorContext pCtx)
                   throws java.io.IOException,
                          WebApplicationException

Called by Jersey to allow wrapping the output stream.

Parameters:

pCtx - the interceptor context

Throws:

java.io.IOException

WebApplicationException

cacheResponse

protected void cacheResponse(RestContext pRestContext,
                             java.lang.String pOutputString)

Caches the response string. Add the output string to the representation cache.

Parameters:

pRestContext - the current rest context.

pOutputString - the output string for the request.