Overview  Package   Class  Tree  Deprecated  Index  Help 
BEA Systems, Inc.
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.beasys.commerce.user.jsp.tags
Class GetUserNamesTag

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--com.beasys.commerce.user.jsp.tags.UserManagerTag
              |
              +--com.beasys.commerce.user.jsp.tags.GetUserNamesTag
All Implemented Interfaces:
SchemaManagerConstants, java.io.Serializable, javax.servlet.jsp.tagext.Tag, UserManagementConstants, UserManagerTagConstants
public class GetUserNamesTag
extends UserManagerTag

Corresponds to <um:getUsernames>.

The <um: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.

Note: This tag should only be invoked when the weblogic.security.realmClass property in the weblogic.properties file is com.beasys.commerce.axiom.contact.security.RDBMSRealm.

Tag Attribute

Required

Type

Description

searchExp

no

String

The search expression to apply to the user name search.
Defaults to "*".

Example: "t*"

userLimit

no

String (representing an Integer)

The maximum number of users to be returned from the search. (String which has a particular Integer.valueOf)
Defaults to 100.

Example: "500"

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:
Success:
UserManagerTagConstants.USER_SEARCH_OK

Matching user count exceeds limit:
UserManagerTagConstants.USER_LIMIT_EXCEEDED

Error encountered:
UserManagerTagConstants.USER_SEARCH_FAILED

Example: "if(result.intValue() == UserManagerTagConstants.USER_SEARCH_OK) // proceed"

See Also:
Serialized Form

Fields inherited from class com.beasys.commerce.user.jsp.tags.UserManagerTag
printStackTraces, verbose
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface com.beasys.commerce.user.jsp.tags.UserManagerTagConstants
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, PROFILE_SUCCESSOR_UID, PROFILE_USER_UID, REMOVE_GROUP_FAILED, REMOVE_GROUP_OK, REMOVE_USER_FAILED, REMOVE_USER_OK, RESERVED_GROUP_NAME, RESERVED_USER_NAME, SERVLET_AUTHENTICATION, SET_PASSWORD_FAILED,
Fields inherited from interface com.beasys.commerce.axiom.contact.UserManagementConstants
ANONYMOUS_PROFILE, CACHED_PROFILE, DEFAULT_SCOPE, DEFAULT_SUCCESSOR, DEFAULT_SUCCESSOR_HOME, DEFAULT_SUCCESSOR_JNDI, DEFAULT_SUCCESSOR_PK, DEFAULT_USER, DEFAULT_USER_HOME, DEFAULT_USER_JNDI, DEFAULT_USER_PK, GROUP, GROUP_ENTITY_HOME, PROFILE_MGR, PROFILE_SUCCESSOR, PROFILE_USER, REALM_CONFIG, RESERVED_SCOPE, USER, USER_ENTITY_HOME, USER_MGR
 
Fields inherited from interface com.beasys.commerce.foundation.property.SchemaManagerConstants
APPLICATION_INIT_TYPE, CATALOG_TYPE, CONTENT_TYPE, REQUEST_TYPE, SCHEMA, SCHEMA_GROUPS, SESSION_TYPE, USER_TYPE
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
GetUserNamesTag()
           
 
Method Summary
 int doStartTag()
          Go through the UserManager session bean to run the user search.
 java.lang.String getResult()
          Get the name of the variable to assign the result to
 java.lang.String getSearchExp()
          Get the search expression
 int getUserLimit()
          Get the limit of the result-set size
 void release()
          Reset the tag's attributes
 void setResult(java.lang.String result)
          Set the name of the variable to assign the result to
 void setSearchExp(java.lang.String searchExp)
          Set the search expression
 void setUserLimit(int userLimit)
          Set the limit of the result-set size
 void setUserLimit(java.lang.String userLimit)
          Set the limit of the result-set size
 
Methods inherited from class com.beasys.commerce.user.jsp.tags.UserManagerTag
getUserManager
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
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

GetUserNamesTag

public GetUserNamesTag()
Method Detail

release

public void release()
Reset the tag's attributes
Overrides:
release in class javax.servlet.jsp.tagext.TagSupport

doStartTag

public int doStartTag()
Go through the UserManager session bean to run the user search.
Overrides:
doStartTag in class javax.servlet.jsp.tagext.TagSupport

getUserLimit

public int getUserLimit()
Get the limit of the result-set size

setUserLimit

public void setUserLimit(java.lang.String userLimit)
Set the limit of the result-set size

setUserLimit

public void setUserLimit(int userLimit)
Set the limit of the result-set size

getSearchExp

public java.lang.String getSearchExp()
Get the search expression

setSearchExp

public void setSearchExp(java.lang.String searchExp)
Set the search expression

getResult

public java.lang.String getResult()
Get the name of the variable to assign the result to

setResult

public void setResult(java.lang.String result)
Set the name of the variable to assign the result to
Overview  Package   Class  Tree  Deprecated  Index  Help 
BEA Systems, Inc.
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2000 BEA Systems, Inc. All Rights Reserved