Skip navigation links

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

E10664-01


oracle.ldap.util
Class ServiceReference

java.lang.Object
  extended by oracle.ldap.util.LDAPEntry
      extended by oracle.ldap.util.ServiceReference

All Implemented Interfaces:
java.io.Serializable

public class ServiceReference
extends LDAPEntry

This class represents a ServiceReference for a service instance. The ServiceReference contains methods to return the ServiceRecipient and the Service.

See Also:
Serialized Form

Field Summary

 

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

 

Constructor Summary
ServiceReference(javax.naming.directory.DirContext inctx, java.lang.String inputDN)
          Constructs a ServiceReference instance using its DN
ServiceReference(javax.naming.directory.DirContext inctx, java.lang.String inputDN, PropertySet ps)
           

 

Method Summary
 ServiceRecipient createServiceRecipient(javax.naming.directory.DirContext ctx, java.lang.String srName)
          Creates a ServiceRecipient under this service using the name provided
 ServiceRecipient[] getAllServiceRecipients(javax.naming.directory.DirContext ctx)
          Returns an array of all the ServiceRecipient belonging to this ServiceReference.
 ServiceRecipient[] getAllServiceRecipients(javax.naming.directory.DirContext ctx, java.lang.String[] attrList)
          Returns an array of all the ServiceRecipients belonging to this ServiceReference along with the values of the specified attributes.
 Service getServiceInstance(javax.naming.directory.DirContext ctx)
          Returns the Service object corresponding to this ServiceReference
 ServiceRecipient getServiceRecipient(javax.naming.directory.DirContext ctx, java.lang.String srName)
          Returns the specified ServiceRecipient object using its name recipient name
 void resolve(javax.naming.directory.DirContext ctx)
          Resolves the ServiceReference object by confirming the information of the ServiceRecipient and the Service is available.

 

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

 

Constructor Detail

ServiceReference

public ServiceReference(javax.naming.directory.DirContext inctx,
                        java.lang.String inputDN)
Constructs a ServiceReference instance using its DN
Parameters:
inctx - a valid DirContext
inputDN - the DN of the ServiceReference entry

ServiceReference

public ServiceReference(javax.naming.directory.DirContext inctx,
                        java.lang.String inputDN,
                        PropertySet ps)

Method Detail

getServiceInstance

public Service getServiceInstance(javax.naming.directory.DirContext ctx)
                           throws UtilException
Returns the Service object corresponding to this ServiceReference
Parameters:
ctx - a valid DirContext
Throws:
UtilException

getServiceRecipient

public ServiceRecipient getServiceRecipient(javax.naming.directory.DirContext ctx,
                                            java.lang.String srName)
                                     throws UtilException
Returns the specified ServiceRecipient object using its name recipient name
Parameters:
ctx - a valid DirContext
srName - the ServiceRecipient name
Throws:
UtilException

createServiceRecipient

public ServiceRecipient createServiceRecipient(javax.naming.directory.DirContext ctx,
                                               java.lang.String srName)
                                        throws UtilException
Creates a ServiceRecipient under this service using the name provided
Parameters:
srName - name of the service recipent to be created
Returns:
the newly created ServiceRecipient object
Throws:
UtilException

getAllServiceRecipients

public ServiceRecipient[] getAllServiceRecipients(javax.naming.directory.DirContext ctx)
                                           throws UtilException
Returns an array of all the ServiceRecipient belonging to this ServiceReference.
Parameters:
ctx - a valid DirContext
Throws:
UtilException

getAllServiceRecipients

public ServiceRecipient[] getAllServiceRecipients(javax.naming.directory.DirContext ctx,
                                                  java.lang.String[] attrList)
                                           throws UtilException
Returns an array of all the ServiceRecipients belonging to this ServiceReference along with the values of the specified attributes. These values will be cached in the ServiceRecipient objects
Parameters:
ctx - a valid DirContext
attrList - a list of attributes to be fetched
Throws:
UtilException

resolve

public void resolve(javax.naming.directory.DirContext ctx)
             throws UtilException
Resolves the ServiceReference object by confirming the information of the ServiceRecipient and the Service is available.
Specified by:
resolve in class LDAPEntry
Parameters:
ctx - a valid DirContext
Throws:
UtilException

Skip navigation links

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

E10664-01


Copyright © 1999, 2009 Oracle. All Rights Reserved.