RemoveUserFromGroupTag Class

com.bea.p13n.usermgmt.taglib
RemoveUserFromGroupTag Class

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


Hierarchy
Object
  TagSupport
    UserManagementTag
      ResultTag
        RemoveUserFromGroupTag
All Implemented Interfaces

IterationTag, Serializable, Tag, UserManagementTagConstants

Field Summary

   
Fields from  com.bea.p13n.usermgmt.taglib.ResultTag
result
 
Fields from  javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Fields 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
 

Constructor Summary

RemoveUserFromGroupTag()

 

Method Summary

public int
doStartTag()
Go through the UserManager session bean to remove the user from the group.
public String
getAtnProvider()
Get the name of the authentication provider
public String
getGroupName()
Get the name of the group to remove the user from
public String
getUsername()
Get the name of the user to remove
public void
release()
Reset the tag's attributes
public void
setAtnProvider(String atnProvider)
Set the name of the authentication provider
public void
setGroupName(String groupName)
Set the name of the group to remove the user from
public void
setUsername(String username)
Set the name of the user to remove
 
Methods from  com.bea.p13n.usermgmt.taglib.ResultTag
getResult, setResult
 
Methods from  com.bea.p13n.usermgmt.taglib.UserManagementTag
getAtnManagerProxy, release
 
Methods from  javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   
Methods from interface javax.servlet.jsp.tagext.IterationTag
doAfterBody
 
Methods from interface javax.servlet.jsp.tagext.Tag
doEndTag, doStartTag, getParent, release, setPageContext, setParent
 

Constructor Detail

RemoveUserFromGroupTag

public RemoveUserFromGroupTag()
 

Method Detail

doStartTag() Method

public int doStartTag()
Go through the UserManager session bean to remove the user from the group.

Overrides
TagSupport.doStartTag()

getAtnProvider() Method

public String getAtnProvider()
Get the name of the authentication provider


getGroupName() Method

public String getGroupName()
Get the name of the group to remove the user from


getUsername() Method

public String getUsername()
Get the name of the user to remove


release() Method

public void release()
Reset the tag's attributes

Overrides
ResultTag.release()

setAtnProvider(String) Method

public void setAtnProvider(String atnProvider)
Set the name of the authentication provider


setGroupName(String) Method

public void setGroupName(String groupName)
Set the name of the group to remove the user from


setUsername(String) Method

public void setUsername(String username)
Set the name of the user to remove