# com.bea.p13n.controls.ejb.usermgmt
RealmConfiguration Interface

public interface RealmConfiguration
extends `Control`

* This is the public interface for keeping personalization profile records in sync with the WLS realm.

This control requires that the RealmConfiguration EJB has been deployed to the application. The RealmConfiguration EJB is contained in p13n_ejb.jar, and is automatically deployed as part of a Portal application.
Security requirements: The caller must be in the role of "PortalSystemAdministrator" to invoke these methods

All Superinterfaces
  `Control`, `Control`, `Serializable`

## Method Summary

`public void` | `cleanupMisconfiguredGroups`() Removes misconfigured groups (those found in the database but not in the realm) from the database.
`public void` | `cleanupMisconfiguredUsers`() Removes misconfigured users (those found in the database but not in the realm) from the database.
`public `String`[]` | `getGroupProfileNames`() Returns just the groups found in the database.
`public `String`[]` | `getMisconfiguredGroups`() Returns the group names that exist in the database, but not in the realm.
`public `String`[]` | `getMisconfiguredUsers`() Returns the usernames that exist in the database, but not in the realm.
`public `String`[]` | `getRealmGroups`() Get a list of groups in the realm Caller must be in the role of PortalSystemAdminstrator
`public `String`[]` | `getRealmUsers`() Get a list of groups in the realm Caller must be in the role of PortalSystemAdminstrator
`public `String`[]` | `getUserProfileNames`() Returns just the users found in the database.
`public boolean` | `isManageableRealm`() Determine if the current realm is writable.

## Method Detail

### cleanupMisconfiguredGroups() Method

    public void cleanupMisconfiguredGroups()
         throws P13nControlException

Removes misconfigured groups (those found in the database but not in the realm) from the database. Caller must be in the role of PortalSystemAdminstrator

#### Returns

a status message for the operation

#### Exceptions

``P13nControlException``
  if errors cleaning up groups, or if caller is not in allowed role

### cleanupMisconfiguredUsers() Method

    public void cleanupMisconfiguredUsers()
         throws P13nControlException

Removes misconfigured users (those found in the database but not in the realm) from the database. Caller must be in the role of PortalSystemAdminstrator

#### Returns

a status message for the operation

#### Exceptions

``P13nControlException``
  if errors cleaning up users, or if caller is not in allowed role

### getGroupProfileNames() Method

    public String[] getGroupProfileNames()
         throws P13nControlException

Returns just the groups found in the database. Caller must be in the role of PortalSystemAdminstrator

#### Returns

a list of groups in the database

#### Exceptions

``P13nControlException``
  if errors accessing the database, or if caller is not in allowed role

### getMisconfiguredGroups() Method

    public String[] getMisconfiguredGroups()
         throws P13nControlException

Returns the group names that exist in the database, but not in the realm. Caller must be in the role of PortalSystemAdminstrator

#### Returns

the names for the groups that are misconfigured

#### Exceptions

``P13nControlException``
  if user find error, or if caller is not in allowed role

### getMisconfiguredUsers() Method

    public String[] getMisconfiguredUsers()
         throws P13nControlException

Returns the usernames that exist in the database, but not in the realm. Caller must be in the role of PortalSystemAdminstrator

#### Returns

the usersnames for the users that are misconfigured

#### Exceptions

``P13nControlException``
  if user find error, or if caller is not in allowed role

### getRealmGroups() Method

    public String[] getRealmGroups()
         throws P13nControlException

Get a list of groups in the realm Caller must be in the role of PortalSystemAdminstrator

#### Exceptions

``P13nControlException``
  if error accessing realm, or if caller is not in allowed role

### getRealmUsers() Method

    public String[] getRealmUsers()
         throws P13nControlException

Get a list of groups in the realm Caller must be in the role of PortalSystemAdminstrator

#### Exceptions

``P13nControlException``
  if error accessing realm, or if caller is not in allowed role

### getUserProfileNames() Method

    public String[] getUserProfileNames()
         throws P13nControlException

Returns just the users found in the database. Caller must be in the role of PortalSystemAdminstrator

#### Returns

a list of usernames in the database

#### Exceptions

``P13nControlException``
  if errors accessing the database, or if caller is not in allowed role

### isManageableRealm() Method

    public boolean isManageableRealm()
         throws P13nControlException

Determine if the current realm is writable. Caller must be in the role of PortalSystemAdminstrator

#### Returns

true if it is, false otherwise.

#### Exceptions

``P13nControlException``
  if runtime errors, or if caller is not in allowed role