oracle.ldap.util
Class Subscriber

java.lang.Object
  |
  +--oracle.ldap.util.Subscriber

public class Subscriber

extends java.lang.Object

Field Summary

static int	EXTPROPTYPE_COMMON Extended Preference Type to be used with getExtendedProperties() - Common Subscriber properties
static int	EXTPROPTYPE_DEFAULT_RAD Extended Preference Type to be used with getExtendedProperties() - Default User Extended Properties
static int	EXTPROPTYPE_RESOURCE_ACCESS_TYPE Extended Preference Type to be used with getExtendedProperties() - Resource Access Type

Constructor Summary

Subscriber(javax.naming.directory.DirContext ctx, int inSubIdType, java.lang.String inSubIdName, boolean validate)
Constructs a Subscriber

Method Summary

java.lang.String	getDn(javax.naming.directory.DirContext ctx) Return the DN of this subscriber.
java.lang.String	getDN(javax.naming.directory.DirContext ctx) Returns the DN of the subscriber (resolves the name if necessary).
PropertySetCollection	getExtendedProperties(javax.naming.directory.DirContext ctx, int propType, java.lang.String[] attrList, java.lang.String filter) Retrieves Extended properties under the Oracle Context of this subscriber.
PropertySetCollection	getProperties(javax.naming.directory.DirContext ctx, java.lang.String[] attrList) Retrieves selected attributes associated with this subscriber
void	resolve(javax.naming.directory.DirContext ctx) Validates the subscriber by identifying its DN

Methods inherited from class java.lang.Object

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

Field Detail

EXTPROPTYPE_COMMON

public static int EXTPROPTYPE_COMMON

Extended Preference Type to be used with getExtendedProperties() - Common Subscriber properties

EXTPROPTYPE_RESOURCE_ACCESS_TYPE

public static int EXTPROPTYPE_RESOURCE_ACCESS_TYPE

Extended Preference Type to be used with getExtendedProperties() - Resource Access Type

EXTPROPTYPE_DEFAULT_RAD

public static int EXTPROPTYPE_DEFAULT_RAD

Extended Preference Type to be used with getExtendedProperties() - Default User Extended Properties

Constructor Detail

Subscriber

public Subscriber(javax.naming.directory.DirContext ctx,
                  int inSubIdType,
                  java.lang.String inSubIdName,
                  boolean validate)
           throws UtilException

Constructs a Subscriber

Parameters:

ctx - a valid DirContext

inSubIdType - The type of subscriber id being used - use one of Util.IDTYPE_DN, Util.IDTYPE_SIMPLE or Util.IDTYPE_GUID

inSubIdName - Subscriber ID - If this value is null and inSubIdType is Util.IDTYPE_DN, then default subscriber will be used. Otherwise, a null will cause an exception

validate - Set to true to validate the user by the constructor

Throws:

UtilException -

Method Detail

getProperties

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

Retrieves selected attributes associated with this subscriber

Parameters:

ctx - a valid DirContext

attrList - an array of attributes to be retrieved

Throws:

UtilException -

getExtendedProperties

public PropertySetCollection getExtendedProperties(javax.naming.directory.DirContext ctx,
                                                   int propType,
                                                   java.lang.String[] attrList,
                                                   java.lang.String filter)
                                            throws UtilException

Retrieves Extended properties under the Oracle Context of this subscriber. Currently, only "Common" properties and "Resource Access Type" properties are supported.

Parameters:

ctx - a valid DirContext

propType - Use one of EXTPROPTYPE_COMMON, EXTPROPTYPE_RESOURCE_ACCESS_TYPE or EXTPROPTYPE_DEFAULT_RAD

attrList - an array of attributes to be retrieved

filter - a search filter to narrow search criteria. For eg. use "(orclResourceTypeName=OracleDB)" with EXTPROPTYPE_RESOURCE_ACCESS_TYPE to get only those properties of OracleDB

Throws:

UtilException -

resolve

public void resolve(javax.naming.directory.DirContext ctx)
             throws UtilException

Validates the subscriber by identifying its DN

Parameters:

ctx - a valid DirContext

Throws:

UtilException -

getDN

public java.lang.String getDN(javax.naming.directory.DirContext ctx)
                       throws UtilException

Returns the DN of the subscriber (resolves the name if necessary).

Parameters:

ctx - a valid DirContext

Throws:

UtilException -

getDn

public java.lang.String getDn(javax.naming.directory.DirContext ctx)
                       throws UtilException

Return the DN of this subscriber.

Throws:

UtilException -