atg.servlet.security
Class CurrentUser

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.servlet.security.CurrentUser

All Implemented Interfaces:

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

public class CurrentUser
extends DynamoServlet

This Servlet provides the current top level personae authenticated with the given UserAuthority. Useful in Admin-like applications for UI purposes.

Example:

;
  <droplet name="CurrentUser">
    <oparam name="output">
        <valueof param="username"></valueof>
    </oparam>
    <oparam name="empty">
       User not logged in
    </oparam>
    <oparam name="error">
       Droplet Mis-configured: check logs
    </oparam>
 </droplet>
 

Field Summary

static java.lang.String	CLASS_VERSION
static ParameterName	EMPTY
static ParameterName	ERROR
static ParameterName	OUTPUT
static java.lang.String	USER_NAME

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

CurrentUser()

Method Summary

UserAuthority	getUserAuthority() Returns User Authority with which the user must be authenticated
UserLoginManager	getUserManager() Returns User Manager to get the top level Persona from
java.lang.String	getUsername() Returns The login name to render
void	service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Render Top Level Personae associated with the current User in the current Session
void	setUserAuthority(UserAuthority pUserAuthority) Sets User Authority with which the user must be authenticated
void	setUserManager(UserLoginManager pUserManager) Sets User Manager to get the top level Persona from
void	setUsername(java.lang.String pUsername) Sets The login name to render

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.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, 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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

OUTPUT

public static final ParameterName OUTPUT

ERROR

public static final ParameterName ERROR

EMPTY

public static final ParameterName EMPTY

USER_NAME

public static final java.lang.String USER_NAME

See Also:

Constant Field Values

Constructor Detail

CurrentUser

public CurrentUser()

Method Detail

setUserAuthority

public void setUserAuthority(UserAuthority pUserAuthority)

Sets User Authority with which the user must be authenticated

getUserAuthority

public UserAuthority getUserAuthority()

Returns User Authority with which the user must be authenticated

setUserManager

public void setUserManager(UserLoginManager pUserManager)

Sets User Manager to get the top level Persona from

getUserManager

public UserLoginManager getUserManager()

Returns User Manager to get the top level Persona from

setUsername

public void setUsername(java.lang.String pUsername)

Sets The login name to render

getUsername

public java.lang.String getUsername()

Returns The login name to render

service

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

Render Top Level Personae associated with the current User in the current Session

Overrides:

service in class DynamoServlet

Parameters:

pRequest - the request to be processed

pResponse - the response object for this request

Throws:

javax.servlet.ServletException - an application specific error occurred processing this request

java.io.IOException - an error occurred reading data from the request or writing data to the response.