|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object TagSupport com.bea.p13n.usermgmt.servlets.jsp.taglib.UserManagementTag com.bea.p13n.usermgmt.servlets.jsp.taglib.ResultTag com.bea.p13n.usermgmt.servlets.jsp.taglib.GetProfileTag
public class GetProfileTag
Corresponds to <um:getProfile>
.
The <um:getProfile>
tag retrieves the
profile corresponding to the provided profile key
and profile type. The tag has no enclosed body. The
retrieved profile can be treated simply as a
,
or can be cast to the particular implementation of
ConfigurableEntity that it is. Along with the profile
key and profile, an explicit successor key and successor
type can be specified, as specified by the profileType
attribute. This successor will then be used, along with
the retrieved profile, in subsequent invocations of the
<um:getProperty>
tag to ensure
property inheritance from the successor. If no successor
is retrieved, standard ConfigurableEntity successor
search patterns will apply to retrieved properties.
Tag Attribute |
Required |
Type |
Description |
profileKey |
yes |
String |
A unique identifier that can be used to retrieve the profile which is sought. Example: " |
profileType |
no |
String |
The profile type to be retrieved. If specified,
this profile type must correspond to a profile
type registered via the Unified Profile Type
tool in the User Management suite of administration
tools, and its bean must conform to the rules of
Unified User Profile creation. Example: "AcmeUser" |
successorKey |
no |
String |
A unique identifier that can be used to retrieve the profile successor. Example: " |
successorType |
no |
String |
The profile successor type to be retrieved.
If specified, this profile type must correspond to
a profile type registered via the Unified Profile
Type tool in the User Management suite of administration
tools, and its bean must conform to the rules of
Unified User Profile creation. Example: "AcmeGroup" |
scope |
no |
String |
The HTTP scope of the retreived profile. Pass
" Defaults to session. |
groupOnly |
no |
String |
Specifies to retrieve a
|
profileId |
no |
String |
A variable name from which the retrieved profile is available for the duration of the JSP's page scope. |
successorId |
no |
String |
A variable name from which the retrieved successor is available for the duration of the JSP's page scope. |
result |
no |
String |
A variable name from which the result of the operation is available. Possible Values:
Informational/Partial Success:
Error encountered: |
Field Summary |
---|
Fields inherited from class com.bea.p13n.usermgmt.servlets.jsp.taglib.ResultTag |
---|
result |
Fields inherited from class com.bea.p13n.usermgmt.servlets.jsp.taglib.UserManagementTag |
---|
GROUP_MGR_REF, USER_MGR_REF |
Fields inherited from interface com.bea.p13n.usermgmt.servlets.jsp.taglib.UserManagementTagConstants |
---|
ADD_GROUP_FAILED, ADD_GROUP_OK, ADD_USER_FAILED, ADD_USER_OK, CREATE_GROUP_FAILED, CREATE_GROUP_OK, CREATE_USER_FAILED, CREATE_USER_OK, DEFAULT_SEARCH_EXP, DEFAULT_USER_LIMIT, GET_PROFILE_FAILED, GET_PROFILE_OK, GROUP_CHANGE_FAILED, GROUP_CHANGE_OK, GROUP_EXISTS, LOGIN_ERROR, LOGIN_FAILED, LOGIN_OK, NO_SUCH_PROFILE, NO_SUCH_SUCCESSOR, REMOVE_GROUP_FAILED, REMOVE_GROUP_OK, REMOVE_USER_FAILED, REMOVE_USER_OK, RESERVED_GROUP_NAME, RESERVED_USER_NAME, SET_PASSWORD_FAILED, SET_PASSWORD_OK, SET_PROPERTY_FAILED, SET_PROPERTY_OK, USER_EXISTS, USER_LIMIT_EXCEEDED, USER_SEARCH_FAILED, USER_SEARCH_OK |
Constructor Summary | |
---|---|
GetProfileTag()
Deprecated |
Method Summary | |
---|---|
int |
doStartTag()
Deprecated Check to see if the profile has already been retrieved; if not, retrieve it and set it in the request or session so that it can be used by the getProperty and setProperty tags. |
String |
getGroupOnly()
Deprecated Get the flag indicating to retrieve a group's profile |
String |
getProfileId()
Deprecated Get the id to assign the retrieved profile to |
String |
getProfileKey()
Deprecated Get the key of the profile to retrieve |
String |
getProfileType()
Deprecated Get the profile type to retrieve |
String |
getScope()
Deprecated Get the scope to use (request or session) |
String |
getSuccessorId()
Deprecated Get the id to assign the retrieved successor to |
String |
getSuccessorKey()
Deprecated Get the key of the successor to retrieve |
String |
getSuccessorType()
Deprecated Get the profile type of the successor to retrieve |
void |
release()
Deprecated Reset the tag's attributes |
void |
setGroupOnly(String s)
Deprecated Set the flag indicating to retrieve a group's profile |
void |
setProfileId(String s)
Deprecated Set the id to assign the retrieved profile to |
void |
setProfileKey(String s)
Deprecated Set the key of the profile to retrieve |
void |
setProfileType(String s)
Deprecated Set the profile type to retrieve |
void |
setScope(String s)
Deprecated Set the scope to use (request or session) |
void |
setSuccessorId(String s)
Deprecated Set the id to assign the retrieved successor to |
void |
setSuccessorKey(String s)
Deprecated Set the key of the successor to retrieve |
void |
setSuccessorType(String s)
Deprecated Set the profile type of the successor to retrieve |
Methods inherited from class com.bea.p13n.usermgmt.servlets.jsp.taglib.ResultTag |
---|
getResult, setResult |
Methods inherited from class com.bea.p13n.usermgmt.servlets.jsp.taglib.UserManagementTag |
---|
getGroupManager, getUserManager |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetProfileTag()
Method Detail |
---|
public int doStartTag() throws JspException
JspException
public void release()
release
in class ResultTag
public String getProfileId()
public void setProfileId(String s)
public String getSuccessorId()
public void setSuccessorId(String s)
public String getProfileKey()
public void setProfileKey(String s)
public String getSuccessorKey()
public void setSuccessorKey(String s)
public String getGroupOnly()
public void setGroupOnly(String s)
public String getProfileType()
public void setProfileType(String s)
public String getSuccessorType()
public void setSuccessorType(String s)
public String getScope()
public void setScope(String s)
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |