|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.nucleus.TimedOperationService atg.nucleus.servlet.ServletService atg.nucleus.servlet.HttpServletService atg.servlet.DynamoServlet atg.droplet.ContextAffectingDropletImpl atg.droplet.multisite.SiteContextDroplet
public class SiteContextDroplet
The SiteContextDroplet wraps the output in the context of a particular site.
The given siteId
is pushed to the SiteContextManager
before the output
oparam is serviced and then popped afterward.
If emptySite
is set to true, the siteId
param is
ignored and an empty site context is pushed. The siteContext
parameter is set with the context that was pushed. If the the
siteId
parameter is null or there is a problem pushing the site
context, the error
oparam will be serviced and the
errorMessage
set.
The output parameters for this Droplet are:
siteId
is null.
SiteContext
object for the given
siteId
Nested Class Summary |
---|
Nested classes/interfaces inherited from class atg.droplet.ContextAffectingDropletImpl |
---|
atg.droplet.ContextAffectingDropletImpl.TestContextAffectingDroplet |
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
static ParameterName |
EMPTY_SITE
ParameterName for emptySite |
static ParameterName |
ERROR
ParameterName for error |
static java.lang.String |
ERROR_MSG_PROP_NAME
Parameter name for errorMessage |
static ParameterName |
OUTPUT
ParameterName for output |
static java.lang.String |
SITE_CONTEXT_PROP_NAME
Parameter name for siteContext |
static ParameterName |
SITE_ID
ParameterName for siteId |
Fields inherited from class atg.servlet.DynamoServlet |
---|
mAllowCleanupRequest, mParameters |
Fields inherited from class atg.nucleus.servlet.ServletService |
---|
SERVLET_INFO_KEY |
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.droplet.ContextAffectingDroplet |
---|
ATTRIBUTE_BEFORE_CONTENT_RESULT |
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 | |
---|---|
SiteContextDroplet()
|
Method Summary | |
---|---|
void |
afterContent(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse,
java.lang.Object pBeforeContentResult,
boolean pServiceThrewException)
Pops the SiteContext from the SiteContextManager for the given site if it was pushed by the beforeContent method. |
java.lang.Object |
beforeContent(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
|
void |
doService(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse,
java.lang.Object pBeforeContentResult)
Services the error parameter if
pBeforeContentResult is the static null place holder object. |
SiteContextManager |
getSiteContextManager()
Gets the SiteContextManager. |
void |
setSiteContextManager(SiteContextManager pSiteContextManager)
Sets the SiteContextManager |
Methods inherited from class atg.droplet.ContextAffectingDropletImpl |
---|
service |
Methods inherited from class atg.servlet.DynamoServlet |
---|
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, service, service, setParameter |
Methods inherited from class atg.nucleus.servlet.ServletService |
---|
destroy, getServletConfig, getServletInfo, init, setServletInfo |
Methods inherited from class atg.nucleus.TimedOperationService |
---|
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics |
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, toString, wait, wait, wait |
Methods inherited from interface javax.servlet.Servlet |
---|
destroy, getServletConfig, getServletInfo, init, service |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
public static final ParameterName SITE_ID
public static final ParameterName EMPTY_SITE
public static final ParameterName OUTPUT
public static final ParameterName ERROR
public static final java.lang.String ERROR_MSG_PROP_NAME
public static final java.lang.String SITE_CONTEXT_PROP_NAME
Constructor Detail |
---|
public SiteContextDroplet()
Method Detail |
---|
public SiteContextManager getSiteContextManager()
public void setSiteContextManager(SiteContextManager pSiteContextManager)
pSiteContextManager
- the siteContextManager to setpublic void afterContent(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, java.lang.Object pBeforeContentResult, boolean pServiceThrewException)
beforeContent
method.
afterContent
in interface atg.droplet.ContextAffectingDroplet
afterContent
in class atg.droplet.ContextAffectingDropletImpl
pRequest
- The DynamoHttpServletRequestpResponse
- The DynamoHttpServletResponsepBeforeContentResult
- The SiteContext that was pushed. A static null
place holder object is passed if no SiteContext was pushed.atg.droplet.ContextAffectingDropletImpl#afterContent(atg.servlet.DynamoHttpServletRequest,
atg.servlet.DynamoHttpServletResponse, java.lang.Object)
public java.lang.Object beforeContent(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException
beforeContent
in interface atg.droplet.ContextAffectingDroplet
beforeContent
in class atg.droplet.ContextAffectingDropletImpl
pRequest
- The DynamoHttpServletRequestpResponse
- The DynamoHttpServletResponse
javax.servlet.ServletException
ContextAffectingDropletImpl.beforeContent(atg.servlet.DynamoHttpServletRequest,
atg.servlet.DynamoHttpServletResponse)
public void doService(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, java.lang.Object pBeforeContentResult) throws javax.servlet.ServletException, java.io.IOException
error
parameter if
pBeforeContentResult
is the static null place holder object.
Services output
otherwise.
doService
in class atg.droplet.ContextAffectingDropletImpl
pRequest
- The DynamoHttpServletRequestpResponse
- The DynamoHttpServletResponsepBeforeContentResult
- The SiteContext that was pushed. A static null
place holder object is passed if no SiteContext was pushed.
javax.servlet.ServletException
java.io.IOException
ContextAffectingDropletImpl.doService(atg.servlet.DynamoHttpServletRequest,
atg.servlet.DynamoHttpServletResponse, java.lang.Object)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |