atg.userdirectory.droplet
Class UserListDroplet

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.nucleus.TimedOperationService
              extended by atg.nucleus.servlet.ServletService
                  extended by atg.nucleus.servlet.HttpServletService
                      extended by atg.servlet.DynamoServlet
                          extended by atg.userdirectory.droplet.UserListDroplet
All Implemented Interfaces:
NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, ParameterServlet, atg.userdirectory.droplet.Constants, java.util.EventListener, javax.servlet.Servlet

public class UserListDroplet
extends DynamoServlet
implements atg.userdirectory.droplet.Constants

This Droplet is used to retrieve a list of User Principals for a particular Organization whose organizationId is passed in as an input parameter. If the users could be retrieved, then the "users" parameter is rendered in the "output" output parameter.

The following properties will typically be set in a properties file

userDirectory
This is the location of the userDirectory component in the Dynamo environment. This component is used to retrieve the Principals.

The following properties will typically be set in a jhtml file

organizationId
This is the repository Id for the organization.

The following output parameters are supported for this droplet

output
This parameter is serviced if the Principals could be retrieved for the specified user. The list of users can be referenced using the "users" output parameter.
error
This parameter is serviced if an error had occured while retrieving the Principals for the specific user.
empty
This parameter is serviced if there are no users for the specified organization.

See Also:
RepositoryUserDirectory

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
static ParameterName EXCLUDE_ID
           
static ParameterName ORGANIZATION_ID
           
static java.lang.String USERS
          The param representing the users for the passed in org id
 
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.userdirectory.droplet.Constants
EMPTY, ERROR, INVALID_OPTIONAL_PARAM, MISSING_REQUIRED_PARAM, NO_ORGANIZATION, NO_USER, OUTPUT
 
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
UserListDroplet()
           
 
Method Summary
 UserDirectory getUserDirectory()
          Gets the userDirectory property
 void service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
          This service method will attempt to get the user list for the organizationId parameter of the passed in request.
 void setUserDirectory(UserDirectory pUserDirectory)
          Sets the userDirectory property
 
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, 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


ORGANIZATION_ID

public static final ParameterName ORGANIZATION_ID

EXCLUDE_ID

public static final ParameterName EXCLUDE_ID

USERS

public static final java.lang.String USERS
The param representing the users for the passed in org id

See Also:
Constant Field Values
Constructor Detail

UserListDroplet

public UserListDroplet()
Method Detail

setUserDirectory

public void setUserDirectory(UserDirectory pUserDirectory)
Sets the userDirectory property

Parameters:
pUserDirectory - the userdirectory to perform on

getUserDirectory

public UserDirectory getUserDirectory()
Gets the userDirectory property

Returns:
the userdirectory to perform on

service

public void service(DynamoHttpServletRequest pRequest,
                    DynamoHttpServletResponse pResponse)
             throws javax.servlet.ServletException,
                    java.io.IOException
This service method will attempt to get the user list for the organizationId parameter of the passed in request.

The following oparams will be rendered accordingly: