org.eclipse.ecf.remoteservice.provider
Class RemoteServiceDistributionProvider

java.lang.Object
  org.eclipse.ecf.remoteservice.provider.RemoteServiceDistributionProvider

All Implemented Interfaces:

IRemoteServiceDistributionProvider

public class RemoteServiceDistributionProvider
extends java.lang.Object
implements IRemoteServiceDistributionProvider

Basic implementation of IRemoteServiceDistributionProvider. Intended to be subclassed by distribution provider implementations and or use Builder static inner class to create/build instances.

Since:

8.7

Nested Class Summary

static class

RemoteServiceDistributionProvider.Builder Builder for RemoteServiceDistributionProvider instances

Constructor Summary

protected	RemoteServiceDistributionProvider()
protected	RemoteServiceDistributionProvider(java.lang.String name)
protected	RemoteServiceDistributionProvider(java.lang.String name, IContainerInstantiator instantiator)
protected	RemoteServiceDistributionProvider(java.lang.String name, IContainerInstantiator instantiator, java.lang.String description)
protected	RemoteServiceDistributionProvider(java.lang.String name, IContainerInstantiator instantiator, java.lang.String description, boolean server)

Method Summary

protected RemoteServiceDistributionProvider	addAdapterConfig(AdapterConfig adapterConfig)
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.
protected java.lang.String	getDescription()
protected IContainerInstantiator	getInstantiator()
protected java.lang.String	getName()
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.
protected boolean	isHidden()
protected boolean	isServer()
protected RemoteServiceDistributionProvider	setAdapterConfig(AdapterConfig adapterConfig)
protected RemoteServiceDistributionProvider	setContainerTypeDescriptionProperties(java.util.Dictionary<java.lang.String,?> props)
protected RemoteServiceDistributionProvider	setDescription(java.lang.String desc)
protected RemoteServiceDistributionProvider	setHidden(boolean hidden)
protected RemoteServiceDistributionProvider	setInstantiator(IContainerInstantiator instantiator)
protected RemoteServiceDistributionProvider	setName(java.lang.String name)
protected RemoteServiceDistributionProvider	setNamespace(Namespace ns)
protected RemoteServiceDistributionProvider	setNamespaceProperties(java.util.Dictionary<java.lang.String,?> props)
protected RemoteServiceDistributionProvider	setServer(boolean server)
protected void	validateComplete()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteServiceDistributionProvider

protected RemoteServiceDistributionProvider()

RemoteServiceDistributionProvider

protected RemoteServiceDistributionProvider(java.lang.String name)

RemoteServiceDistributionProvider

protected RemoteServiceDistributionProvider(java.lang.String name,
                                            IContainerInstantiator instantiator)

RemoteServiceDistributionProvider

protected RemoteServiceDistributionProvider(java.lang.String name,
                                            IContainerInstantiator instantiator,
                                            java.lang.String description)

RemoteServiceDistributionProvider

protected RemoteServiceDistributionProvider(java.lang.String name,
                                            IContainerInstantiator instantiator,
                                            java.lang.String description,
                                            boolean server)

Method Detail

getName

protected java.lang.String getName()

setName

protected RemoteServiceDistributionProvider setName(java.lang.String name)

getInstantiator

protected IContainerInstantiator getInstantiator()

setInstantiator

protected RemoteServiceDistributionProvider setInstantiator(IContainerInstantiator instantiator)

getDescription

protected java.lang.String getDescription()

setDescription

protected RemoteServiceDistributionProvider setDescription(java.lang.String desc)

isServer

protected boolean isServer()

setServer

protected RemoteServiceDistributionProvider setServer(boolean server)

isHidden

protected boolean isHidden()

setHidden

protected RemoteServiceDistributionProvider setHidden(boolean hidden)

setNamespace

protected RemoteServiceDistributionProvider setNamespace(Namespace ns)

setContainerTypeDescriptionProperties

protected RemoteServiceDistributionProvider setContainerTypeDescriptionProperties(java.util.Dictionary<java.lang.String,?> props)

setNamespaceProperties

protected RemoteServiceDistributionProvider setNamespaceProperties(java.util.Dictionary<java.lang.String,?> props)

addAdapterConfig

protected RemoteServiceDistributionProvider addAdapterConfig(AdapterConfig adapterConfig)

setAdapterConfig

protected RemoteServiceDistributionProvider setAdapterConfig(AdapterConfig adapterConfig)

validateComplete

protected void validateComplete()
                         throws java.lang.NullPointerException

Throws:

java.lang.NullPointerException

getContainerTypeDescription

public ContainerTypeDescription getContainerTypeDescription()

Description copied from interface: IRemoteServiceDistributionProvider

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().

Specified by:

getContainerTypeDescription in interface IRemoteServiceDistributionProvider

Returns:

ContainerTypeDescription. Must not be null.

getContainerTypeDescriptionProperties

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

Description copied from interface: IRemoteServiceDistributionProvider

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

Specified by:

getContainerTypeDescriptionProperties in interface IRemoteServiceDistributionProvider

Returns:

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

getNamespace

public Namespace getNamespace()

Description copied from interface: IRemoteServiceDistributionProvider

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().

Specified by:

getNamespace in interface IRemoteServiceDistributionProvider

Returns:

ContainerTypeDescription. May be null.

getNamespaceProperties

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

Description copied from interface: IRemoteServiceDistributionProvider

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

Specified by:

getNamespaceProperties in interface IRemoteServiceDistributionProvider

Returns:

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

getAdapterConfigs

public AdapterConfig[] getAdapterConfigs()

Description copied from interface: IRemoteServiceDistributionProvider

Return any AdapterConfigs to register with the IAdapterManager

Specified by:

getAdapterConfigs in interface IRemoteServiceDistributionProvider

Returns:

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