Skip navigation links

Oracle Internet Directory API Reference
10g(10.1.4)

B15992-01


oracle.ldap.util
Class RootOracleContext

java.lang.Object
  extended byoracle.ldap.util.LDAPEntry
      extended byoracle.ldap.util.OracleContext
          extended byoracle.ldap.util.RootOracleContext

All Implemented Interfaces:
java.io.Serializable

public final class RootOracleContext
extends OracleContext

This class represents the Root Oracle Context in the directory. It allows for the creation of additional realms and retrieval of Subscriber objects representing a particular realm in the directory.

See Also:
Serialized Form

Field Summary
static java.lang.String rootOracleContextDN
          The default distinguished name (DN) of the Root Oracle Context

 

Fields inherited from class oracle.ldap.util.OracleContext
oracleContextCN, oracleContextObjClass, oracleContextRDN

 

Constructor Summary
RootOracleContext(javax.naming.directory.DirContext inCtx)
           Construct an instance of RootOracleContext.
RootOracleContext(javax.naming.directory.DirContext inCtx, java.lang.String inOhome)
          Constructs an instance of RootOracleContext.
RootOracleContext(javax.naming.directory.DirContext inCtx, java.lang.String inOhome, java.io.PrintStream pStream)
           Constructs an instance of RootOracleContext.

 

Method Summary
 Subscriber createSubscriber(javax.naming.directory.DirContext ctx, java.lang.String simpleName, boolean withAux)
           Creates a new subscriber using the specified simpleName under the subscriber search base.
 Subscriber[] getAllSubscribers(javax.naming.directory.DirContext ctx, java.lang.String[] attrList)
           Returns an array of all the Subscriber(s) under the subscriber search base along with the attribute values specified in attrList.
 Subscriber[] getAllSubscribers(javax.naming.directory.DirContext ctx, java.lang.String filter, java.lang.String[] attrList)
          Returns an array of Subscriber objects under the subscriber search base.
 Subscriber getSubscriber(javax.naming.directory.DirContext ctx, int inSubIdType, java.lang.String inSubIdName, java.lang.String[] attrList)
          Returns the Subscriber with the specified information.

 

Methods inherited from class oracle.ldap.util.OracleContext
create, exists, getCommonProperties, getDBCompatibilityVersion, getOracleContext, getOracleContext, getVersion, getVersion, refresh, resolve, resolve, upgrade

 

Methods inherited from class oracle.ldap.util.LDAPEntry
getDN, getProperties, setProperties

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

rootOracleContextDN

public static final java.lang.String rootOracleContextDN
The default distinguished name (DN) of the Root Oracle Context
See Also:
Constant Field Values

Constructor Detail

RootOracleContext

public RootOracleContext(javax.naming.directory.DirContext inCtx,
                         java.lang.String inOhome)
Constructs an instance of RootOracleContext.
Parameters:
inCtx - a valid DirContext
inOhome - the absolute path of ORACLE_HOME

RootOracleContext

public RootOracleContext(javax.naming.directory.DirContext inCtx,
                         java.lang.String inOhome,
                         java.io.PrintStream pStream)

Constructs an instance of RootOracleContext. The PrintStream redirects the standard output and can be used for logging purpose

Parameters:
inCtx - a valid DirContext
inOhome - the absolute path of ORACLE_HOME
pStream - the PrintStream where the output is pushed to

RootOracleContext

public RootOracleContext(javax.naming.directory.DirContext inCtx)

Construct an instance of RootOracleContext. If this RootOracleContext is to be used for realm creation, the constructor with the $ORACLE_HOME parameter should be used

Parameters:
inCtx - a valid DirContext

Method Detail

getAllSubscribers

public Subscriber[] getAllSubscribers(javax.naming.directory.DirContext ctx,
                                      java.lang.String filter,
                                      java.lang.String[] attrList)
                               throws UtilException
Returns an array of Subscriber objects under the subscriber search base.
Parameters:
filter - a valid LDAP search filter to refine the search criteria. For example, "acme*". If null, then no filter is used.
attrList - the list of attributes to be returned for each subscriber
Throws:
UtilException

getAllSubscribers

public Subscriber[] getAllSubscribers(javax.naming.directory.DirContext ctx,
                                      java.lang.String[] attrList)
                               throws UtilException

Returns an array of all the Subscriber(s) under the subscriber search base along with the attribute values specified in attrList.

Parameters:
ctx - a valid DirContext
attrList - the list of attributes to be returned for each subscriber
Throws:
UtilException

createSubscriber

public Subscriber createSubscriber(javax.naming.directory.DirContext ctx,
                                   java.lang.String simpleName,
                                   boolean withAux)
                            throws UtilException

Creates a new subscriber using the specified simpleName under the subscriber search base.

User and group containers are auxiliary items. By default, they are created immediately under the subscriber DN.

For example, if the subscriber is "dc=acme,dc=com", then "cn=Users,dc=acme,dc=com" will be the User container and set as the user search base for this subscriber.

Similarly, the group container will be "cn=groups,dc=acme,dc=com" and is set the group search base for this subscriber.

If you do not wish to create these auxiliary containers, set withAux to false.

Parameters:
simpleName - a valid simple name for the subscriber.
withAux - set to true if you wish to create the auxiliary user and group container.
Returns:
a valid Subscriber corresponding to the newly created subscriber.
Throws:
UtilException

getSubscriber

public Subscriber getSubscriber(javax.naming.directory.DirContext ctx,
                                int inSubIdType,
                                java.lang.String inSubIdName,
                                java.lang.String[] attrList)
                         throws UtilException
Returns the Subscriber with the specified information. An attribute list of the subscriber can be specified and the values values will be cached in the Subscriber.
Parameters:
ctx - a valid DirContext
inSubIdType - The type of subscriber id being used - Use Util.IDTYPE_DN if the DN value is used; use Util.IDTYPE_SIMPLE if a simple name is used; use UTIL.IDTYPE_GUID if the GUID is used; use Util.IDTYPE_DEFAULT if the default subscriber is desired
inSubIdName - Subscriber ID - this value can be null ONLY if inSubIdType is Util.IDTYPE_DEFAULT. Otherwise, a null will cause an exception
attrList - a list of attributes to be looked up when fetching subscriber information
Throws:
UtilException

Skip navigation links

Oracle Internet Directory API Reference
10g(10.1.4)

B15992-01


Copyright © 1999, 2006 Oracle. All Rights Reserved.