com.addc.commons.slp.Advertiser 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.List;
import java.util.Locale;

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

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

    /**
     * Register a ServiceURL with the slp daemon.
     * 
     * @param url
     *            the ServiceURL to register.
     * @param attributes
     *            the attributes associated with this URL, or an empty List.
     * @exception ServiceLocationException
     *                If the service cannot be located
     */
    void register(ServiceURL url, List attributes) throws ServiceLocationException;

    /**
     * Deregisters a ServiceURL with the slp daemon.
     * 
     * @param url
     *            the ServiceURL to deregister.
     * @exception ServiceLocationException
     *                If the service cannot be located
     */
    void deregister(ServiceURL url) throws ServiceLocationException;

    /**
     * This operation is not supported.
     * 
     * @param url
     *            the ServiceURL to register.
     * @param attributes
     *            the attributes associated with this URL, or an empty List.
     * @exception ServiceLocationException
     *                always.
     */
    void addAttributes(ServiceURL url, List attributes) throws ServiceLocationException;

    /**
     * This operation is not supported.
     * 
     * @param url
     *            the ServiceURL to register.
     * @param attributes
     *            the attributes associated with this URL, or an empty List.
     * @exception ServiceLocationException
     *                always.
     */
    void deleteAttributes(ServiceURL url, List attributes) throws ServiceLocationException;
}