|
© 2005 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.servlet.jsp.tagext.TagSupport com.bea.p13n.usermgmt.taglib.UserManagementTag com.bea.p13n.usermgmt.taglib.GetUserNamesForGroupTag
Corresponds to <ugm:getUsernamesForGroup>
.
The <ugm:getUsernamesForGroup>
tag retrieves a String
array that contains the usernames matching the provided search
expression and correspond to members of the provided group.
The search expression supports only the asterisk (*) wildcard
character, and is case insensitive. As many asterisks as desired
may be used in the search expression. The tag has no enclosed body.
The limit parameter will control how many results are returned; if the number of results returned equals the limit passed in, try refining the search.
Tag Attribute |
Required |
Type |
Description |
atnProvider |
no |
String |
The name of the authentication provider containing the group. The default provider will be used if not specified. Example: " |
searchExp |
no |
String |
The search expression to apply to the user name search. Example: " |
groupName |
yes |
String |
The name of the group whose matching members are sought. Example: " |
userLimit |
no |
String (representing an Integer) |
The maximum number of users to be returned from the search.
(String which has a particular Example: " |
id |
yes |
String |
A variable name to which the resultant user names are assigned. Example: "myUsers" |
result |
no |
String |
A variable name to which a constant describing the outcome of the operation will be assigned that can later be evaluated to see if the operation was successful. Possible Values:
Error encountered: Example: " |
Field Summary |
Fields inherited from class javax.servlet.jsp.tagext.TagSupport |
id, pageContext |
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag |
EVAL_BODY_AGAIN |
Fields inherited from interface javax.servlet.jsp.tagext.Tag |
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE |
Constructor Summary | |
GetUserNamesForGroupTag()
|
Method Summary | |
int |
doStartTag()
Go through the UserManager session bean to retrieve the usernames |
String |
getAtnProvider()
Get the name of the authentication provider |
String |
getGroupName()
Get the name of the group to query |
String |
getResult()
Get the name of the variable to assign the result to |
String |
getSearchExp()
Get the search expression |
int |
getUserLimit()
Get the limit of users to return |
void |
release()
Reset the tag's attributes |
void |
setAtnProvider(String atnProvider)
Set the name of the authentication provider |
void |
setGroupName(String groupName)
Set the name of the group to query |
void |
setResult(String result)
Set the name of the variable to assign the result to |
void |
setSearchExp(String searchExp)
Set the search expression |
void |
setUserLimit(int userLimit)
Set the limit of users to return |
void |
setUserLimit(String userLimit)
Set the limit of users to return |
Methods inherited from class com.bea.p13n.usermgmt.taglib.UserManagementTag |
getAtnManagerProxy |
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public GetUserNamesForGroupTag()
Method Detail |
public int doStartTag()
public String getAtnProvider()
public String getGroupName()
public String getResult()
public String getSearchExp()
public int getUserLimit()
public void release()
release
in interface Tag
release
in class UserManagementTag
public void setAtnProvider(String atnProvider)
public void setGroupName(String groupName)
public void setResult(String result)
public void setSearchExp(String searchExp)
public void setUserLimit(int userLimit)
public void setUserLimit(String userLimit)
|
© 2005 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |