atg.servlet.security
Class ThreadUserBinderServlet

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.nucleus.TimedOperationService
              atg.servlet.pipeline.PipelineableServletImpl
                  atg.servlet.security.ThreadUserBinderServlet

All Implemented Interfaces:

NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, PipelineableServlet, java.util.EventListener, javax.servlet.Servlet

public class ThreadUserBinderServlet
extends PipelineableServletImpl

A pipeline servlet that associates the current session's User object with the current request thread. This effectively assigns a user identity to a request so that secured systems that are called by the thread know who they're dealing with.

This needs to appear in the servlet pipeline AFTER session resolution and anything that performs authentication and BEFORE anything that needs security information.

Note that this servlet is deliberately destructive; if an identity has already been bound, it will have been unbound when this service completes. This is an extra bit of insurance against dangling identities.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

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

ThreadUserBinderServlet()

Method Summary

java.lang.String	getUserComponentName() Returns the name of the User object in the request session.
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Services a DynamoHttpServletRequest/Response pair
void	setUserComponentName(java.lang.String pName) Changes the name of the User object in the request session.

Methods inherited from class atg.servlet.pipeline.PipelineableServletImpl

createAdminServlet, destroy, getAdminServlet, getNextServlet, getServletConfig, getServletInfo, init, isUsePathInfo, passRequest, passRequest, service, service, setNextServlet, setServletInfo, setUsePathInfo

Methods inherited from class atg.nucleus.TimedOperationService

getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics

Methods inherited from class atg.nucleus.GenericService

addLogListener, doStartService, doStopService, getAbsoluteName, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, 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, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ThreadUserBinderServlet

public ThreadUserBinderServlet()

Method Detail

getUserComponentName

public java.lang.String getUserComponentName()

Returns the name of the User object in the request session.

setUserComponentName

public void setUserComponentName(java.lang.String pName)

Changes the name of the User object in the request session.

service

public void service(DynamoHttpServletRequest pRequest,
                    DynamoHttpServletResponse pResponse)
             throws java.io.IOException,
                    javax.servlet.ServletException

Description copied from class: PipelineableServletImpl

Services a DynamoHttpServletRequest/Response pair

Overrides:

service in class PipelineableServletImpl

Throws:

java.io.IOException - if an error occurred while reading or writing the servlet request

javax.servlet.ServletException - if an error occurred while processing the servlet request