Skip navigation links

Oracle Internet Directory API Reference
11g Release 1 (11.1.1)

E10664-01


oracle.ldap.util
Class ComponentInstance

java.lang.Object
  extended by oracle.ldap.util.LDAPEntry
      extended by oracle.ldap.util.ServiceEntity
          extended by oracle.ldap.util.ComponentInstance

All Implemented Interfaces:
java.io.Serializable, ServiceMethods

public class ComponentInstance
extends ServiceEntity
implements ServiceMethods
See Also:
Serialized Form

Field Summary

 

Fields inherited from class oracle.ldap.util.ServiceEntity
ENTITY_TYPE_COMPONENT, ENTITY_TYPE_SERVICE, ENTITY_TYPE_SUITE, ENTITY_TYPE_VIRTUAL, SUITETYPE_OCS, TYPE_ALL, TYPE_CALENDAR, TYPE_EMAIL, TYPE_FILES, TYPE_IMEETING, TYPE_PORTAL, TYPE_ULTRASEARCH, TYPE_VOICEMAILFAX, TYPE_WIRELESS

 

Fields inherited from class oracle.ldap.util.LDAPEntry
entryDN, entryIdType, entryPsc, inEntryId, validated

 

Method Summary
 void addMember(javax.naming.directory.DirContext ctx, java.lang.String dn)
          Adds the attribute value pair (orclServiceMember, dn_ptr) to this.
static ComponentInstance create(javax.naming.directory.DirContext ctx, java.lang.String name, java.lang.String ServiceType, ModPropertySet mps)
           
 ServiceEntity createMember(javax.naming.directory.DirContext ctx, java.lang.String serviceEntityType, java.lang.String name, java.lang.String ServiceType, ModPropertySet mps)
          Creates a service instance, a virtual service object, or a component instance, and then populates the orclServiceMember attribute with the appropriate DN pointer to the newly created object.
static void delete(javax.naming.directory.DirContext ctx, java.lang.String name, java.lang.String ServiceType)
          Deletes the service registry object, and removes all orclServiceMember references from all other service registry objects.
static ComponentInstance[] get(javax.naming.directory.DirContext ctx, java.lang.String serviceType, java.lang.String name)
           
 ServiceEntity[] getMember(javax.naming.directory.DirContext ctx, java.lang.String serviceEntityType, java.lang.String serviceType)
          Returns the members of this service object that match the provided criteria
 void removeMember(javax.naming.directory.DirContext ctx, java.lang.String dn)
          Removes the attribute value pair (orclServiceMember, dn_ptr) from this.
 void resolve(javax.naming.directory.DirContext ctx)
          Abstract method - implements validation of the LDAP entry by resolving the DN

 

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

 

Method Detail

create

public static ComponentInstance create(javax.naming.directory.DirContext ctx,
                                       java.lang.String name,
                                       java.lang.String ServiceType,
                                       ModPropertySet mps)
                                throws UtilException
Parameters:
ctx - directory context
name - Name for the component instance
serviceType - Utilize string constants to declare type of service e.g. ServiceEntity.TYPE_EMAIL
mps - object which contains all attribute/value pairs
Throws:
UtilException

get

public static ComponentInstance[] get(javax.naming.directory.DirContext ctx,
                                      java.lang.String serviceType,
                                      java.lang.String name)
                               throws UtilException,
                                      ServiceEntityException
Parameters:
ctx - directory context
serviceType - Utilize string constants to declare type of service e.g. ServiceEntity.TYPE_FILES
name - Name of the component instance
Throws:
UtilException
ServiceEntityException

delete

public static void delete(javax.naming.directory.DirContext ctx,
                          java.lang.String name,
                          java.lang.String ServiceType)
                   throws UtilException
Deletes the service registry object, and removes all orclServiceMember references from all other service registry objects.
Parameters:
ctx - directory context
name - Name for the virtual service
serviceType - Utilize string constants to declare type of service e.g. ServiceEntity.TYPE_EMAIL
Throws:
UtilException

createMember

public ServiceEntity createMember(javax.naming.directory.DirContext ctx,
                                  java.lang.String serviceEntityType,
                                  java.lang.String name,
                                  java.lang.String ServiceType,
                                  ModPropertySet mps)
                           throws UtilException,
                                  ServiceEntityException
Creates a service instance, a virtual service object, or a component instance, and then populates the orclServiceMember attribute with the appropriate DN pointer to the newly created object.
Specified by:
createMember in interface ServiceMethods
Parameters:
ctx - directory context
serviceEntityType - type of object to create. Either ServiceEntity.ENTITY_TYPE_COMPONENT, ServiceEntity.ENTITY_TYPE_VIRTUAL, or ServiceEntity.ENTITY_TYPE_SERVICE are acceptable values
name - name of the service member e.g. Email1
serviceType - Utilize string constants to declare type of service e.g. ServiceEntity.TYPE_EMAIL
mps - object which contains all attribute/value pairs
Throws:
UtilException
ServiceEntityException

getMember

public ServiceEntity[] getMember(javax.naming.directory.DirContext ctx,
                                 java.lang.String serviceEntityType,
                                 java.lang.String serviceType)
                          throws UtilException,
                                 ServiceEntityException
Returns the members of this service object that match the provided criteria
Parameters:
ctx - directory context
serviceEntityType - type of object to get. Either ServiceEntity.ENTITY_TYPE_COMPONENT, ServiceEntity.ENTITY_TYPE_VIRTUAL, or ServiceEntity.ENTITY_TYPE_SERVICE are acceptable values
serviceType - Utilize string constants to declare type of service e.g. ServiceEntity.TYPE_FILES
Throws:
UtilException
ServiceEntityException

addMember

public void addMember(javax.naming.directory.DirContext ctx,
                      java.lang.String dn)
               throws UtilException
Adds the attribute value pair (orclServiceMember, dn_ptr) to this.
Parameters:
ctx - directory context
dn - the DN of the child object
Throws:
UtilException

removeMember

public void removeMember(javax.naming.directory.DirContext ctx,
                         java.lang.String dn)
                  throws UtilException
Removes the attribute value pair (orclServiceMember, dn_ptr) from this.
Parameters:
ctx - directory context
dn - the DN of the child object
Throws:
UtilException

resolve

public void resolve(javax.naming.directory.DirContext ctx)
Description copied from class: LDAPEntry
Abstract method - implements validation of the LDAP entry by resolving the DN
Specified by:
resolve in class LDAPEntry

Skip navigation links

Oracle Internet Directory API Reference
11g Release 1 (11.1.1)

E10664-01


Copyright © 1999, 2009 Oracle. All Rights Reserved.