UserManagementTag
Corresponds to <ugm:getUsernames>
.
The <ugm:getUsernames>
tag retrieves a String array
that contains the usernames matching the provided search expression.
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 users. The default provider will be used if not specified. Example: " |
searchExp |
no |
String |
The search expression to apply to the user name search. 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: " |
Object
TagSupport
UserManagementTag
GetUserNamesTag
IterationTag
, Serializable
, Tag
, UserManagementTagConstants
Field Summary |
Fields from javax.servlet.jsp.tagext. |
id, pageContext |
Fields from interface javax.servlet.jsp.tagext. |
EVAL_BODY_AGAIN |
Fields from interface javax.servlet.jsp.tagext. |
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE |
Constructor Summary |
Method Summary |
public int |
|
public |
|
public |
|
public |
|
public int |
|
public void |
|
public void |
|
public void | |
public void |
|
public void |
|
public void |
|
Methods from com.bea.p13n.usermgmt.taglib. |
|
Methods from javax.servlet.jsp.tagext. |
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue |
Methods from class java.lang. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods from interface javax.servlet.jsp.tagext. |
doAfterBody |
Methods from interface javax.servlet.jsp.tagext. |
doEndTag, doStartTag, getParent, release, setPageContext, setParent |
Constructor Detail |
public GetUserNamesTag()
Method Detail |
public int doStartTag()Go through the UserManager session bean to run the user search.
TagSupport.doStartTag()
public String
getAtnProvider()
Get the name of the authentication provider
public String
getResult()
Get the name of the variable to assign the result to
public String
getSearchExp()
Get the search expression
public int getUserLimit()Get the limit of the result-set size
public void release()Reset the tag's attributes
UserManagementTag.release()
public void setAtnProvider(String
atnProvider)
Set the name of the authentication provider
public void setResult(String
result)
Set the name of the variable to assign the result to
public void setSearchExp(String
searchExp)
Set the search expression
public void setUserLimit(String
userLimit)
Set the limit of the result-set size
public void setUserLimit(int userLimit)Set the limit of the result-set size