Interface Advertiser
- All Known Implementing Classes:
AdvertiserImpl
public interface Advertiser
The Advertiser is the SA interface, allowing clients to register new service
instances with SLP, to change the attributes of existing services, and to
deregister service instances. New registrations and modifications of
attributes are made in the language locale with which the Advertiser was
created, deregistrations of service instances are made for all locales.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAttributes
(ServiceURL pURL, Vector<ServiceLocationAttribute> pAttributes) Update the registration by adding the given attributes.void
deleteAttributes
(ServiceURL pURL, Vector<String> pAttributeIds) Delete the attributes from a URL for the locale with which the Advertiser was created.void
deregister
(ServiceURL pURL) Deregister a service from the SLP framework.Return the language locale with which this object was created.void
register
(ServiceURL pURL, Vector<ServiceLocationAttribute> pAttributes) Register a new service with SLP having the given attributes.
-
Method Details
-
getLocale
Locale getLocale()Return the language locale with which this object was created.- Returns:
- The locale
-
register
void register(ServiceURL pURL, Vector<ServiceLocationAttribute> pAttributes) throws ServiceLocationException Register a new service with SLP having the given attributes. The API library is required to perform the operation in all scopes obtained through configuration.- Parameters:
pURL
- The URL for the service.pAttributes
- A vector of ServiceLocationAttribute objects describing the service.- Throws:
ServiceLocationException
-
deregister
Deregister a service from the SLP framework. This has the effect of deregistering the service from every language locale. The API library is required to perform the operation in all scopes obtained through configuration.- Parameters:
pURL
- The URL for the service.- Throws:
ServiceLocationException
-
addAttributes
void addAttributes(ServiceURL pURL, Vector<ServiceLocationAttribute> pAttributes) throws ServiceLocationException Update the registration by adding the given attributes. The API library is required to perform the operation in all scopes obtained through configuration.- Parameters:
pURL
- The URL for the service.pAttributes
- A Vector of ServiceLocationAttribute objects to add to the existing registration. Use an empty vector to update the URL alone. May not be null.- Throws:
ServiceLocationException
-
deleteAttributes
void deleteAttributes(ServiceURL pURL, Vector<String> pAttributeIds) throws ServiceLocationException Delete the attributes from a URL for the locale with which the Advertiser was created. The API library is required to perform the operation in all scopes obtained through configuration.- Parameters:
pURL
- The URL for the service.pAttributeIds
- A vector of Strings indicating the ids of the attributes to remove. The strings may be attribute ids or they may be wildcard patterns to match ids. See [7] for the syntax of wildcard patterns. The strings may include SLP reserved characters, they will be escaped by the API before transmission. May not be the empty vector or null.- Throws:
ServiceLocationException
-