atg.servlet.security
Class SecurityDomainServlet

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

All Implemented Interfaces:

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

public class SecurityDomainServlet
extends InsertableServletImpl

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

SecurityDomainServlet()

Method Summary

void	doStartService() Splices this servlet or servlet chain into a servlet pipeline, immediately after the insertAfterServlet.
java.lang.String	getRedirectURL() Returns URL to which the user will be redirected if the user isn't authenticated yet
SecurityDomain[]	getSecurityDomains() Returns List of security domains with which this servlet must authenticated
java.lang.String	getSessionExpiredRedirectURL() Returns URL to which the user will be redirected if the session has expired
UserLoginManager	getUserManager() Returns authentication manager
boolean	isEnabled() Returns Is this servlet enabled inside of the pipline?
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Services a DynamoHttpServletRequest/Response pair.
void	setEnabled(boolean pEnabled) Sets Is this servlet enabled inside of the pipline?
void	setRedirectURL(java.lang.String pRedirectURL) Sets URL to which the user will be redirected if the user isn't authenticated yet
void	setSecurityDomains(SecurityDomain[] pSecurityDomains) Sets List of security domains with which this servlet must authenticated
void	setSessionExpiredRedirectURL(java.lang.String pRedirectURL) Sets URL to which the user will be redirected if the session has expired
void	setUserManager(UserLoginManager pUserManager) Sets authentication manager

Methods inherited from class atg.servlet.pipeline.InsertableServletImpl

getInsertAfterServlet, setInsertAfterServlet

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

Methods inherited from interface atg.servlet.pipeline.PipelineableServlet

getNextServlet, passRequest, setNextServlet

Methods inherited from interface javax.servlet.Servlet

destroy, getServletConfig, getServletInfo, init, service

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class Version String

Constructor Detail

SecurityDomainServlet

public SecurityDomainServlet()

Method Detail

setEnabled

public void setEnabled(boolean pEnabled)

Sets Is this servlet enabled inside of the pipline?

isEnabled

public boolean isEnabled()

Returns Is this servlet enabled inside of the pipline?

setSecurityDomains

public void setSecurityDomains(SecurityDomain[] pSecurityDomains)

Sets List of security domains with which this servlet must authenticated

getSecurityDomains

public SecurityDomain[] getSecurityDomains()

Returns List of security domains with which this servlet must authenticated

setRedirectURL

public void setRedirectURL(java.lang.String pRedirectURL)

Sets URL to which the user will be redirected if the user isn't authenticated yet

getRedirectURL

public java.lang.String getRedirectURL()

Returns URL to which the user will be redirected if the user isn't authenticated yet

setSessionExpiredRedirectURL

public void setSessionExpiredRedirectURL(java.lang.String pRedirectURL)

Sets URL to which the user will be redirected if the session has expired

getSessionExpiredRedirectURL

public java.lang.String getSessionExpiredRedirectURL()

Returns URL to which the user will be redirected if the session has expired

setUserManager

public void setUserManager(UserLoginManager pUserManager)

Sets authentication manager

getUserManager

public UserLoginManager getUserManager()

Returns authentication manager

service

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

Services a DynamoHttpServletRequest/Response pair.

Overrides:

service in class PipelineableServletImpl

Throws:

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

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

doStartService

public void doStartService()
                    throws ServiceException

Description copied from class: InsertableServletImpl

Splices this servlet or servlet chain into a servlet pipeline, immediately after the insertAfterServlet.

Overrides:

doStartService in class InsertableServletImpl

Throws:

ServiceException - if the service had a problem starting up