Oracle Internet Directory API Reference
10g(10.1.2)

B14083-02


oracle.ldap.util
Class OracleContext

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

Direct Known Subclasses:
RootOracleContext

public class OracleContext
extends LDAPEntry

This class represents an Oracle Context in the directory


Field Summary
static java.lang.String oracleContextCN
the common name (CN) of an Oracle Context
static java.lang.String oracleContextObjClass
the ldap objectClass for the oracle context
static java.lang.String oracleContextRDN
the relative distinguished name (RDN) of an Oracle Context

Constructor Summary
OracleContext(javax.naming.directory.DirContext inCtx, java.lang.String inOrclCtxDN)
Constructs an OracleContext specified by the input DN

Method Summary
boolean exists(javax.naming.directory.DirContext ctx)
Returns true if the Oracle Context exists
static java.lang.String[] getOracleContext(javax.naming.directory.DirContext ctx)
Returns a String[] of DNs of all the Oracle Contexts in the directory.
static java.lang.String[] getOracleContext(javax.naming.directory.DirContext ctx, java.lang.String baseDN)
Returns a String[] of DNs of all the Oracle Contexts in the directory under the specified base DN.
java.lang.String getVersion(javax.naming.directory.DirContext ctx)
Returns the version of this Oracle Context
boolean isUpToDate(javax.naming.directory.DirContext ctx)
Returns true if this Oracle Context is up to date with the current client version.
void resolve(javax.naming.directory.DirContext ctx)
Resolves the OracleContext object by validating the DN.

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

oracleContextCN

public static final java.lang.String oracleContextCN
the common name (CN) of an Oracle Context
See Also:
Constant Field Values

oracleContextRDN

public static final java.lang.String oracleContextRDN
the relative distinguished name (RDN) of an Oracle Context
See Also:
Constant Field Values

oracleContextObjClass

public static final java.lang.String oracleContextObjClass
the ldap objectClass for the oracle context
See Also:
Constant Field Values

Constructor Detail

OracleContext

public OracleContext(javax.naming.directory.DirContext inCtx,
                     java.lang.String inOrclCtxDN)
Constructs an OracleContext specified by the input DN
Parameters:
inCtx - a valid DirContext
inOrclCtxDN - the DN of the OracleContext

Method Detail

exists

public boolean exists(javax.naming.directory.DirContext ctx)
Returns true if the Oracle Context exists
Returns:
true if the Oracle Context exists

resolve

public void resolve(javax.naming.directory.DirContext ctx)
             throws UtilException
Resolves the OracleContext object by validating the DN. Certain properties are cached by the OracleContext object.
Specified by:
resolve in class LDAPEntry
Throws:
UtilException

getVersion

public java.lang.String getVersion(javax.naming.directory.DirContext ctx)
                            throws UtilException
Returns the version of this Oracle Context
Parameters:
ctx - - Directory Context
Throws:
UtilException
CommunicationErrorException - - an error occurrs while contacting LDAP server

getOracleContext

public static java.lang.String[] getOracleContext(javax.naming.directory.DirContext ctx)
                                           throws UtilException
Returns a String[] of DNs of all the Oracle Contexts in the directory. ctx - Directory Context
Throws:
UtilException
CommunicationErrorException - - an error occurrs while contacting LDAP server

getOracleContext

public static java.lang.String[] getOracleContext(javax.naming.directory.DirContext ctx,
                                                  java.lang.String baseDN)
                                           throws UtilException
Returns a String[] of DNs of all the Oracle Contexts in the directory under the specified base DN.
Parameters:
ctx - - Directory Context baseDN - DN where OracleContext is located
Throws:
UtilException
CommunicationErrorException - - an error occurrs while contacting LDAP server

isUpToDate

public boolean isUpToDate(javax.naming.directory.DirContext ctx)
                   throws UtilException
Returns true if this Oracle Context is up to date with the current client version.
Parameters:
ctx - a valide DirContext
Throws:
UtilException

Oracle Internet Directory API Reference
10g(10.1.2)

B14083-02


Copyright © 2005, Oracle. All Rights Reserved.