org.eclipse.ecf.osgi.services.discovery
Interface ServiceEndpointDescription

All Known Subinterfaces:

IRemoteServiceEndpointDescription

All Known Implementing Classes:

RemoteServiceEndpointDescription, ServiceEndpointDescriptionImpl

Deprecated. This interface is deprecated because at the time of ECF 3.0/Galileo release, it seems likely that this class will be moved, or renamed, or undergo major changes after the release of ECF 3.0. This deprecation is therefore intended as a notice to consumers about these upcoming changes in the RFC119 specification, and the consequent changes to these OSGi-defined classes.

public interface ServiceEndpointDescription

This interface describes an endpoint of a service. This class can be considered as a wrapper around the property map of a published service and its endpoint. It provides an API to conveniently access the most important properties of the service.

ServiceEndpointDescription objects are immutable.

Version:

$Revision: 1.2 $

Method Summary

java.lang.String	getEndpointID() Deprecated. Returns the value of the property with key ServicePublication.ENDPOINT_ID.
java.lang.String	getEndpointInterfaceName(java.lang.String interfaceName) Deprecated. Returns non-Java endpoint interface name associated with the given interface.
java.net.URI	getLocation() Deprecated. Returns the value of the property with key ServicePublication.ENDPOINT_LOCATION.
java.util.Map	getProperties() Deprecated. Returns all service endpoint properties.
java.lang.Object	getProperty(java.lang.String key) Deprecated. Getter method for the property value of a given key.
java.util.Collection	getPropertyKeys() Deprecated. Returns all names of service endpoint properties.
java.util.Collection	getProvidedInterfaces() Deprecated. Returns the value of the property with key ServicePublication.SERVICE_INTERFACE_NAME.
java.lang.String	getVersion(java.lang.String interfaceName) Deprecated. Returns version of the given interface.

Method Detail

getProvidedInterfaces

java.util.Collection getProvidedInterfaces()

Deprecated.

Returns the value of the property with key ServicePublication.SERVICE_INTERFACE_NAME.

Returns:

Collection (<String>) of service interface names provided by the advertised service endpoint. The collection is never null or empty but contains at least one service interface.

getEndpointInterfaceName

java.lang.String getEndpointInterfaceName(java.lang.String interfaceName)

Deprecated.

Returns non-Java endpoint interface name associated with the given interface.

Value of the property with key ServicePublication.ENDPOINT_INTERFACE_NAME is used by this operation.

Parameters:

interfaceName - for which its non-Java endpoint interface name should be returned.

Returns:

non-Java endpoint interface name, or null if it hasn't been provided or if given interface name is null.

getVersion

java.lang.String getVersion(java.lang.String interfaceName)

Deprecated.

Returns version of the given interface.

Value of the property with key ServicePublication.SERVICE_INTERFACE_VERSION is used by this operation.

Parameters:

interfaceName - for which its version should be returned.

Returns:

Version of given service interface, or null if it hasn't been provided or if given interface name is null.

getLocation

java.net.URI getLocation()

Deprecated.

Returns the value of the property with key ServicePublication.ENDPOINT_LOCATION.

Returns:

The url of the service location, or null if it hasn't been provided.

getEndpointID

java.lang.String getEndpointID()

Deprecated.

Returns the value of the property with key ServicePublication.ENDPOINT_ID.

Returns:

Unique id of service endpoint, or null if it hasn't been provided.

getProperty

java.lang.Object getProperty(java.lang.String key)

Deprecated.

Getter method for the property value of a given key.

Parameters:

key - Name of the property

Returns:

The property value, or null if none is found for the given key or if provided key is null.

getPropertyKeys

java.util.Collection getPropertyKeys()

Deprecated.

Returns all names of service endpoint properties.

Returns:

a Collection (<String>) of property names available in the ServiceEndpointDescription. The collection is never null or empty but contains at least names of mandatory ServicePublication properties. Since ServiceEndpointDescription objects are immutable, the returned collection is also not going to be updated at a later point of time.

getProperties

java.util.Map getProperties()

Deprecated.

Returns all service endpoint properties.

Returns:

all properties of the service as a Map (<String, Object>). The map is never null or empty but contains at least mandatory ServicePublication properties. Since ServiceEndpointDescription objects are immutable, the returned map is also not going to be updated at a later point of time.