com.bea.p13n.usermgmt.taglib
Class RemoveUserFromGroupTag

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

All Implemented Interfaces:

IterationTag, Serializable, Tag, UserManagementTagConstants

public class RemoveUserFromGroupTag

extends ResultTag

Corresponds to <ugm:removeUserFromGroup>.

The <ugm:removeUserFromGroup> tag removes the user corresponding to the provided username from the group corresponding to the provided groupName. Both the specified user and the specified group must previously exist for proper tag behavior. 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 from the group. Example: "<%=username%>"
groupName	yes	String	The name of the group from which the user is being removed. Example: "<%=groupName%>"
result	yes	String	The name of an Integer variable to which the result of the remove user from group 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

RemoveUserFromGroupTag()

Method Summary

int	doStartTag() Go through the UserManager session bean to remove the user from the group.
String	getAtnProvider() Get the name of the authentication provider
String	getGroupName() Get the name of the group to remove the user from
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	setGroupName(String groupName) Set the name of the group to remove the user from
void	setUsername(String username) 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

RemoveUserFromGroupTag

public RemoveUserFromGroupTag()

Method Detail

doStartTag

public int doStartTag()

Go through the UserManager session bean to remove the user from the group.

getAtnProvider

public String getAtnProvider()

Get the name of the authentication provider

getGroupName

public String getGroupName()

Get the name of the group to remove the user from

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

setGroupName

public void setGroupName(String groupName)

Set the name of the group to remove the user from

setUsername

public void setUsername(String username)

Set the name of the user to remove