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

## com.bea.p13n.usermgmt.taglib
Class AddUserToGroupTag

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

All Implemented Interfaces:
  IterationTag, Serializable, Tag, UserManagementTagConstants

public class AddUserToGroupTag
extends ResultTag

Corresponds to `<ugm:addUserToGroup>`.

The `<ugm:addUserToGroup>` tag adds the user corresponding to the provided `username` to the group corresponding to the provided `parentGroupName`. 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 to which the user will be added. The default provider will be used if not specified. Example: "`<%=atnProvider%>`"
username | yes | String | The name of the user to be added to the group. Example: "`<%=username%>`"
groupName | yes | String | The name of the group to which the user is being added. Example: "`<%=groupName%>`"
result | yes | String | The name of an Integer variable to which the result of the add user to group operation is assigned. Possible values: Success: `UserManagerTagConstants.ADD_USER_OK` Error Encountered: `UserManagerTagConstants.ADD_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
`AddUserToGroupTag()`

Method Summary
`int` | `doStartTag()` Adds the specified user to the specified group through the UserManager session bean.
`String` | `getAtnProvider()` Get the name of the authentication provider
`String` | `getGroupName()` Get the name of the group to add the user to
`String` | `getUsername()` Get the name of the user to add to the group
`void` | `release()` Reset all the tag attributes
`void` | `setAtnProvider(String atnProvider)` Set the name of the authentication provider
`void` | `setGroupName(String groupName)` Set the name of the group to add the user to
`void` | `setUsername(String username)` Set the name of the user to add to the group

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

### AddUserToGroupTag

    public AddUserToGroupTag()

Method Detail

### doStartTag

    public int doStartTag()

  Adds the specified user to the specified group through the UserManager session bean.

### getAtnProvider

    public String getAtnProvider()

  Get the name of the authentication provider

### getGroupName

    public String getGroupName()

  Get the name of the group to add the user to

### getUsername

    public String getUsername()

  Get the name of the user to add to the group

### release

    public void release()

  Reset all the 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

### setGroupName

    public void setGroupName(String groupName)

  Set the name of the group to add the user to

### setUsername

    public void setUsername(String username)

  Set the name of the user to add to the group

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

Copyright © 2004 BEA Systems, Inc. All Rights Reserved