atg.userdirectory.droplet
Class UserListDroplet
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.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
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 |
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 |
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
UserListDroplet
public UserListDroplet()
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:
- ERROR - if the
ORGANIZATION_ID
request
parameter is not set, or if it refers to a
non-existant organization
- EMPTY - if the user list for the desired organization is
null or empty
- OUTPUT - if there is a non-null user list for the
desired organization with > 0 users
- Overrides:
service
in class DynamoServlet
- Parameters:
pRequest
- the request to examinepResponse
- a DynamoHttpServletResponse
value
- Throws:
javax.servlet.ServletException
- if a servlet error occurs
java.io.IOException
- if an io problem occurs