org.eclipse.ecf.remoteservice.provider
Interface IRemoteServiceDistributionProvider

All Known Implementing Classes:

RemoteServiceDistributionProvider

public interface IRemoteServiceDistributionProvider

Since:

8.7 A service interface for distribution providers. When instances of this interface are registered, they result in the two methods below being called by the org.eclipse.ecf.remoteservice bundle, with the BundleContext from the org.eclipse.ecf.remoteservice bundle. Intended to be implemented by remote service distribution provider implementations. When instance of this service interface is registered, the methods below will be called in order to register the ContainerTypeDescription, Namespace, and AdapterConfig for this distribution provider.

Method Summary

AdapterConfig[]	getAdapterConfigs() Return any AdapterConfigs to register with the IAdapterManager
ContainerTypeDescription	getContainerTypeDescription() Return the ContainerTypeDescription to register for this distribution provider.
java.util.Dictionary<java.lang.String,?>	getContainerTypeDescriptionProperties() Return any properties that are to be used when registering the ContainerTypeDescription returned by above method.
Namespace	getNamespace() Return the Namespace (or subclass) to register for this distribution provider.
java.util.Dictionary<java.lang.String,?>	getNamespaceProperties() Return any properties that are to be used when registering the Namespace returned by above method.

Method Detail

getContainerTypeDescription

ContainerTypeDescription getContainerTypeDescription()

Return the ContainerTypeDescription to register for this distribution provider. The returned ContainerTypeDescription must not be null and should be unique identified via it's name (obtained via ContainerTypeDescription.getName().

Returns:

ContainerTypeDescription. Must not be null.

getContainerTypeDescriptionProperties

java.util.Dictionary<java.lang.String,?> getContainerTypeDescriptionProperties()

Return any properties that are to be used when registering the ContainerTypeDescription returned by above method. Null may be returned.

Returns:

Dictionary to use when registering the ContainerTypeDescription. May be null.

getNamespace

Namespace getNamespace()

Return the Namespace (or subclass) to register for this distribution provider. The returned Namespace may be null. In that case, no new Namespace will be registered. If the returned Namespace is non-null, It should be uniquely identified via it's name (obtained via Namespace.getName().

Returns:

ContainerTypeDescription. May be null.

getNamespaceProperties

java.util.Dictionary<java.lang.String,?> getNamespaceProperties()

Return any properties that are to be used when registering the Namespace returned by above method. Null may be returned.

Returns:

Dictionary to use when registering this provider's Namespace. May be null.

getAdapterConfigs

AdapterConfig[] getAdapterConfigs()

Return any AdapterConfigs to register with the IAdapterManager

Returns:

AdapterConfig[] holding any AdapterConfigs to be registered with the system-wide adaptermanager.