atg.userdirectory.droplet
Class TargetPrincipalsDroplet
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.TargetPrincipalsDroplet
- All Implemented Interfaces:
- NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, ParameterServlet, atg.userdirectory.droplet.Constants, java.util.EventListener, javax.servlet.Servlet
public class TargetPrincipalsDroplet
- extends DynamoServlet
- implements atg.userdirectory.droplet.Constants
This Droplet extends the PrincipalsDroplet to retrieve a list of
Targeted Principals for a specific Principal associated with the user.
Specifically, for the role function is passed as a parameter, the list
of organizations which have the specified function associated with
the user's roles are returned.
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 jhtml file
- userId
- This is the repository Id for the user whose Principals
are to be retrieved.
- roleName
- This is the String representing the function name of a role.
All organizations with this function name will be retrieved.
The following output parameters are supported for this droplet
- output
- This parameter is serviced if the Principals could be
retrieved for the specified user
- error
- This parameter is serviced if an error had occured while
retrieving the Principals for the specific user
- empty
- This parameter is serviced if no roles were
found for that particular role name
- 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, 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
ROLE_NAME
public static final ParameterName ROLE_NAME
USER_ID
public static final ParameterName USER_ID
PRINCIPALS
public static final java.lang.String PRINCIPALS
- See Also:
- Constant Field Values
TargetPrincipalsDroplet
public TargetPrincipalsDroplet()
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
- Gets the userId and roleName request parameters and does the
following:
1) Gets the relative roles associated with the user
2) Gets the target principal of each role (organization) and
returns them in the principals parameter
- Overrides:
service
in class DynamoServlet
- Parameters:
pRequest
- the request to examinepResponse
- the response associated with the request
- Throws:
javax.servlet.ServletException
- if a servlet error occurs
java.io.IOException
- if an io error occurs