oracle.dss.security
Interface UserCommunityProvider

public interface UserCommunityProvider

The interface for the pluggable user community driver. An application must implement this interface if the application requires a user community. You can plug in a custom user community using external community stores such as LDAP.

You register an implemention of the pluggable user community driver by using the BI Beans configuration file. The use of pluggable user community drivers with a BI Beans application is optional.

A pluggable user community driver is required in order for the getAllUsers method to function properly. The BI Beans provides a default implementation of the user community driver. The getAllUsers method of the default driver lists the users from the BI Beans Catalog.

Method Summary

java.util.Vector	getAllUsers() Retrieves the list of users in a user community.
void	init(java.util.Hashtable a_parameters) Initializes the user community based on a table of parameters.
void	uninitialize() Uninitializes the user community.

Method Detail

init

public void init(java.util.Hashtable a_parameters)
          throws BISecurityException

Initializes the user community based on a table of parameters. You must implement this method if you want the application to use pluggable user community drivers.

Parameters:

a_parameters - The hash table of parameters that the application sets.

Throws:

BISecurityException - if the method fails.

getAllUsers

public java.util.Vector getAllUsers()
                             throws BISecurityException

Retrieves the list of users in a user community. You must implement this method if you want the application to use pluggable user community drivers.

Returns:

A vector of objects of either type UserImpl (which represents a user) or type GroupImpl (which represents a group in the community store).

Throws:

BISecurityException - if the method fails.

See Also:

UserImpl, GroupImpl

uninitialize

public void uninitialize()
                  throws BISecurityException

Uninitializes the user community. You must implement this method if you want the application to use pluggable user community drivers.

Throws:

BISecurityException - if the method fails.