oracle.sdp.messaging.userprefs
Class UserPrefsManager

java.lang.Object
  oracle.sdp.messaging.userprefs.UserPrefsManager

public class UserPrefsManager
extends java.lang.Object

This is the main entry point class that is used to create the reference to the appropriate factory. The factory is used to create the userprefs extension objects for the base IDM user.

Method Summary

static UserPrefsServices	createUserPrefsServices() This method instantiates the appropriate factory implementation based on the configuration provided in the "jndi.properties" file found in the CLASSPATH.
static UserPrefsServices	createUserPrefsServices(Hashtable properties) This method creates UserPrefsServices using the specified properties (e.g.
static UserPrefsServices	createUserPrefsServicesLocal()
static UserPrefsServices	createUserPrefsServicesLocal(Hashtable properties) This method creates UserPrefsServicesLocal using the specified properties (e.g.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createUserPrefsServices

public static UserPrefsServices createUserPrefsServices()
                                                 throws java.lang.IllegalArgumentException,
                                                        UserPrefsException

This method instantiates the appropriate factory implementation based on the configuration provided in the "jndi.properties" file found in the CLASSPATH.

Returns:

A handle to the main user preferences interface instance

Throws:

UserPrefsException - if the attempt to obtain handle to the main preferences interface instance failed

java.lang.IllegalArgumentException

createUserPrefsServices

public static UserPrefsServices createUserPrefsServices(Hashtable properties)
                                                 throws java.lang.IllegalArgumentException,
                                                        UserPrefsException

This method creates UserPrefsServices using the specified properties (e.g. containing jndiContext).

Parameters:

properties - - values used for creating the UserPrefsServices. If the value of properties is null, then a default initial context, based on jndi.properties file present in the classpath, is created.

Returns:

UserPrefsServices

Throws:

java.lang.IllegalArgumentException

UserPrefsException

createUserPrefsServicesLocal

public static UserPrefsServices createUserPrefsServicesLocal()
                                                      throws java.lang.IllegalArgumentException,
                                                             UserPrefsException

Returns:

A (local) handle to the main user preferences interface instance. This method is recommended to be used if used from inside the deployment

Throws:

UserPrefsException - if the attempt to obtain handle to the main preferences interface instance has failed

java.lang.IllegalArgumentException

createUserPrefsServicesLocal

public static UserPrefsServices createUserPrefsServicesLocal(Hashtable properties)
                                                      throws java.lang.IllegalArgumentException,
                                                             UserPrefsException

This method creates UserPrefsServicesLocal using the specified properties (e.g. containing jndiContext).

Parameters:

properties - - values used for creating the UserPrefsServices. If the value of properties is null, then a default initial context, based on jndi.properties file present in the classpath, is created.

Returns:

UserPrefsServices

Throws:

java.lang.IllegalArgumentException

UserPrefsException