org.eclipse.ecf.remoteservice
Interface Constants

public interface Constants

Remote service API constants.

Field Summary

static java.lang.String	OBJECTCLASS Remote service property identifying all (named "ecf.robjectClass") 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_ASYNC_RSPROXY_CLASS_ This constant allows the fully qualified async remote service proxy to be specified as a service property.
static java.lang.String	SERVICE_CONNECT_ID Deprecated.
static java.lang.String	SERVICE_CONNECT_ID_NAMESPACE Deprecated.
static java.lang.String	SERVICE_CONTAINER_FACTORY_NAME Deprecated.
static java.lang.String	SERVICE_CONTAINER_ID Remote service property that defines the remote service container ID.
static java.lang.String	SERVICE_FILTER_PROPERTY Deprecated.
static java.lang.String	SERVICE_ID Remote service property (named "ecf.rsvc.id") identifying a service's remote registration number (of type java.lang.Long).
static java.lang.String	SERVICE_IDFILTER_ID Deprecated.
static java.lang.String	SERVICE_IDFILTER_NAMESPACE Deprecated.
static java.lang.String	SERVICE_OBJECTCLASS Deprecated.
static java.lang.String	SERVICE_PREVENT_RSPROXY Remote service property used to prevent the automatic addition of the IRemoteServiceProxy interface to the proxy returned from IRemoteService.getProxy.
static java.lang.String	SERVICE_RANKING Service property (named "ecf.rsvc.ranking") identifying a service's ranking number (of type java.lang.Integer).
static java.lang.String	SERVICE_REGISTER_PROXY Remote 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.

Field Detail

OBJECTCLASS

static final java.lang.String OBJECTCLASS

Remote service property identifying all (named "ecf.robjectClass") 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 remote 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 "ecf.rsvc.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_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_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_REGISTER_PROXY

static final java.lang.String SERVICE_REGISTER_PROXY

Remote 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

SERVICE_PREVENT_RSPROXY

static final java.lang.String SERVICE_PREVENT_RSPROXY

Remote service property used to prevent the automatic addition of the IRemoteServiceProxy interface to the proxy returned from IRemoteService.getProxy. If this service property is set (to any non-null Object value), it will prevent the the IRemoteServiceProxy from being added to the set of interfaces exposed by the proxy returned from IRemoteService.getProxy.

Since:

6.0

See Also:

Constant Field Values

SERVICE_ASYNC_RSPROXY_CLASS_

static final java.lang.String SERVICE_ASYNC_RSPROXY_CLASS_

This constant allows the fully qualified async remote service proxy to be specified as a service property. For example, if the remote service interface is as so:

 package foo;
 
 public interface Bar {
    String doStuff();
 }
 

then by default, the async remote service proxy interface class would be expected to be the following:

 package foo;
 import org.eclipse.ecf.remoteservice.IAsyncRemoteServiceProxy;
 import org.eclipse.equinox.concurrent.future.IFuture;

 public interface BarAsync extends IAsyncRemoteServiceProxy {
    IFuture doStuffAsync();
 }
 

This property allows a new class to be associated with the original service interface, so that rather than looking for the foo.BarAsync class when a proxy is created, the class specified by the value of the property will be used instead. For example, assume the existance of another async remote service interface:

 package gogo;
 import org.eclipse.ecf.remoteservice.IAsyncRemoteServiceProxy;
 import org.eclipse.equinox.concurrent.future.IFuture;
 
 public interface MyBar extends IAsyncRemoteServiceProxy {
    IFuture doStuffAsync();
 }
 

Further assume that when the remote service was registered, that a service property was specified:

 serviceProps.put("ecf.rsvc.async.proxy_<fq classname>","<fq substitute>");
 

 serviceProps.put("ecf.rsvc.async.proxy_foo.Bar","gogo.MyBar");
 

Then, when a Bar proxy is created, if the 'gogo.MyBar' interface is available on the client, an async remote service proxy will be added to the proxy, and client will be able to asynchronously call MyBar.doStuffAsync() on the proxy.

See Also:

Constant Field Values

SERVICE_CONNECT_ID

static final java.lang.String SERVICE_CONNECT_ID

Deprecated.

See Also:

Constant Field Values

SERVICE_CONNECT_ID_NAMESPACE

static final java.lang.String SERVICE_CONNECT_ID_NAMESPACE

Deprecated.

See Also:

Constant Field Values

SERVICE_IDFILTER_NAMESPACE

static final java.lang.String SERVICE_IDFILTER_NAMESPACE

Deprecated.

See Also:

Constant Field Values

SERVICE_IDFILTER_ID

static final java.lang.String SERVICE_IDFILTER_ID

Deprecated.

See Also:

Constant Field Values

SERVICE_OBJECTCLASS

static final java.lang.String SERVICE_OBJECTCLASS

Deprecated.

See Also:

Constant Field Values

SERVICE_FILTER_PROPERTY

static final java.lang.String SERVICE_FILTER_PROPERTY

Deprecated.

See Also:

Constant Field Values

SERVICE_CONTAINER_FACTORY_NAME

static final java.lang.String SERVICE_CONTAINER_FACTORY_NAME

Deprecated.

See Also:

Constant Field Values