public class ViewPrincipalsDroplet extends DynamoServlet implements atg.userdirectory.droplet.Constants
The following properties will typically be set in a properties file
The following properties will typically be set in a JSP page
The following output parameters are supported for this droplet
Example:
<dsp:droplet name="ViewPrincipals"> <dsp:param name="userId" bean="Profile.id"/> <dsp:param name="principalType" value="organization"/> <dsp:oparam name="output"> <dsp:droplet name="ForEach"> <dsp:param name="array" param="principals"/> <dsp:oparam name="output"> <br /><dsp:valueof param="element">null</dsp:valueof> </dsp:oparam> </dsp:droplet> </dsp:oparam> <dsp:oparam name="error"> <br />error </dsp:oparam> <dsp:oparam name="empty"> <br />empty </dsp:oparam> </dsp:droplet>
RepositoryUserDirectory
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
DEFAULT_PRINCIPAL |
static ParameterName |
PRINCIPAL_TYPE |
static java.lang.String |
PRINCIPALS |
static java.lang.String |
ROLE_PRINCIPAL |
static ParameterName |
USER_ID |
static java.lang.String[] |
VALID_PRINCIPALS |
mAllowCleanupRequest, mParameters
SERVLET_INFO_KEY
SERVICE_INFO_KEY
EMPTY, ERROR, INVALID_OPTIONAL_PARAM, MISSING_REQUIRED_PARAM, NO_ORGANIZATION, NO_USER, OUTPUT
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
ViewPrincipalsDroplet() |
Modifier and Type | Method and Description |
---|---|
UserDirectory |
getUserDirectory()
Gets the userDirectory property
|
void |
service(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
This method services the request and returns the desired principles.
|
void |
setUserDirectory(UserDirectory pUserDirectory)
Sets the userDirectory property
|
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter
destroy, getServletConfig, getServletInfo, setServletInfo
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, 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, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
public static final java.lang.String PRINCIPALS
public static final ParameterName PRINCIPAL_TYPE
public static final ParameterName USER_ID
public static final java.lang.String DEFAULT_PRINCIPAL
public static final java.lang.String ROLE_PRINCIPAL
public static final java.lang.String[] VALID_PRINCIPALS
public void setUserDirectory(UserDirectory pUserDirectory)
pUserDirectory
- the userdirectory to perform onpublic UserDirectory getUserDirectory()
public void service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
userId
parameter and an
optional principal
parameter.
If principalType
is not defined via the request,
or is an invalid value i.e. not one of ROLE_PRINCIPAL
or
ORGANIZATION_PRINCIPAL
, then we default to
DEFAULT_PRINCIPLE
.
If the userId
parameter
is not defined, or the {@link atg.userdirectory.UserUser
corresponding to the passed in id cannot be found, then the
error
oparam is serviced
If no principals are found of the requested type for the
requested user, then the empty
oparam will be serviced
service
in class DynamoServlet
pRequest
- the request used to get/set parameterspResponse
- the response associated with pRequest
javax.servlet.ServletException
- if a servlet error occursjava.io.IOException
- if an io error occurs