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

public class GetTopLevelGroupsTag
extends `UserManagementTag`

Corresponds to `<ugm:getTopLevelGroups>`.

The `<ugm:getTopLevelGroups>` tag retrieves an array of groups, each of which has no parent group. The information reflects the group hierarchy information as set up from the Group administration and Realm Configuration administration tools. The tag has no enclosed body.

Tag Attribute | Required | Type | Description
atnProvider | no | String | The name of the authentication provider containing the groups. The default provider will be used if not specified. Example: "`<%=atnProvider%>`"
id | yes | String | A variable name to which the top-level Group objects are available for the duration of the page's scope. Example: "topLevelGroups"

Hierarchy
  `Object`
  `TagSupport`
  `UserManagementTag`
  `GetTopLevelGroupsTag`

All Implemented Interfaces
  `IterationTag`, `Serializable`, `Tag`, `UserManagementTagConstants`

## Field Summary

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

GetTopLevelGroupsTag()

## Method Summary

`public int` | `doStartTag`() Go through the UserManager session bean to retrieve a list of top level groups.
`public `String`` | `getAtnProvider`() Get the name of the authentication provider
`public void` | `release`() Reset the tag attributes
`public void` | `setAtnProvider`(`String` atnProvider) Set the name of the authentication provider

Methods from `com.bea.p13n.usermgmt.taglib.`UserManagementTag``
``getAtnManagerProxy`,`

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

### GetTopLevelGroupsTag

    public GetTopLevelGroupsTag()

## Method Detail

### doStartTag() Method

    public int doStartTag()
         throws JspException

Go through the UserManager session bean to retrieve a list of top level groups.

Overrides
  `TagSupport.doStartTag()`

#### Exceptions

``JspException``

### getAtnProvider() Method

    public String getAtnProvider()

Get the name of the authentication provider

### release() Method

    public void release()

Reset the tag attributes

Overrides
  `UserManagementTag.release()`

### setAtnProvider(String) Method

    public void setAtnProvider(String atnProvider)

Set the name of the authentication provider