com.addc.commons.slp.Locator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of addc-slp Show documentation

The addc-slp library supplies client classes for registering objects with a Service Location Protocol Daemon and for looking theses objects up later.

There is a newer version: 2.6

Show newest version

package com.addc.commons.slp;

import java.util.Locale;

/**
 * The SLP Locator interface defined in RFC 2614.
 */
public interface Locator {

    /**
     * Get the current locale of this Locator.
     * 
     * @return the current locale
     */
    Locale getLocale();

    /**
     * Finds all service types that have a registered URL.
     * 
     * @param namingAuthority
     *            the naming authority to search in, or empty string if all.
     * @return ServiceLocationEnumeration of ServiceType objects.
     * @exception ServiceLocationException
     *                If the service cannot be located
     */
    ServiceTypeEnumeration findServiceTypes(String namingAuthority) throws ServiceLocationException;

    /**
     * Finds all services of a particular type.
     * 
     * @param type
     *            the ServiceType to search for.
     * @param searchFilter
     *            an SLP search filter string.
     * @return ServiceLocationEnumeration of ServiceURL objects.
     * @exception ServiceLocationException
     *                If the service cannot be located
     */
    ServiceURLEnumeration findServices(ServiceType type, String searchFilter)
            throws ServiceLocationException;

    /**
     * Returns the attributes registered with a ServiceURL.
     * 
     * @param url
     *            the ServiceURL to query.
     * @param attributeIds
     *            comma delimited list of ids to return, or empty string if all.
     * @return ServiceLocationEnumeration of ServiceLocationAttribute objects.
     * @exception ServiceLocationException
     *                If the service cannot be located
     */
    SlpAttributeEnumeration findAttributes(ServiceURL url, String attributeIds)
            throws ServiceLocationException;

    /**
     * Returns the attributes registered with a ServiceType.
     * 
     * @param type
     *            the ServiceType to query.
     * @param attributeIds
     *            comma delimited list of ids to return, or empty string if all.
     * @return ServiceLocationEnumeration of ServiceLocationAttribute objects.
     * @exception ServiceLocationException
     *                If the service cannot be located
     */
    SlpAttributeEnumeration findAttributes(ServiceType type, String attributeIds)
            throws ServiceLocationException;
}