com.bea.p13n.usermgmt.taglib
Class RemoveUserTag

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.RemoveUserTag

All Implemented Interfaces:

IterationTag, Serializable, Tag, UserManagementTagConstants

public class RemoveUserTag

extends ResultTag

Corresponds to <ugm:removeUser>.

The <ugm:removeUser> tag removes the user corresponding to the provided username. The tag has no enclosed body.

Tag Attribute	Required	Type	Description
atnProvider	no	String	The name of the authentication provider containing the user. The default provider will be used if not specified. Example: "<%=atnProvider%>"
username	yes	String	The username of the user to be remove. Example: "<%=username%>"
result	yes	String	The name of an Integer variable to which the result of the remove user operation is assigned. Possible Values: Success: UserManagerTagConstants.REMOVE_USER_OK Error encountered: UserManagerTagConstants.REMOVE_USER_FAILED

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

RemoveUserTag()

Method Summary

int	doStartTag() Remove user and its profile
String	getAtnProvider() Get the name of the authentication provider
String	getUsername() Get the name of the user to remove
void	release() Reset the tag's attributes
void	setAtnProvider(String atnProvider) Set the name of the authentication provider
void	setUsername(String s) Set the name of the user to remove

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

RemoveUserTag

public RemoveUserTag()

Method Detail

doStartTag

public int doStartTag()
               throws JspException

Remove user and its profile

Throws:

JspException

getAtnProvider

public String getAtnProvider()

Get the name of the authentication provider

getUsername

public String getUsername()

Get the name of the user to remove

release

public void release()

Reset the tag's 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

setUsername

public void setUsername(String s)

Set the name of the user to remove