public class EndpointDescription extends Object
service.exported.*
property and must contain the corresponding
service.imported.*
ones.
The service.intents
property must contain the intents provided
by the service itself combined with the intents added by the exporting
distribution provider. Qualified intents appear fully expanded on this
property.Constructor and Description |
---|
EndpointDescription(Map<String,Object> properties)
Create an Endpoint Description from a Map.
|
EndpointDescription(ServiceReference reference,
Map<String,Object> properties)
Create an Endpoint Description based on a Service Reference and a Map of
properties.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object other)
Compares this
EndpointDescription object to another object. |
List<String> |
getConfigurationTypes()
Returns the configuration types.
|
String |
getFrameworkUUID()
Return the framework UUID for the remote service, if present.
|
String |
getId()
Returns the endpoint's id.
|
List<String> |
getIntents()
Return the list of intents implemented by this endpoint.
|
List<String> |
getInterfaces()
Provide the list of interfaces implemented by the exported service.
|
Version |
getPackageVersion(String packageName)
Provide the version of the given package name.
|
Map<String,Object> |
getProperties()
Returns all endpoint properties.
|
long |
getServiceId()
Returns the service id for the service exported through this endpoint.
|
int |
hashCode()
Returns a hash code value for the object.
|
boolean |
isSameService(EndpointDescription other)
Answers if this Endpoint Description refers to the same service instance
as the given Endpoint Description.
|
boolean |
matches(String filter)
Tests the properties of this
EndpointDescription against
the given filter using a case insensitive match. |
String |
toString()
Returns the string representation of this EndpointDescription.
|
public EndpointDescription(Map<String,Object> properties)
The endpoint.id
,
service.imported.configs
and objectClass
properties must be set.
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.IllegalArgumentException
- When the properties are not proper for
an Endpoint Description.public EndpointDescription(ServiceReference reference, Map<String,Object> properties)
This method will automatically set the
endpoint.framework.uuid
and endpoint.service.id
properties based on the specified Service Reference as well as the
service.imported
property if
they are not specified as properties.
The endpoint.id
,
service.imported.configs
and objectClass
properties must be set.
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.IllegalArgumentException
- When the properties are not proper for
an Endpoint Descriptionpublic String getId()
RemoteConstants.ENDPOINT_ID
property.null
. The returned
value has leading and trailing whitespace removed.public List<String> getInterfaces()
objectClass
property.public Version getPackageVersion(String packageName)
endpoint.package.version.
, and then using this as an endpoint property
key. For example:
endpoint.package.version.com.acmeThe value of this property is in String format and will be converted to a
Version
object by this method.packageName
- The name of the package for which a version is
requested.Version.emptyVersion
if the package has no version
in this Endpoint Description.IllegalArgumentException
- If the version property value is not
String.public long getServiceId()
RemoteConstants.ENDPOINT_SERVICE_ID
endpoint property.public List<String> getConfigurationTypes()
RemoteConstants.SERVICE_IMPORTED_CONFIGS
service property.public List<String> getIntents()
RemoteConstants.SERVICE_INTENTS
service property.public String getFrameworkUUID()
RemoteConstants.ENDPOINT_FRAMEWORK_UUID
endpoint property.null
if this endpoint is
not associated with an OSGi framework having a framework uuid.public Map<String,Object> getProperties()
public boolean isSameService(EndpointDescription other)
other
- The Endpoint Description to look atpublic int hashCode()
public boolean equals(Object other)
EndpointDescription
object to another object.
An Endpoint Description is considered to be equal to another Endpoint Description if their ids are equal.
public boolean matches(String filter)
EndpointDescription
against
the given filter using a case insensitive match.filter
- The filter to test.true
If the properties of this
EndpointDescription
match the filter,
false
otherwise.IllegalArgumentException
- If filter
contains an
invalid filter string that cannot be parsed.Copyright © 2018 JBoss by Red Hat. All rights reserved.