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

All Superinterfaces:

ServiceEndpointDescription

All Known Implementing Classes:

RemoteServiceEndpointDescription

public interface IRemoteServiceEndpointDescription
extends ServiceEndpointDescription

Method Summary

ID	getConnectTargetID() Get the ECF container target ID (the ID of the container that is the target to connect to).
ID	getEndpointAsID() Get the ECF endpoint ID (the ID of the endpoint that exposes the given remote service).
long	getRemoteServiceId() Get the remote service id for this service endpoint description.
java.lang.String	getRemoteServicesFilter() Get the ECF remote services filter string.
java.lang.String[]	getServiceIntents()
java.lang.String[]	getSupportedConfigs()
void	setProperties(java.util.Map properties) Set the properties for this endpoint description.

Methods inherited from interface org.eclipse.ecf.osgi.services.discovery.ServiceEndpointDescription

getEndpointID, getEndpointInterfaceName, getLocation, getProperties, getProperty, getPropertyKeys, getProvidedInterfaces, getVersion

Method Detail

getEndpointAsID

ID getEndpointAsID()

Get the ECF endpoint ID (the ID of the endpoint that exposes the given remote service). This ID must not be null.

Returns:

ID that is the ECF endpoint ID that exposes the service described by this description.

getConnectTargetID

ID getConnectTargetID()

Get the ECF container target ID (the ID of the container that is the target to connect to). This may return null, meaning that no target ID is available, and that the endpoint ID returned from getEndpointAsID() is also the target container ID. If not null, the ID returned from this method may be used to connect to an intermediate target via IContainer connect.

Returns:

ID that may be used by local IContainer to connect to remote target.

getRemoteServicesFilter

java.lang.String getRemoteServicesFilter()

Get the ECF remote services filter string. May return null.

Returns:

String that is to be used as the filter for the call to getRemoteServicesReferences(ID,interface,filter);

setProperties

void setProperties(java.util.Map properties)

Set the properties for this endpoint description. This allows clients to examine and potentially change the service properties given by the service host (and delivered via discovery), and potentially change them via this method. The resulting properties will then be used in subsequent processing of this service endpoint description.

Parameters:

properties - the new set of properties. Must not be null.

getRemoteServiceId

long getRemoteServiceId()

Get the remote service id for this service endpoint description.

Returns:

long remote service id for the remote service.

getSupportedConfigs

java.lang.String[] getSupportedConfigs()

getServiceIntents

java.lang.String[] getServiceIntents()