com.beasys.commerce.axiom.contact
Interface RealmConfiguration

public interface RealmConfiguration

extends javax.ejb.EJBObject

This is the public interface for configuring the underlying Realm.

Field Summary

static java.lang.String

DEFAULT_REALM the name of the default realm class

Method Summary

java.lang.String	cleanupMisconfiguredUsers() Removes misconfigured users (those found in the database but not in the realm) from the database.
java.util.ArrayList	getAllDBGroups() Returns all the groups that are in the database.
java.util.ArrayList	getAllRealmGroups() Returns all the groups that exist in LDAP.
int	getConfiguredGroupCount() Returns a count of the LDAP groups configured for personalization user.
int	getConfiguredUserCount() Returns a count of the realm users configured for personalization use.
java.util.ArrayList	getDBUsers() Returns just the users found in the database.
java.lang.String[]	getMisconfiguredUsers() Returns the usernames that exist in the database, but not in the realm.
java.lang.String	getRealmClassName() Returns the name of the security realm class being used.
java.util.ArrayList	getRealmUsers() Returns just the users from the Realm.
boolean	isDefaultRealm() Determines if the system is running in the default RDBMSRealm
void	registerGroup(java.lang.String groupName) Adds the necessary entries in the database for the group to start being used in the system.
void	unregisterGroup(java.lang.String groupName) Removes all relevant entries for a group from the database.
boolean	useRealmForGroups() Determines if the realm should be solely responsible for group information (rather than WLPS managed tables).

Methods inherited from interface javax.ejb.EJBObject

getEJBHome, getHandle, getPrimaryKey, isIdentical, remove

Field Detail

DEFAULT_REALM

public static final java.lang.String DEFAULT_REALM

the name of the default realm class

Method Detail

getConfiguredUserCount

public int getConfiguredUserCount()
                           throws java.rmi.RemoteException,
                                  UserManagementException

Returns a count of the realm users configured for personalization use.

Returns:

a count of the realm users configured for personalization use

Throws:

UserManagementException - group count error

RemoteException - general error

getMisconfiguredUsers

public java.lang.String[] getMisconfiguredUsers()
                                         throws java.rmi.RemoteException,
                                                UserManagementException

Returns the usernames that exist in the database, but not in the realm.

Returns:

the usersnames for the users that are misconfigured

Throws:

UserManagementException - user find error

RemoteException - general error

cleanupMisconfiguredUsers

public java.lang.String cleanupMisconfiguredUsers()
                                           throws java.rmi.RemoteException,
                                                  UserManagementException

Removes misconfigured users (those found in the database but not in the realm) from the database.

Returns:

a status message for the operation

Throws:

UserManagementException - error cleaning up users

RemoteException - general error

getRealmUsers

public java.util.ArrayList getRealmUsers()
                                  throws java.rmi.RemoteException,
                                         UserManagementException

Returns just the users from the Realm.

Returns:

a list of usernames returned from the realm

Throws:

UserManagementException - error accessing realm

RemoteException - general error

getDBUsers

public java.util.ArrayList getDBUsers()
                               throws java.rmi.RemoteException,
                                      UserManagementException

Returns just the users found in the database.

Returns:

a list of usernames in the database

Throws:

UserManagementException - error accessing the database

RemoteException - general error

getConfiguredGroupCount

public int getConfiguredGroupCount()
                            throws java.rmi.RemoteException,
                                   UserManagementException

Returns a count of the LDAP groups configured for personalization user.

Throws:

UserManagementException - group count error

RemoteException - general error

getAllRealmGroups

public java.util.ArrayList getAllRealmGroups()
                                      throws java.rmi.RemoteException,
                                             UserManagementException

Returns all the groups that exist in LDAP.

Throws:

RemoteException - general error

UserManagementException - LDAP error

getAllDBGroups

public java.util.ArrayList getAllDBGroups()
                                   throws java.rmi.RemoteException,
                                          UserManagementException

Returns all the groups that are in the database.

Throws:

RemoteException - general error

UserManagementException - LDAP error

registerGroup

public void registerGroup(java.lang.String groupName)
                   throws java.rmi.RemoteException,
                          UserManagementException

Adds the necessary entries in the database for the group to start being used in the system.

Parameters:

groupName - the name of the group to register

Throws:

RemoteException - general error

UserManagementException - DB related error

unregisterGroup

public void unregisterGroup(java.lang.String groupName)
                     throws java.rmi.RemoteException,
                            UserManagementException

Removes all relevant entries for a group from the database.

Parameters:

groupName - the name of the group to unregister

Throws:

RemoteException - general error

UserManagementException - DB related error

getRealmClassName

public java.lang.String getRealmClassName()
                                   throws java.rmi.RemoteException

Returns the name of the security realm class being used.

Returns:

the name of the security realm class being used

isDefaultRealm

public boolean isDefaultRealm()
                       throws java.rmi.RemoteException

Determines if the system is running in the default RDBMSRealm

Returns:

true if the default realm is being used

useRealmForGroups

public boolean useRealmForGroups()
                          throws java.rmi.RemoteException

Determines if the realm should be solely responsible for group information (rather than WLPS managed tables). This will return true if the property commerce.usermgmt.useRealmForGroups is set to "true", and the default RDBMSRealm is not being used.

Returns:

true if group info should only come from the realm