Package org.sblim.slp

Interface Locator

  • All Known Implementing Classes:
    LocatorImpl

    public interface Locator
    The Locator is the UA interface, allowing clients to query the SLP framework about existing service types, services instances, and about the attributes of an existing service instance or service type. Queries for services and attributes are made in the locale with which the Locator was created, queries for service types are independent of locale.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ServiceLocationEnumeration findAttributes​(ServiceType pType, java.util.Vector pScopes, java.util.Vector pAttributeIds)
      For the type and scope, return a Vector of all ServiceLocationAttribute objects whose ids match the String patterns in the attributeIds Vector regardless of the Locator's locale.
      ServiceLocationEnumeration findAttributes​(ServiceType pType, java.util.Vector pScopes, java.util.Vector pAttributeIds, java.util.Vector pDirectoryAgents)
      For the type and scope, return a Vector of all ServiceLocationAttribute objects whose ids match the String patterns in the attributeIds Vector regardless of the Locator's locale.
      ServiceLocationEnumeration findAttributes​(ServiceURL URL, java.util.Vector scopes, java.util.Vector attributeIds)
      For the URL and scope, return a Vector of ServiceLocationAttribute objects whose ids match the String patterns in the attributeIds Vector.
      ServiceLocationEnumeration findAttributes​(ServiceURL pURL, java.util.Vector pScopes, java.util.Vector pAttributeIds, java.util.Vector pDirectoryAgents)
      For the URL and scope, return a Vector of ServiceLocationAttribute objects whose ids match the String patterns in the attributeIds Vector.
      ServiceLocationEnumeration findServices​(ServiceType pType, java.util.Vector pScopes, java.lang.String pSearchFilter)
      Returns a vector of ServiceURL objects for services matching the query, and having a matching type in the given scopes.
      ServiceLocationEnumeration findServices​(ServiceType pType, java.util.Vector pScopes, java.lang.String pSearchFilter, java.util.Vector pDirectoryAgents)
      Returns a vector of ServiceURL objects for services matching the query, and having a matching type in the given scopes.
      ServiceLocationEnumeration findServiceTypes​(java.lang.String pNamingAuthority, java.util.Vector pScopes)
      Returns an enumeration of ServiceType objects giving known service types for the given scopes and given naming authority.
      ServiceLocationEnumeration findServiceTypes​(java.lang.String pNamingAuthority, java.util.Vector pScopes, java.util.Vector pDirectoryAgent)
      Returns an enumeration of ServiceType objects giving known service types for the given scopes and given naming authority.
      java.util.Locale getLocale()
      Return the language locale with which this object was created.
    • Method Detail

      • getLocale

        java.util.Locale getLocale()
        Return the language locale with which this object was created.
        Returns:
        The locale
      • findServiceTypes

        ServiceLocationEnumeration findServiceTypes​(java.lang.String pNamingAuthority,
                                                    java.util.Vector pScopes)
                                             throws ServiceLocationException
        Returns an enumeration of ServiceType objects giving known service types for the given scopes and given naming authority. If no service types are found, an empty enumeration is returned.
        Parameters:
        pNamingAuthority - The naming authority. Use "" for the default naming authority and "*" for all naming authorities.
        pScopes - A Vector of scope names. The vector should be selected from the results of a findScopes() API invocation. Use "DEFAULT" for the default scope.
        Returns:
        The enumeration
        Throws:
        ServiceLocationException
      • findServiceTypes

        ServiceLocationEnumeration findServiceTypes​(java.lang.String pNamingAuthority,
                                                    java.util.Vector pScopes,
                                                    java.util.Vector pDirectoryAgent)
                                             throws ServiceLocationException
        Returns an enumeration of ServiceType objects giving known service types for the given scopes and given naming authority. If no service types are found, an empty enumeration is returned.

        This method is not part of the RFC 2614 interface definition.
        Parameters:
        pNamingAuthority - The naming authority. Use "" for the default naming authority and "*" for all naming authorities.
        pScopes - A Vector of scope names. The vector should be selected from the results of a findScopes() API invocation. Use "DEFAULT" for the default scope.
        pDirectoryAgent - A vector of InetAddress that specify the directory agents to look for.
        Returns:
        The enumeration
        Throws:
        ServiceLocationException
      • findServices

        ServiceLocationEnumeration findServices​(ServiceType pType,
                                                java.util.Vector pScopes,
                                                java.lang.String pSearchFilter)
                                         throws ServiceLocationException
        Returns a vector of ServiceURL objects for services matching the query, and having a matching type in the given scopes. If no services are found, an empty enumeration is returned.
        Parameters:
        pType - The SLP service type of the service.
        pScopes - A Vector of scope names. The vector should be selected from the results of a findScopes() API invocation. Use "DEFAULT" for the default scope.
        pSearchFilter - An LDAPv3 [4] string encoded query. If the filter is empty, i.e. "", all services of the requested type in the specified scopes are returned. SLP reserved characters must be escaped in the query. Use ServiceLocationAttribute.escapeId() and ServiceLocationAttribute.escapeValue() to construct the query.
        Returns:
        The enumeration
        Throws:
        ServiceLocationException
      • findServices

        ServiceLocationEnumeration findServices​(ServiceType pType,
                                                java.util.Vector pScopes,
                                                java.lang.String pSearchFilter,
                                                java.util.Vector pDirectoryAgents)
                                         throws ServiceLocationException
        Returns a vector of ServiceURL objects for services matching the query, and having a matching type in the given scopes. If no services are found, an empty enumeration is returned.

        This method is not part of the RFC 2614 interface definition.
        Parameters:
        pType - The SLP service type of the service.
        pScopes - A Vector of scope names. The vector should be selected from the results of a findScopes() API invocation. Use "DEFAULT" for the default scope.
        pSearchFilter - An LDAPv3 [4] string encoded query. If the filter is empty, i.e. "", all services of the requested type in the specified scopes are returned. SLP reserved characters must be escaped in the query. Use ServiceLocationAttribute.escapeId() and ServiceLocationAttribute.escapeValue() to construct the query.
        pDirectoryAgents - A vector of InetAddress that specify the directory agents to look for.
        Returns:
        The enumeration
        Throws:
        ServiceLocationException
      • findAttributes

        ServiceLocationEnumeration findAttributes​(ServiceURL URL,
                                                  java.util.Vector scopes,
                                                  java.util.Vector attributeIds)
                                           throws ServiceLocationException
        For the URL and scope, return a Vector of ServiceLocationAttribute objects whose ids match the String patterns in the attributeIds Vector. The request is made in the language locale of the Locator. If no attributes match, an empty enumeration is returned.
        Parameters:
        URL - The URL for which the attributes are desired.
        scopes - A Vector of scope names. The vector should be selected from the results of a findScopes() API invocation. Use "DEFAULT" for the default scope.
        attributeIds - A Vector of String patterns identifying the desired attributes. An empty vector means return all attributes. As described in [7], the patterns may include wildcards to match substrings. The strings may include SLP reserved characters, they will be escaped by the API before transmission.
        Returns:
        The enumeration
        Throws:
        ServiceLocationException
      • findAttributes

        ServiceLocationEnumeration findAttributes​(ServiceURL pURL,
                                                  java.util.Vector pScopes,
                                                  java.util.Vector pAttributeIds,
                                                  java.util.Vector pDirectoryAgents)
                                           throws ServiceLocationException
        For the URL and scope, return a Vector of ServiceLocationAttribute objects whose ids match the String patterns in the attributeIds Vector. The request is made in the language locale of the Locator. If no attributes match, an empty enumeration is returned.

        This method is not part of the RFC 2614 interface definition.
        Parameters:
        pURL - The URL for which the attributes are desired.
        pScopes - A Vector of scope names. The vector should be selected from the results of a findScopes() API invocation. Use "DEFAULT" for the default scope.
        pAttributeIds - A Vector of String patterns identifying the desired attributes. An empty vector means return all attributes. As described in [7], the patterns may include wildcards to match substrings. The strings may include SLP reserved characters, they will be escaped by the API before transmission.
        pDirectoryAgents - A vector of InetAddress that specify the directory agents to look for.
        Returns:
        The enumeration
        Throws:
        ServiceLocationException
      • findAttributes

        ServiceLocationEnumeration findAttributes​(ServiceType pType,
                                                  java.util.Vector pScopes,
                                                  java.util.Vector pAttributeIds)
                                           throws ServiceLocationException
        For the type and scope, return a Vector of all ServiceLocationAttribute objects whose ids match the String patterns in the attributeIds Vector regardless of the Locator's locale. The request is made independent of language locale. If no attributes are found, an empty vector is returned.
        Parameters:
        pType - The service type.
        pScopes - A Vector of scope names. The vector should be selected from the results of a findScopes() API invocation. Use "DEFAULT" for the default scope.
        pAttributeIds - A Vector of String patterns identifying the desired attributes. An empty vector means return all attributes. As described in [7], the patterns may include wildcards to match all prefixes or suffixes. The patterns may include SLP reserved characters, they will be escaped by the API before transmission.
        Returns:
        The enumeration
        Throws:
        ServiceLocationException
      • findAttributes

        ServiceLocationEnumeration findAttributes​(ServiceType pType,
                                                  java.util.Vector pScopes,
                                                  java.util.Vector pAttributeIds,
                                                  java.util.Vector pDirectoryAgents)
                                           throws ServiceLocationException
        For the type and scope, return a Vector of all ServiceLocationAttribute objects whose ids match the String patterns in the attributeIds Vector regardless of the Locator's locale. The request is made independent of language locale. If no attributes are found, an empty vector is returned.

        This method is not part of the RFC 2614 interface definition.
        Parameters:
        pType - The service type.
        pScopes - A Vector of scope names. The vector should be selected from the results of a findScopes() API invocation. Use "DEFAULT" for the default scope.
        pAttributeIds - A Vector of String patterns identifying the desired attributes. An empty vector means return all attributes. As described in [7], the patterns may include wildcards to match all prefixes or suffixes. The patterns may include SLP reserved characters, they will be escaped by the API before transmission.
        pDirectoryAgents - A vector of InetAddress that specify the directory agents to look for.
        Returns:
        The enumeration
        Throws:
        ServiceLocationException