Class EndpointDescription
- java.lang.Object
- 
- org.osgi.service.remoteserviceadmin.EndpointDescription
- 
- org.eclipse.ecf.osgi.services.remoteserviceadmin.EndpointDescription
 
 
- 
 public class EndpointDescription extends 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 theEndpointDescriptionclass 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 SummaryConstructors Constructor Description EndpointDescription(Map<String,Object> properties)EndpointDescription(ServiceReference reference, Map<String,Object> properties)
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>getAsyncInterfaces()IDgetConnectTargetID()IDgetContainerID()StringgetEndpointId()ID[]getIDFilter()StringgetIdNamespace()Map<String,Version>getInterfaceVersions()Get a map of the service interface name to Version information for all the service interfaces exposed by this endpoint description (i.e.Map<String,Object>getProperties()Returns all endpoint properties.StringgetRemoteServiceFilter()LonggetRemoteServiceId()LonggetTimestamp()booleanisSameService(EndpointDescription other)Answers if this Endpoint Description refers to the same service instance as the given Endpoint Description.StringtoString()Returns the string representation of this EndpointDescription.- 
Methods inherited from class org.osgi.service.remoteserviceadmin.EndpointDescriptionequals, getConfigurationTypes, getFrameworkUUID, getId, getIntents, getInterfaces, getPackageVersion, getServiceId, hashCode, matches
 
- 
 
- 
- 
- 
Constructor Detail- 
EndpointDescriptionpublic EndpointDescription(ServiceReference reference, Map<String,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- Stringand, since the keys are case insensitive, there must be no duplicates with case variation.
- Throws:
- IllegalArgumentException- When the properties are not proper for an Endpoint Description
- See Also:
- EndpointDescription(ServiceReference, Map)
 
 - 
EndpointDescriptionpublic EndpointDescription(Map<String,Object> properties) - Parameters:
- properties- The map from which to create the Endpoint Description. The keys in the map must be type- Stringand, since the keys are case insensitive, there must be no duplicates with case variation.
- Throws:
- IllegalArgumentException- When the properties are not proper for an Endpoint Description.
- See Also:
- EndpointDescription(Map)
 
 
- 
 - 
Method Detail- 
getInterfaceVersionspublic Map<String,Version> getInterfaceVersions() Get a map of the service interface name to Version information for all the service interfaces exposed by this endpoint description (i.e. those returned byEndpointDescription.getInterfaces()which have a- Returns:
- Map of interface versions for all our service
         interfaces. Every service interface returned by
         EndpointDescription.getInterfaces()will have an associated Version, but it may have value Version#emptyVersion
 
 - 
getEndpointIdpublic String getEndpointId() - Returns:
- String ecf endpoint id
- Since:
- 4.0
 
 - 
getTimestamppublic Long getTimestamp() - Returns:
- Long ecf timestamp
- Since:
- 4.0
 
 - 
getRemoteServiceIdpublic Long getRemoteServiceId() - Returns:
- Long ecf remote service id
- Since:
- 4.0
 
 - 
getContainerIDpublic ID getContainerID() 
 - 
getIdNamespacepublic String getIdNamespace() 
 - 
getConnectTargetIDpublic ID getConnectTargetID() 
 - 
getIDFilterpublic ID[] getIDFilter() 
 - 
getRemoteServiceFilterpublic String getRemoteServiceFilter() 
 - 
isSameServicepublic boolean isSameService(EndpointDescription other) Description copied from class:EndpointDescriptionAnswers if this Endpoint Description refers to the same service instance as the given Endpoint Description. Two Endpoint Descriptions point to the same service if they have the same id or their framework UUIDs and remote service ids are equal.- Overrides:
- isSameServicein class- EndpointDescription
- Parameters:
- other- The Endpoint Description to look at
- Returns:
- True if this endpoint description points to the same service as the other
 
 - 
getPropertiespublic Map<String,Object> getProperties() Description copied from class:EndpointDescriptionReturns all endpoint properties.- Overrides:
- getPropertiesin class- EndpointDescription
- Returns:
- An unmodifiable map referring to the properties of this Endpoint Description.
 
 - 
getAsyncInterfacespublic List<String> getAsyncInterfaces() - Returns:
- List ecf asynchronous proxy interfaces
- Since:
- 4.0
 
 - 
toStringpublic String toString() Description copied from class:EndpointDescriptionReturns the string representation of this EndpointDescription.- Overrides:
- toStringin class- EndpointDescription
- Returns:
- String form of this EndpointDescription.
 
 
- 
 
-