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	CONTAINER_FACTORY_NAME Service property that defines the container factory name.
static java.lang.String	CONTAINER_PASSWORD Service property that defines the container target password.
static java.lang.String	CONTAINER_TARGET Service property that defines the container target for connection.
static java.lang.String	DISCOVERY_CONNECT_ID_NAMESPACE_PROPERTY Discovery service property to specify a namespace name for creating a connect id.
static java.lang.String	DISCOVERY_CONNECT_ID_PROPERTY Discovery service property to specify value for creating a connect id.
static java.lang.String	DISCOVERY_CONTAINER_FACTORY_PROPERTY Discovery service property for specifying the container factory type.
static java.lang.String	DISCOVERY_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	DISCOVERY_OBJECTCLASS_PROPERTY Discovery service property for specifying the remote interface type.
static java.lang.String	DISCOVERY_SERVICE_ID_NAMESPACE_PROPERTY Discovery service property to specify a namespace name for creating a target service ID.
static java.lang.String	DISCOVERY_SERVICE_ID_PROPERTY Discovery service property for a 'remotesvcs' discovery type.
static java.lang.String	DISCOVERY_SERVICE_TYPE Constant defining the ECF remote services discovery service type.
static java.lang.String	OBJECTCLASS 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	REMOTE_SERVICE_CONTAINER_ID Service property that defines the remote service container ID.
static java.lang.String	REMOTE_SERVICE_CONTAINER_ID_FACTORY_NAME Service property that defines the remote service container ID factory name.
static java.lang.String	SERVICE_DESCRIPTION Service property (named "remoteservice.description") identifying a service's description.
static java.lang.String	SERVICE_ID Service property (named "remote.service.id") identifying a service's registration number (of type java.lang.Long).
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_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

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

Service property (named "remote.service.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

CONTAINER_FACTORY_NAME

static final java.lang.String CONTAINER_FACTORY_NAME

Service property that defines the container factory name.

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

See Also:

Constant Field Values

CONTAINER_TARGET

static final java.lang.String 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.

See Also:

Constant Field Values

CONTAINER_PASSWORD

static final java.lang.String CONTAINER_PASSWORD

Service property that defines the container target password.

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

See Also:

Constant Field Values

REMOTE_SERVICE_CONTAINER_ID

static final java.lang.String REMOTE_SERVICE_CONTAINER_ID

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.

See Also:

Constant Field Values

REMOTE_SERVICE_CONTAINER_ID_FACTORY_NAME

static final java.lang.String REMOTE_SERVICE_CONTAINER_ID_FACTORY_NAME

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.

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

DISCOVERY_SERVICE_TYPE

static final java.lang.String DISCOVERY_SERVICE_TYPE

Constant defining the ECF remote services discovery service type. This service type should be provided in the service type id when registering a remote service. Then clients may identify an ECF remote service type ID and therefore be made aware of how the client can interact with the service.

See Also:

Constant Field Values

DISCOVERY_CONNECT_ID_NAMESPACE_PROPERTY

static final java.lang.String DISCOVERY_CONNECT_ID_NAMESPACE_PROPERTY

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 if DISCOVERY_SERVICE_TYPE is specified.

See Also:

Constant Field Values

DISCOVERY_CONNECT_ID_PROPERTY

static final java.lang.String DISCOVERY_CONNECT_ID_PROPERTY

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 if DISCOVERY_SERVICE_TYPE is specified.

See Also:

Constant Field Values

DISCOVERY_SERVICE_ID_NAMESPACE_PROPERTY

static final java.lang.String DISCOVERY_SERVICE_ID_NAMESPACE_PROPERTY

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

See Also:

Constant Field Values

DISCOVERY_SERVICE_ID_PROPERTY

static final java.lang.String DISCOVERY_SERVICE_ID_PROPERTY

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

See Also:

Constant Field Values

DISCOVERY_OBJECTCLASS_PROPERTY

static final java.lang.String DISCOVERY_OBJECTCLASS_PROPERTY

Discovery service property for specifying the remote interface type. Note that this property is required if the DISCOVERY_SERVICE_TYPE is as given. It is expected that clients will use the value of this property to perform service lookups with the 'clazz' parameter via remoteServicesContainerAdapter.getRemoteServiceReferences(ID [] idFilter, String clazz, String filter).

See Also:

Constant Field Values

DISCOVERY_FILTER_PROPERTY

static final java.lang.String DISCOVERY_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.

See Also:

Constant Field Values

DISCOVERY_CONTAINER_FACTORY_PROPERTY

static final java.lang.String DISCOVERY_CONTAINER_FACTORY_PROPERTY

Discovery service property for specifying the container factory type. Note that this property is optional if the DISCOVERY_SERVICE_TYPE is used as given above.

See Also:

Constant Field Values