Fires a content event if a user has the appropriate Principal (identity).
Class Name |
|
|---|---|
Component |
|
Required Input Parameters
type
Set to one of the following four values:
userorganizationrolerelativeroleprofilegroup
Optional Input Parameters
id
The identity to look up. The value you specify depends on the value of the type parameter:
user: the login name of the user—for example,MGarciaorganization: the path and organization name. For example:AnyCorps
/AnyCorps
/AnyCorps/someOrganizationrole: the path and a global role name. For example:admin/admin/admin/networkAdminrelativerole: the organization name and functional role name separated by a backslash (/). For example:Accounting/VicePresident
You can find a path for an organization or a global role by looking in the ACC People and Organizations task area. For example, you can find all global roles in the People and Organizations task area, under the Roles option. By expanding the Global Roles tree option, you can navigate to each role by traversing its path.
Notice that id values can have a leading slash, but one is not required.
Open Parameters
output
Rendered if the identity check is successful.
default
Rendered if the identity check fails.
unknown
Rendered if the user has no known identity.
Usage Notes
HasEffectivePrincipal checks whether a user has a specified identity and renders content based on the result of its query. For example, you can check if the user has a specific principal (identity), if the user is a member of a specified organization, or if the user has a specified role, and you can set this servlet bean to render that information.
Example
HasEffectivePrincipal determines whether the current user is assigned the role of Administrator.
<dsp:droplet name="/atg/dynamo/droplet/HasEffectivePrincipal"> <dsp:param name="type" value="role"/> <dsp:param name="id" value="Administrator"/> <dsp:oparam name="output"> You are an administrator<p> </dsp:oparam> <dsp:oparam name="default"> You are not an administrator<p> </dsp:oparam> <dsp:oparam name="unknown"> You are not logged in<p> </dsp:oparam> </dsp:droplet>
