|
Oracle Internet Directory API Reference 11g Release 1 (11.1.1) E10664-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.ldap.util.LDAPEntry
oracle.ldap.util.OracleContext
oracle.ldap.util.RootOracleContext
public final class RootOracleContext
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.
Field Summary | |
---|---|
protected java.lang.String |
orclCtxFilePrefix |
protected java.lang.String[] |
resolveAttrs |
static java.lang.String |
rootOracleContextDN The default distinguished name (DN) of the Root Oracle Context |
Fields inherited from class oracle.ldap.util.OracleContext |
---|
commonPsc, fileSeparator, listFileExt, ohome, oracleContextCN, oracleContextObjClass, oracleContextRDN, orclCtxVersion, productPsc, pStream, subVector |
Fields inherited from class oracle.ldap.util.LDAPEntry |
---|
entryDN, entryIdType, entryPsc, inEntryId, resBundle, validated |
Constructor Summary | |
---|---|
RootOracleContext(javax.naming.directory.DirContext inCtx) |
|
RootOracleContext(javax.naming.directory.DirContext inCtx, java.util.logging.Logger lgr) Construct an instance of RootOracleContext . |
|
RootOracleContext(javax.naming.directory.DirContext inCtx, java.util.logging.Logger lgr, java.lang.String inOhome) Constructs an instance of RootOracleContext. |
|
RootOracleContext(javax.naming.directory.DirContext inCtx, java.util.logging.Logger lgr, java.lang.String inOhome, java.io.PrintStream pStream) Constructs an instance of RootOracleContext. |
|
RootOracleContext(javax.naming.directory.DirContext inCtx, java.lang.String inOhome) |
|
RootOracleContext(javax.naming.directory.DirContext inCtx, java.lang.String inOhome, java.io.PrintStream pStream) |
Method Summary | |
---|---|
void |
create(javax.naming.directory.DirContext ctx) Creates an OracleContext with the given DN |
Subscriber |
createDefaultSubscriber(javax.naming.directory.DirContext ctx, java.lang.String subscriberDN, boolean withAux) CreateDefaultSubscriber |
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, getPrintStream, getSubstitutionVector, getVersion, getVersion, isUpToDate, isUpToDate, refresh, resolve, resolve, upgrade, upgrade |
Methods inherited from class oracle.ldap.util.LDAPEntry |
---|
getDN, getProperties, setProperties |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String rootOracleContextDN
protected java.lang.String orclCtxFilePrefix
protected java.lang.String[] resolveAttrs
Constructor Detail |
---|
public RootOracleContext(javax.naming.directory.DirContext inCtx, java.util.logging.Logger lgr, java.lang.String inOhome)
inCtx
- a valid DirContextinOhome
- the absolute path of ORACLE_HOMEpublic RootOracleContext(javax.naming.directory.DirContext inCtx, java.lang.String inOhome)
public RootOracleContext(javax.naming.directory.DirContext inCtx, java.util.logging.Logger lgr, 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
inCtx
- a valid DirContextinOhome
- the absolute path of ORACLE_HOMEpStream
- the PrintStream
where the output is pushed topublic RootOracleContext(javax.naming.directory.DirContext inCtx, java.lang.String inOhome, java.io.PrintStream pStream)
public RootOracleContext(javax.naming.directory.DirContext inCtx, java.util.logging.Logger lgr)
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
inCtx
- a valid DirContextpublic RootOracleContext(javax.naming.directory.DirContext inCtx)
Method Detail |
---|
public Subscriber[] getAllSubscribers(javax.naming.directory.DirContext ctx, java.lang.String filter, java.lang.String[] attrList) throws UtilException
Subscriber
objects under the subscriber search base.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 subscriberUtilException
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.
ctx
- a valid DirContextattrList
- the list of attributes to be returned for each subscriberUtilException
public Subscriber createDefaultSubscriber(javax.naming.directory.DirContext ctx, java.lang.String subscriberDN, boolean withAux) throws UtilException
UtilException
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.
simpleName
- a valid simple name for the subscriber.withAux
- set to true if you wish to create the auxiliary user and group container.Subscriber
corresponding to the newly created subscriber.UtilException
public Subscriber getSubscriber(javax.naming.directory.DirContext ctx, int inSubIdType, java.lang.String inSubIdName, java.lang.String[] attrList) throws UtilException
Subscriber
.ctx
- a valid DirContextinSubIdType
- 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 desiredinSubIdName
- Subscriber ID - this value can be null ONLY if inSubIdType is Util.IDTYPE_DEFAULT. Otherwise, a null will cause an exceptionattrList
- a list of attributes to be looked up when fetching subscriber informationUtilException
public void create(javax.naming.directory.DirContext ctx) throws UtilException
create
in class OracleContext
UtilException
|
Oracle Internet Directory API Reference 11g Release 1 (11.1.1) E10664-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |