org.eclipse.ecf.osgi.services.remoteserviceadmin
Class EndpointDescription

java.lang.Object
  org.osgi.service.remoteserviceadmin.EndpointDescription
      org.eclipse.ecf.osgi.services.remoteserviceadmin.EndpointDescription

public class EndpointDescription
extends org.osgi.service.remoteserviceadmin.EndpointDescription

ECF remote service endpoint description. Instances of this class, typically created via discovery, allow the import of an ECF remote service. The superclass of this class is the org.osgi.service.remoteserviceadmin.EndpointDescription class which is specified by the Remote Service Admin (chap 122) from the OSGi 4.2 Enterprise Specification.

ECF remote services have capabilities beyond typical OSGi remote services. To expose these capabilities, this EndpointDescription adds optional meta-data. This meta-data may then be used by the remote service consumer to customize ECF remote services import. Specifically, to customize the behavior of the ECF implementation of RemoteServiceAdmin.importService(org.osgi.service.remoteserviceadmin.EndpointDescription).

Constructor Summary

EndpointDescription(java.util.Map<java.lang.String,java.lang.Object> properties)

EndpointDescription(org.osgi.framework.ServiceReference reference, java.util.Map<java.lang.String,java.lang.Object> properties)

Method Summary

boolean	equals(java.lang.Object other)
ID	getConnectTargetID()
ID	getContainerID()
ID[]	getIDFilter()
java.lang.String	getIdNamespace()
java.util.Map<java.lang.String,org.osgi.framework.Version>	getInterfaceVersions() Get a map of the service interface name -> Version information for all the service interfaces exposed by this endpoint description (i.e.
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
java.lang.String	getRemoteServiceFilter()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EndpointDescription

public EndpointDescription(org.osgi.framework.ServiceReference reference,
                           java.util.Map<java.lang.String,java.lang.Object> properties)

Parameters:

reference - A service reference that can be exported.

properties - Map of properties. This argument can be null. The keys in the map must be type String and, since the keys are case insensitive, there must be no duplicates with case variation.

Throws:

java.lang.IllegalArgumentException - When the properties are not proper for an Endpoint Description

See Also:

org.osgi.service.remoteserviceadmin.EndpointDescription#EndpointDescription(ServiceReference, Map)

EndpointDescription

public EndpointDescription(java.util.Map<java.lang.String,java.lang.Object> properties)

Parameters:

properties - The map from which to create the Endpoint Description. The keys in the map must be type String and, since the keys are case insensitive, there must be no duplicates with case variation.

Throws:

java.lang.IllegalArgumentException - When the properties are not proper for an Endpoint Description.

See Also:

org.osgi.service.remoteserviceadmin.EndpointDescription#EndpointDescription(Map)

Method Detail

getInterfaceVersions

public java.util.Map<java.lang.String,org.osgi.framework.Version> getInterfaceVersions()

Get a map of the service interface name -> Version information for all the service interfaces exposed by this endpoint description (i.e. those returned by #getInterfaces() which have a

Returns:

Map of interface versions for all our service interfaces. Every service interface returned by #getInterfaces() will have an associated Version, but it may have value

getContainerID

public ID getContainerID()

getIdNamespace

public java.lang.String getIdNamespace()

getConnectTargetID

public ID getConnectTargetID()

getIDFilter

public ID[] getIDFilter()

getRemoteServiceFilter

public java.lang.String getRemoteServiceFilter()

hashCode

public int hashCode()

equals

public boolean equals(java.lang.Object other)

toString

public java.lang.String toString()

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()