oracle.idm.provisioning.configuration

Class Configuration

java.lang.Object

oracle.idm.provisioning.configuration.Configuration

All Implemented Interfaces:

java.io.Serializable

public class Configuration
extends java.lang.Object
implements java.io.Serializable

This class provides access to the provisioning configuration information. An object of this classs gets

• All registered application in an infra-structure.
• All enabled applications.
• The configuration information pertaining to the Base User.
• Subscriber object of the specified realm.

     Ex.
       ......
       Configuration cfg = new Configuration ("us");
       ....
       // Retrieve all enabled applications
       Vector apps = cfg.getAllApplications();
  

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Configuration(java.lang.String realmName) Constructor to create a configuration object for a given realm.

Method Summary

Modifier and Type	Method and Description
java.util.Vector	getAllApplications(javax.naming.ldap.LdapContext lCtx) Get all enabled applications configured for this realm.
java.util.Vector	getAllApplications(javax.naming.ldap.LdapContext ctx, boolean force) Get all enabled applications configured for this realm.
ConfigAttribute[]	getAllBaseAttrConfig(javax.naming.ldap.LdapContext lCtx) Gets the configuration information pertaining to the "Base User" attributes.
Application	getApplication(javax.naming.ldap.LdapContext ctx, java.lang.String appType, java.lang.String appName) Get a specific application configured for this realm using the given Ldap Context.
java.util.Vector	getInstalledApplications(javax.naming.ldap.LdapContext ctx) Gets all the registered applications in the infra structure.
java.lang.String	getRealmDN() Gets the Realm DN
java.lang.String	getRealmName() Gets the Realm Name.
Subscriber	getSubscriber(javax.naming.ldap.LdapContext lCtx) Gets the Subscriber object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration(java.lang.String realmName)

Constructor to create a configuration object for a given realm.

Parameters:

realmName - Realm Name . Ex "us" or "acme"

Method Detail

getSubscriber

public Subscriber getSubscriber(javax.naming.ldap.LdapContext lCtx)
                         throws java.lang.Exception

Gets the Subscriber object. The realm name specified during this object creation will be used

Parameters:

lCtx - reference to valid a Ldap Context

Throws:

java.lang.Exception

getInstalledApplications

public java.util.Vector getInstalledApplications(javax.naming.ldap.LdapContext ctx)
                                          throws java.lang.Exception

Gets all the registered applications in the infra structure. First time this method is called, the application related configuration will be fetched from the backend. Since this operation is fairly time consuming the result is cached and served for subsequent calls.

Parameters:

ctx - reference to a valid Ldap Context

Returns:

vector containing all the registered applications in the infra structure.

Throws:

java.lang.Exception

getAllApplications

public java.util.Vector getAllApplications(javax.naming.ldap.LdapContext lCtx)
                                    throws java.lang.Exception

Get all enabled applications configured for this realm. Calling this method results in calling getInstalledApplications(LdapContext) but returns only the enabled applications

Parameters:

lCtx - reference to a valid Ldap Context

Returns:

vector containing all the enabled Application object.

Throws:

java.lang.Exception

See Also:

getInstalledApplications(LdapContext), getAllApplications(LdapContext, boolean)

getAllApplications

public java.util.Vector getAllApplications(javax.naming.ldap.LdapContext ctx,
                                           boolean force)
                                    throws java.lang.Exception

Get all enabled applications configured for this realm. Calling this method results in calling getInstalledApplications(LdapContext) but returns only the enabled applications

Parameters:

ctx - reference to a valid Ldap Context

force - true - read afresh into the cache

Returns:

a vector containing all the enabled Application object.

Throws:

java.lang.Exception

See Also:

getInstalledApplications(LdapContext), getAllApplications(LdapContext)

getApplication

public Application getApplication(javax.naming.ldap.LdapContext ctx,
                                  java.lang.String appType,
                                  java.lang.String appName)
                           throws java.lang.Exception

Get a specific application configured for this realm using the given Ldap Context.

Parameters:

ctx - reference to a valid Ldap Context

appType - application type

appName - application name

Returns:

Application object for the specified type and name.

Throws:

java.lang.Exception

See Also:

getInstalledApplications(LdapContext), getAllApplications(LdapContext)

getAllBaseAttrConfig

public ConfigAttribute[] getAllBaseAttrConfig(javax.naming.ldap.LdapContext lCtx)
                                       throws java.lang.Exception

Gets the configuration information pertaining to the "Base User" attributes.

Parameters:

lCtx - reference to a valid Ldap Context

Returns:

ConfigAttribute that describes the base user attribute configuration information.

Throws:

java.lang.Exception

getRealmName

public java.lang.String getRealmName()

Gets the Realm Name.

Returns:

Realm Name

getRealmDN

public java.lang.String getRealmDN()

Gets the Realm DN

Returns:

realm DN