org.eclipse.ecf.remoteservice
Interface Constants

public interface Constants

Remote service API constants.

Field Summary

static java.lang.String	AUTOREGISTER_REMOTE_PROXY Service property that determines whether a remote service proxy is automatically added to the local service registry.
static java.lang.String	OBJECTCLASS Remote service property (named "remote.objectClass") identifying all of the class names under which a service was registered in the remote services API (of type java.lang.String[]).
static java.lang.String	SERVICE_CONNECT_ID Discovery service property to specify value for creating a connect id.
static java.lang.String	SERVICE_CONNECT_ID_NAMESPACE Discovery service property to specify a namespace name for creating a connect id.
static java.lang.String	SERVICE_CONTAINER_FACTORY_NAME Remote service property that defines the container factory name.
static java.lang.String	SERVICE_CONTAINER_ID Remote service property that defines the remote service container ID.
static java.lang.String	SERVICE_CONTAINER_ID_FACTORY Service property that defines the remote service container ID factory name.
static java.lang.String	SERVICE_CONTAINER_TARGET Service property that defines the container target for connection.
static java.lang.String	SERVICE_DESCRIPTION Service property (named "remoteservice.description") identifying a service's description.
static java.lang.String	SERVICE_FILTER_PROPERTY Discovery service property for specifying the service lookup filter for client service lookup via remoteServicesContainerAdapter.getRemoteServiceReferences(ID [] idFilter, String clazz, String filter).
static java.lang.String	SERVICE_ID Remote service property (named "ecf.rsvc.id") identifying a service's registration number (of type java.lang.Long).
static java.lang.String	SERVICE_IDFILTER_ID Discovery service property for a 'remotesvcs' discovery type.
static java.lang.String	SERVICE_IDFILTER_NAMESPACE Discovery service property to specify a namespace name for creating a target service ID.
static java.lang.String	SERVICE_NAMESPACE Discovery service property specifying the expected namespace name for corresponding to remoteServiceContainerAdapter.getRemoteServicesNamespace()
static java.lang.String	SERVICE_OBJECTCLASS Discovery Service property specifying the clazz paramter in remoteServiceContainerAdapter.getRemoteServiceReferences(ID [] idFilter, String clazz, String filter);
static java.lang.String	SERVICE_PROXY_CONTAINER_ID Remote service property that defines the remote service container ID.
static java.lang.String	SERVICE_RANKING Service property (named "remote.service.ranking") identifying a service's ranking number (of type java.lang.Integer).
static java.lang.String	SERVICE_REGISTER_PROXY Service property used on service registration to indicate that a service proxy should be created rather than using the given service object (which may be null when this service property is set).
static java.lang.String	SERVICE_REGISTRATION_TARGETS Service property (named "remoteservice.description") identifying a a registration's target for receiving the service.
static java.lang.String	SERVICE_VENDOR Service property (named "remote.service.vendor") identifying a service's vendor.

Field Detail

OBJECTCLASS

static final java.lang.String OBJECTCLASS

Remote service property (named "remote.objectClass") identifying all of the class names under which a service was registered in the remote services API (of type java.lang.String[]).

This property is set by the remote services API when a service is registered.

See Also:

Constant Field Values

SERVICE_ID

static final java.lang.String SERVICE_ID

Remote service property (named "ecf.rsvc.id") identifying a service's registration number (of type java.lang.Long).

The value of this property is assigned by the remote services API when a service is registered. The remote services API assigns a unique value that is larger than all previously assigned values since the remote services API was started. These values are NOT persistent across restarts of the remote services API.

See Also:

Constant Field Values

SERVICE_RANKING

static final java.lang.String SERVICE_RANKING

Service property (named "remote.service.ranking") identifying a service's ranking number (of type java.lang.Integer).

This property may be supplied in the properties Dictionary object passed to the IRemoteServiceContainerAdapter.registerRemoteService method.

The service ranking is used by the remote services API to determine the default service to be returned from a call to the IRemoteServiceContainerAdapter.getRemoteServiceReferences(org.eclipse.ecf.core.identity.ID[], String, String) method: If more than one service implements the specified class, the RemoteServiceReference object with the highest ranking is returned.

The default ranking is zero (0). A service with a ranking of Integer.MAX_VALUE is very likely to be returned as the default service, whereas a service with a ranking of Integer.MIN_VALUE is very unlikely to be returned.

If the supplied property value is not of type java.lang.Integer, it is deemed to have a ranking value of zero.

See Also:

Constant Field Values

SERVICE_VENDOR

static final java.lang.String SERVICE_VENDOR

Service property (named "remote.service.vendor") identifying a service's vendor.

This property may be supplied in the properties Dictionary object passed to the IRemoteServiceContainerAdapter.registerRemoteService method.

See Also:

Constant Field Values

SERVICE_DESCRIPTION

static final java.lang.String SERVICE_DESCRIPTION

Service property (named "remoteservice.description") identifying a service's description.

This property may be supplied in the properties Dictionary object passed to the IRemoteServiceContainerAdapter.registerRemoteService method.

See Also:

Constant Field Values

SERVICE_REGISTRATION_TARGETS

static final java.lang.String SERVICE_REGISTRATION_TARGETS

Service property (named "remoteservice.description") identifying a a registration's target for receiving the service. The value of the property MUST be either a non-null instance of org.eclipse.ecf.core.identity.ID OR an ID[].

This property may be supplied in the properties Dictionary object passed to the IRemoteServiceContainerAdapter.registerRemoteService method.

See Also:

Constant Field Values

SERVICE_CONTAINER_FACTORY_NAME

static final java.lang.String SERVICE_CONTAINER_FACTORY_NAME

Remote service property that defines the container factory name.

This property may be supplied in the properties Dictionary object passed to the IRemoteServiceContainerAdapter.registerRemoteService method.

Since:

3.0

See Also:

Constant Field Values

SERVICE_CONTAINER_TARGET

static final java.lang.String SERVICE_CONTAINER_TARGET

Service property that defines the container target for connection.

This property may be supplied in the properties Dictionary object passed to the IRemoteServiceContainerAdapter.registerRemoteService method.

Since:

3.0

See Also:

Constant Field Values

SERVICE_CONTAINER_ID_FACTORY

static final java.lang.String SERVICE_CONTAINER_ID_FACTORY

Service property that defines the remote service container ID factory name.

This property may be supplied in the properties Dictionary object passed to the BundleContext.registerService method.

Since:

3.0

See Also:

Constant Field Values

SERVICE_CONTAINER_ID

static final java.lang.String SERVICE_CONTAINER_ID

Remote service property that defines the remote service container ID.

This property may be supplied in the properties Dictionary object passed to the BundleContext.registerService method.

Since:

3.0

See Also:

Constant Field Values

SERVICE_PROXY_CONTAINER_ID

static final java.lang.String SERVICE_PROXY_CONTAINER_ID

Remote service property that defines the remote service container ID.

Since:

5.0

See Also:

Constant Field Values

AUTOREGISTER_REMOTE_PROXY

static final java.lang.String AUTOREGISTER_REMOTE_PROXY

Service property that determines whether a remote service proxy is automatically added to the local service registry. This property can be used to expose remote services transparently to client (i.e. automatically putting a proxy into the client's local service registry). If this property is set in during service registration, then the the associated remote service proxy should be added to the client's service registry by the implementing provider. The value of the property can be any non-null value.

For example:

 final Dictionary props = new Hashtable();
 props.put(Constants.AUTOREGISTER_REMOTE_PROXY, "true");
 // Register
 adapters[0].registerRemoteService(new String[] {IConcatService.class.getName()}, serviceImpl, props);
 

See Also:

Constant Field Values

SERVICE_CONNECT_ID_NAMESPACE

static final java.lang.String SERVICE_CONNECT_ID_NAMESPACE

Discovery service property to specify a namespace name for creating a connect id. Note that this property should be equal to the name of the namespace retrieved from IContainer.getConnectNamespace(). Note that this property is optional.

Since:

3.0

See Also:

Constant Field Values

SERVICE_CONNECT_ID

static final java.lang.String SERVICE_CONNECT_ID

Discovery service property to specify value for creating a connect id. Note that this property should be equal to connectID retrieved from IContainer.getConnectedID(). Note that this property is optional.

Since:

3.0

See Also:

Constant Field Values

SERVICE_IDFILTER_NAMESPACE

static final java.lang.String SERVICE_IDFILTER_NAMESPACE

Discovery service property to specify a namespace name for creating a target service ID. Note that this property is optional. It is expected that clients will use the value of this property, along with the SERVICE_ID_PROPERTY to create an ID instance for the 'idFilter' parameter via remoteServicesContainerAdapter.getRemoteServiceReferences(ID [] idFilter, String clazz, String filter).

Since:

3.0

See Also:

Constant Field Values

SERVICE_IDFILTER_ID

static final java.lang.String SERVICE_IDFILTER_ID

Discovery service property for a 'remotesvcs' discovery type. Note that this property is optional. It is expected that clients will use the value of this property, along with the SERVICE_IDFILTER_NAMESPACE to create an ID instance for the 'idFilter' parameter via remoteServicesContainerAdapter.getRemoteServiceReferences(ID [] idFilter, String clazz, String filter).

Since:

3.0

See Also:

Constant Field Values

SERVICE_OBJECTCLASS

static final java.lang.String SERVICE_OBJECTCLASS

Discovery Service property specifying the clazz paramter in remoteServiceContainerAdapter.getRemoteServiceReferences(ID [] idFilter, String clazz, String filter);

Since:

3.0

See Also:

Constant Field Values

SERVICE_FILTER_PROPERTY

static final java.lang.String SERVICE_FILTER_PROPERTY

Discovery service property for specifying the service lookup filter for client service lookup via remoteServicesContainerAdapter.getRemoteServiceReferences(ID [] idFilter, String clazz, String filter). Note that this property is optional if the DISCOVERY_SERVICE_TYPE is as given above.

Since:

3.0

See Also:

Constant Field Values

SERVICE_NAMESPACE

static final java.lang.String SERVICE_NAMESPACE

Discovery service property specifying the expected namespace name for corresponding to remoteServiceContainerAdapter.getRemoteServicesNamespace()

Since:

3.0

See Also:

Constant Field Values

SERVICE_REGISTER_PROXY

static final java.lang.String SERVICE_REGISTER_PROXY

Service property used on service registration to indicate that a service proxy should be created rather than using the given service object (which may be null when this service property is set).

Since:

4.0

See Also:

Constant Field Values