com.tivoli.twg.engine.slp
Interface UserAgent


public interface UserAgent

SLPv2 User Agent Interface


Method Summary
 void locateAttributes(java.net.InetAddress address, ServiceUrl url, java.util.List attributeTags, LocateAttributesListener listener)
          Locate attributes on a specific service or directory agent.
 void locateAttributes(java.net.InetAddress address, java.lang.String serviceType, java.util.List attributeTags, LocateAttributesListener listener)
          Locate attributes on a specific service or directory agent.
 void locateAttributes(ServiceUrl url, java.util.List attributeTags, LocateAttributesListener listener)
          Locate attributes using multicast convergence algorithm.
 void locateAttributes(java.lang.String serviceType, java.util.List attributeTags, LocateAttributesListener listener)
          Locate attributes using multicast convergence algorithm.
 void locateScopes(java.net.InetAddress address, LocateScopesListener listener)
          Locate scopes on a specific service or directory agent.
 void locateScopes(LocateScopesListener listener)
          Locate scopes using multicast convergence algorithm.
 void locateServices(java.net.InetAddress address, java.lang.String serviceType, java.lang.String searchFilter, LocateServicesListener listener)
          Locate services on a specific service or directory agent.
 void locateServices(java.lang.String serviceType, java.lang.String searchFilter, LocateServicesListener listener)
          Locate services using multicast convergence algorithm.
 void locateServiceTypes(java.net.InetAddress address, java.lang.String namingAuthority, LocateServiceTypesListener listener)
          Locate service types on a specific service or directory agent.
 void locateServiceTypes(java.lang.String namingAuthority, LocateServiceTypesListener listener)
          Locate service types using multicast convergence algorithm.
 

Method Detail

locateServices

public void locateServices(java.lang.String serviceType,
                           java.lang.String searchFilter,
                           LocateServicesListener listener)
                    throws java.lang.NullPointerException,
                           ServiceLocationException
Locate services using multicast convergence algorithm.

Parameters:
serviceType - type of service to locate
searchFilter - optional LDAPv3 search filter
listener - callback listener
Throws:
java.lang.NullPointerException - if serviceType or listener is null
ServiceLocationException - if SLP error occurs

locateServices

public void locateServices(java.net.InetAddress address,
                           java.lang.String serviceType,
                           java.lang.String searchFilter,
                           LocateServicesListener listener)
                    throws java.lang.NullPointerException,
                           ServiceLocationException
Locate services on a specific service or directory agent.

Parameters:
address - service or directory agent address
serviceType - type of service to locate
searchFilter - optional LDAPv3 search filter
listener - callback listener
Throws:
java.lang.NullPointerException - if address, serviceType, or listener is null
ServiceLocationException - if SLP error occurs

locateAttributes

public void locateAttributes(ServiceUrl url,
                             java.util.List attributeTags,
                             LocateAttributesListener listener)
                      throws java.lang.NullPointerException,
                             ServiceLocationException
Locate attributes using multicast convergence algorithm.

Parameters:
url - service url to locate attributes for
attributeTags - list of String objects identifying the desired attributes. Wildcard characters in an attribute tag match an arbitrary sequence of characters. For instance "*bob*" matches "some bob I know", "bigbob", "bobby" and "bob". A null value means return all the attributes
listener - callback listener
Throws:
java.lang.NullPointerException - if url or listener is null
ServiceLocationException - if SLP error occurs

locateAttributes

public void locateAttributes(java.net.InetAddress address,
                             ServiceUrl url,
                             java.util.List attributeTags,
                             LocateAttributesListener listener)
                      throws java.lang.NullPointerException,
                             ServiceLocationException
Locate attributes on a specific service or directory agent.

Parameters:
address - service or directory agent address
url - service url to locate attributes for
attributeTags - list of String objects identifying the desired attributes. Wildcard characters in an attribute tag match an arbitrary sequence of characters. For instance "*bob*" matches "some bob I know", "bigbob", "bobby" and "bob". A null value means return all the attributes
listener - callback listener
Throws:
java.lang.NullPointerException - if address, url, or listener is null
ServiceLocationException - if SLP error occurs

locateAttributes

public void locateAttributes(java.lang.String serviceType,
                             java.util.List attributeTags,
                             LocateAttributesListener listener)
                      throws java.lang.NullPointerException,
                             ServiceLocationException
Locate attributes using multicast convergence algorithm.

Parameters:
serviceType - service type to locate attributes for
attributeTags - list of String objects identifying the desired attributes. Wildcard characters in an attribute tag match an arbitrary sequence of characters. For instance "*bob*" matches "some bob I know", "bigbob", "bobby" and "bob". A null value means return all the attributes
listener - callback listener
Throws:
java.lang.NullPointerException - if serviceType or listener is null
ServiceLocationException - if SLP error occurs

locateAttributes

public void locateAttributes(java.net.InetAddress address,
                             java.lang.String serviceType,
                             java.util.List attributeTags,
                             LocateAttributesListener listener)
                      throws java.lang.NullPointerException,
                             ServiceLocationException
Locate attributes on a specific service or directory agent.

Parameters:
address - service or directory agent address
serviceType - service type to locate attributes for
attributeTags - list of String objects identifying the desired attributes. Wildcard characters in an attribute tag match an arbitrary sequence of characters. For instance "*bob*" matches "some bob I know", "bigbob", "bobby" and "bob". A null value means return all the attributes
listener - callback listener
Throws:
java.lang.NullPointerException - if address, serviceType, or listener is null
ServiceLocationException - if SLP error occurs

locateServiceTypes

public void locateServiceTypes(java.lang.String namingAuthority,
                               LocateServiceTypesListener listener)
                        throws java.lang.NullPointerException,
                               ServiceLocationException
Locate service types using multicast convergence algorithm.

Parameters:
namingAuthority - naming authority, blank for IANA registered service types, or null for all service types regardless of naming authority
listener - callback listener
Throws:
java.lang.NullPointerException - if listener is null
ServiceLocationException - if SLP error occurs

locateServiceTypes

public void locateServiceTypes(java.net.InetAddress address,
                               java.lang.String namingAuthority,
                               LocateServiceTypesListener listener)
                        throws java.lang.NullPointerException,
                               ServiceLocationException
Locate service types on a specific service or directory agent.

Parameters:
address - service or directory agent address
namingAuthority - naming authority, blank for IANA registered service types, or null for all service types regardless of naming authority
listener - callback listener
Throws:
java.lang.NullPointerException - if address or listener is null
ServiceLocationException - if SLP error occurs

locateScopes

public void locateScopes(LocateScopesListener listener)
                  throws java.lang.NullPointerException,
                         ServiceLocationException
Locate scopes using multicast convergence algorithm.

Parameters:
listener - callback listener
Throws:
java.lang.NullPointerException - if listener is null
ServiceLocationException - if SLP error occurs

locateScopes

public void locateScopes(java.net.InetAddress address,
                         LocateScopesListener listener)
                  throws java.lang.NullPointerException,
                         ServiceLocationException
Locate scopes on a specific service or directory agent.

Parameters:
address - service or directory agent address
listener - callback listener
Throws:
java.lang.NullPointerException - if address or listener is null
ServiceLocationException - if SLP error occurs