org.eclipse.ecf.provider.discovery
Class CompositeDiscoveryContainer

java.lang.Object
  org.eclipse.ecf.core.AbstractContainer
      org.eclipse.ecf.discovery.AbstractDiscoveryContainerAdapter
          org.eclipse.ecf.provider.discovery.CompositeDiscoveryContainer

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, IContainer, IIdentifiable, IDiscoveryContainerAdapter

public class CompositeDiscoveryContainer
extends AbstractDiscoveryContainerAdapter

Field Summary

protected org.eclipse.ecf.provider.discovery.CompositeDiscoveryContainer.CompositeContainerServiceListener	ccsl
protected org.eclipse.ecf.provider.discovery.CompositeDiscoveryContainer.CompositeContainerServiceTypeListener	ccstl
protected java.util.List	containers

Fields inherited from class org.eclipse.ecf.discovery.AbstractDiscoveryContainerAdapter

allServiceListeners, serviceListeners, servicesNamespaceName, serviceTypeListeners

Fields inherited from interface org.eclipse.ecf.discovery.IDiscoveryContainerAdapter

CONTAINER_CONNECT_REQUIRES_PASSWORD, CONTAINER_CONNECT_TARGET, CONTAINER_CONNECT_TARGET_PATH, CONTAINER_CONNECT_TARGET_PROTOCOL, CONTAINER_FACTORY_NAME_PROPERTY

Constructor Summary

CompositeDiscoveryContainer(java.util.List containers)

Method Summary

void	connect(ID targetID, IConnectContext connectContext) Connect to a target remote process or process group.
void	disconnect() Disconnect.
void	dispose() Dispose this IContainer instance.
ID	getConnectedID() Get the target ID that this container instance has connected to.
Namespace	getConnectNamespace() Get the Namespace for creating a targetID suitable for use as the first parameter in subsequent calls to IContainer.connect(ID, IConnectContext).
IServiceInfo	getServiceInfo(IServiceID aService) Synchronously retrieve info about the service
IServiceInfo[]	getServices() Synchronously get service info about all known services
IServiceInfo[]	getServices(IServiceTypeID type) Synchronously get service info about all known services of given service type
Namespace	getServicesNamespace() Get a Namespace for services associated with this discovery container adapter.
IServiceTypeID[]	getServiceTypes() Synchronously get service info about all known services of given service type
void	registerService(IServiceInfo serviceInfo) Register the given service.
void	unregisterService(IServiceInfo serviceInfo) Unregister a previously registered service defined by serviceInfo.

Methods inherited from class org.eclipse.ecf.discovery.AbstractDiscoveryContainerAdapter

addServiceListener, addServiceListener, addServiceTypeListener, clearListeners, fireServiceDiscovered, fireServiceTypeDiscovered, fireServiceUndiscovered, getConfig, getID, getListeners, removeServiceListener, removeServiceListener, removeServiceTypeListener

Methods inherited from class org.eclipse.ecf.core.AbstractContainer

addListener, fireContainerEvent, getAdapter, getPasswordFromConnectContext, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ecf.core.IContainer

addListener, getAdapter, removeListener

Field Detail

ccsl

protected org.eclipse.ecf.provider.discovery.CompositeDiscoveryContainer.CompositeContainerServiceListener ccsl

ccstl

protected org.eclipse.ecf.provider.discovery.CompositeDiscoveryContainer.CompositeContainerServiceTypeListener ccstl

containers

protected java.util.List containers

Constructor Detail

CompositeDiscoveryContainer

public CompositeDiscoveryContainer(java.util.List containers)
                            throws IDCreateException

Parameters:

containers -

Throws:

IDCreateException

Method Detail

connect

public void connect(ID targetID,
                    IConnectContext connectContext)
             throws ContainerConnectException

Description copied from interface: IContainer

Connect to a target remote process or process group. The target identified by the first parameter (targetID) is connected the implementation class. If authentication information is required, the required information is given via via the second parameter (connectContext). Callers note that depending upon the provider implementation this method may block. It is suggested that callers use a separate thread to call this method. This method provides an implementation independent way for container implementations to connect, authenticate, and communicate with a remote service or group of services. Providers are responsible for implementing this operation in a way appropriate to the given remote service (or group) via expected protocol.

Parameters:

targetID - the ID of the remote server or group to connect to. See IContainer.getConnectNamespace() for a explanation of the constraints upon this parameter.

connectContext - any required context to allow this container to authenticate. May be null if underlying provider does not have any authentication requirements for connection.

Throws:

ContainerConnectException - thrown if communication cannot be established with remote service. Causes can include network connection failure, authentication failure, server error, or if container is already connected.

disconnect

public void disconnect()

Description copied from interface: IContainer

Disconnect. This operation will disconnect the local container instance from any previously joined target or group. Subsequent calls to getConnectedID() will return null.

dispose

public void dispose()

Description copied from interface: IContainer

Dispose this IContainer instance. The container instance will be made inactive after the completion of this method and will be unavailable for subsequent usage.

Specified by:

dispose in interface IContainer

Overrides:

dispose in class AbstractDiscoveryContainerAdapter

getConnectedID

public ID getConnectedID()

Description copied from interface: IContainer

Get the target ID that this container instance has connected to. Returns null if not connected.

Returns:

ID of the target we are connected to. Returns null if container not connected.

getConnectNamespace

public Namespace getConnectNamespace()

Description copied from interface: IContainer

Get the Namespace for creating a targetID suitable for use as the first parameter in subsequent calls to IContainer.connect(ID, IConnectContext). If this method returns null, then it means that null is expected as a valid parameter in subsequent calls to IContainer.connect(ID, IConnectContext). If this method returns a non-null Namespace, then the targetID parameter in IContainer.connect(ID, IConnectContext) must be non-null instance created of the returned Namespace.

Specified by:

getConnectNamespace in interface IContainer

Overrides:

getConnectNamespace in class AbstractDiscoveryContainerAdapter

Returns:

Namespace the namespace associated with subsequent calls to IContainer.connect(ID, IConnectContext). If null, then the targetID instances passed to IContainer.connect(ID, IConnectContext) may be null. If not null, then targetID instances passed to IContainer.connect(ID, IConnectContext) must be instances of the returned Namespace.

getServiceInfo

public IServiceInfo getServiceInfo(IServiceID aService)

Description copied from interface: IDiscoveryContainerAdapter

Synchronously retrieve info about the service

Parameters:

aService - IServiceID of the service to get info about. Must not be null.

Returns:

IServiceInfo the service info retrieved. null if no information retrievable.

getServices

public IServiceInfo[] getServices()

Description copied from interface: IDiscoveryContainerAdapter

Synchronously get service info about all known services

Returns:

IServiceInfo[] the resulting array of service info instances. Will not be null. May be of length 0.

getServices

public IServiceInfo[] getServices(IServiceTypeID type)

Description copied from interface: IDiscoveryContainerAdapter

Synchronously get service info about all known services of given service type

Parameters:

type - IServiceTypeID defining the type of service we are interested in getting service info about. Must not be null

Returns:

IServiceInfo[] the resulting array of service info instances. Will not be null. May be of length 0.

getServicesNamespace

public Namespace getServicesNamespace()

Description copied from interface: IDiscoveryContainerAdapter

Get a Namespace for services associated with this discovery container adapter. The given Namespace may be used via ServiceIDFactory to create IServiceIDs rather than simple IDs. For example:

 IServiceID serviceID = ServiceIDFactory.getDefault().createServiceID(container.getServicesNamespace(),serviceType,serviceName);
 

Specified by:

getServicesNamespace in interface IDiscoveryContainerAdapter

Overrides:

getServicesNamespace in class AbstractDiscoveryContainerAdapter

Returns:

Namespace for creating service IDs. Will not be null.

getServiceTypes

public IServiceTypeID[] getServiceTypes()

Description copied from interface: IDiscoveryContainerAdapter

Synchronously get service info about all known services of given service type

Returns:

IServiceTypeID[] the resulting array of service type IDs. Will not be null. May be of length 0.

registerService

public void registerService(IServiceInfo serviceInfo)
                     throws ECFException

Description copied from interface: IDiscoveryContainerAdapter

Register the given service. This publishes the service defined by the first parameter to the underlying publishing mechanism

Parameters:

serviceInfo - IServiceInfo of the service to be published. Must not be null.

Throws:

ECFException - if service info cannot be registered with this service

unregisterService

public void unregisterService(IServiceInfo serviceInfo)
                       throws ECFException

Description copied from interface: IDiscoveryContainerAdapter

Unregister a previously registered service defined by serviceInfo.

Parameters:

serviceInfo - IServiceInfo defining the service to unregister. Must not be null.

Throws:

ECFException - if service info cannot be unregistered with this service