com.bea.p13n.usermgmt.taglib
Class CreateUserTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      com.bea.p13n.usermgmt.taglib.UserManagementTag
          com.bea.p13n.usermgmt.taglib.ResultTag
              com.bea.p13n.usermgmt.taglib.CreateUserTag

All Implemented Interfaces:

IterationTag, Serializable, Tag, UserManagementTagConstants

public class CreateUserTag

extends ResultTag

Corresponds to <ugm:createUser>.

The <ugm:createUser> tag creates a new useer with the specified name and sets the user's password to the given password. If the saveAnonymous attribute is "true", and an AnonymousProfile exists, any properties defined in the AnonymousProfile will be set for the new user. The tag has no enclosed body.

Tag Attribute	Required	Type	Description
atnProvider	no	String	The name of the authentication provider in which the user will be created. The default provider will be used if not specified. Example: "<%=atnProvider%>"
username	yes	String	The name of the new user. Example: "<%=username%>"
password	no	String	The password for the new user. Example: "<%=password%>"
doPostProcess	no	String	Whether to do the post-user-creation process as an all-or-nothing operation. Unless the default tag attributes 'saveAnonymous', 'login', and 'fireEvent' (all are true) are overridden, ALL will be performed if 'doPostProcess' is true, and NONE will be performed if 'doPostProcess' is false. If any of the tag attributes 'saveAnonymous', 'login', and 'fireEvent' are overridden, 'doPostProcess' is ignored, and those attributes settings take precedence. See javadocs in com.bea.p13n.usermgmt.SessionHelper.postCreateUser() for more details on what happens during postProcessing. Defaults to true. Example: "false"
saveAnonymous	no	String	Whether to persist current anonymous user profile attributes in the newly-created user's profile during the post-user-creation process. Defaults to true. Example: "false"
fireEvent	no	String	Whether to fire a UserRegistrationEvent when the user is created during the post-user-creation process. Defaults to true. Example: "false"
login	no	String	Whether to login the user during the post-user-creation process. Defaults to true. Example: "false"
result	yes	String	The name of an Integer variable to which the result of the create user operation is assigned. Possible values: Success: UserManagerTagConstants.CREATE_USER_OK Error Encountered: UserManagerTagConstants.CREATE_USER_FAILED A user with the specified username already exists: UserManagerTagConstants.USER_EXISTS

See Also:

Serialized Form

Field Summary

Fields inherited from class com.bea.p13n.usermgmt.taglib.ResultTag

result

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface com.bea.p13n.usermgmt.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

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

CreateUserTag()

Method Summary

int	doStartTag() Create a User through the UserManager session bean, and optionally transfer properties from an AnonymousProfile to the new User.
String	getAtnProvider() Get the name of the authentication provider
String	getDoPostProcess() Get the flag to do the post-user-creation process.
String	getFireEvent() Get the flag to fire a UserRegistrationEvent
String	getLogin() Get the flag to do the login during post-user-creation process.
String	getPassword() Get the password of the new user
String	getSaveAnonymous() Get the flag to transfer the AnonymousProfile to the new user
String	getUsername() Get the name of the new user
void	release() Reset all tag attributes
void	setAtnProvider(String atnProvider) Set the name of the authentication provider
void	setDoPostProcess(String s) Set the flag to do the post-user-creation process.
void	setFireEvent(String s) Set the flag to fire a UserRegistrationEvent
void	setLogin(String s) Set the flag to do the login during post-user-creation process.
void	setPassword(String s) Set the password of the new user
void	setSaveAnonymous(String s) Set the flag to transfer the AnonymousProfile to the new user
void	setUsername(String s) Set the name of the new user

Methods inherited from class com.bea.p13n.usermgmt.taglib.ResultTag

getResult, setResult

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

CreateUserTag

public CreateUserTag()

Method Detail

doStartTag

public int doStartTag()
               throws JspException

Create a User through the UserManager session bean, and optionally transfer properties from an AnonymousProfile to the new User.

Throws:

JspException

getAtnProvider

public String getAtnProvider()

Get the name of the authentication provider

getDoPostProcess

public String getDoPostProcess()

Get the flag to do the post-user-creation process.

getFireEvent

public String getFireEvent()

Get the flag to fire a UserRegistrationEvent

getLogin

public String getLogin()

Get the flag to do the login during post-user-creation process.

getPassword

public String getPassword()

Get the password of the new user

getSaveAnonymous

public String getSaveAnonymous()

Get the flag to transfer the AnonymousProfile to the new user

getUsername

public String getUsername()

Get the name of the new user

release

public void release()

Reset all tag attributes

Specified by:

release in interface Tag

Overrides:

release in class ResultTag

setAtnProvider

public void setAtnProvider(String atnProvider)

Set the name of the authentication provider

setDoPostProcess

public void setDoPostProcess(String s)

Set the flag to do the post-user-creation process.

setFireEvent

public void setFireEvent(String s)

Set the flag to fire a UserRegistrationEvent

setLogin

public void setLogin(String s)

Set the flag to do the login during post-user-creation process.

setPassword

public void setPassword(String s)

Set the password of the new user

setSaveAnonymous

public void setSaveAnonymous(String s)

Set the flag to transfer the AnonymousProfile to the new user

setUsername

public void setUsername(String s)

Set the name of the new user