Class JSLPDiscoveryContainer
java.lang.Object
org.eclipse.ecf.core.AbstractContainer
org.eclipse.ecf.discovery.AbstractDiscoveryContainerAdapter
org.eclipse.ecf.provider.jslp.container.JSLPDiscoveryContainer
- All Implemented Interfaces:
org.eclipse.core.runtime.IAdaptable,IContainer,IIdentifiable,IDiscoveryAdvertiser,IDiscoveryContainerAdapter,IDiscoveryLocator,IDiscoveryService
public class JSLPDiscoveryContainer
extends AbstractDiscoveryContainerAdapter
implements IDiscoveryService
-
Field Summary
FieldsFields inherited from class org.eclipse.ecf.discovery.AbstractDiscoveryContainerAdapter
allServiceListeners, serviceListeners, servicesNamespaceName, serviceTypeListenersFields inherited from interface org.eclipse.ecf.discovery.IDiscoveryAdvertiser
CONTAINER_NAMEFields inherited from interface org.eclipse.ecf.discovery.IDiscoveryLocator
CONTAINER_NAMEFields inherited from interface org.eclipse.ecf.discovery.service.IDiscoveryService
CONTAINER_ID, CONTAINER_NAME -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddServiceListener(IServiceTypeID type, IServiceListener listener) Add a service listener.voidaddServiceListener(IServiceListener listener) Add a service listener.voidaddServiceTypeListener(IServiceTypeListener listener) Add a service type listener.voidconnect(ID aTargetID, IConnectContext connectContext) Connect to a target remote process or process group.voidDisconnect.voidvoidfireServiceTypeDiscovered(IServiceTypeID serviceTypeID) voidGet the target ID that this container instance has connected to.getServiceInfo(IServiceID service) Synchronously retrieve info about the serviceSynchronously get service info about all known servicesgetServices(IServiceTypeID type) Synchronously get service info about all known services of given service typeSynchronously get service info about all known services of given service typePurges the underlying IServiceInfo cache if available in the current providervoidregisterService(IServiceInfo aServiceInfo) Register the given service.voidunregisterService(IServiceInfo aServiceInfo) Unregister a previously registered service defined by serviceInfo.Methods inherited from class org.eclipse.ecf.discovery.AbstractDiscoveryContainerAdapter
clearListeners, dispose, fireServiceDiscovered, fireServiceTypeDiscovered, fireServiceUndiscovered, getAsyncServiceInfo, getAsyncServices, getAsyncServices, getAsyncServiceTypes, getConfig, getConnectNamespace, getID, getListeners, getServiceEvent, getServicesNamespace, removeServiceListener, removeServiceListener, removeServiceTypeListener, unregisterAllServicesMethods inherited from class org.eclipse.ecf.core.AbstractContainer
addListener, fireContainerEvent, getAdapter, getPasswordFromConnectContext, removeListenerMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclipse.ecf.discovery.IDiscoveryAdvertiser
getServicesNamespace, unregisterAllServicesMethods inherited from interface org.eclipse.ecf.discovery.IDiscoveryLocator
getAsyncServiceInfo, getAsyncServices, getAsyncServices, getAsyncServiceTypes, getServicesNamespace, removeServiceListener, removeServiceListener, removeServiceTypeListener
-
Field Details
-
NAME
- See Also:
-
REDISCOVER
public static long REDISCOVER
-
-
Constructor Details
-
JSLPDiscoveryContainer
public JSLPDiscoveryContainer()
-
-
Method Details
-
connect
Description copied from interface:IContainerConnect 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.- Specified by:
connectin interfaceIContainer- Parameters:
aTargetID- the ID of the remote server or group to connect to. SeeIContainer.getConnectNamespace()for a explanation of the constraints upon this parameter.connectContext- any required context to allow this container to authenticate. May benullif 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:IContainerDisconnect. This operation will disconnect the local container instance from any previously joined target or group. Subsequent calls to getConnectedID() will returnnull.- Specified by:
disconnectin interfaceIContainer
-
fireServiceDiscovered
-
fireServiceTypeDiscovered
-
fireServiceUndiscovered
-
getConnectedID
Description copied from interface:IContainerGet the target ID that this container instance has connected to. Returns null if not connected.- Specified by:
getConnectedIDin interfaceIContainer- Returns:
- ID of the target we are connected to. Returns
nullif container not connected.
-
getServiceInfo
Description copied from interface:IDiscoveryLocatorSynchronously retrieve info about the service- Specified by:
getServiceInfoin interfaceIDiscoveryLocator- Parameters:
service- IServiceID of the service to get info about. Must not benull.- Returns:
- IServiceInfo the service info retrieved.
nullif no information retrievable.
-
getServiceTypes
Description copied from interface:IDiscoveryLocatorSynchronously get service info about all known services of given service type- Specified by:
getServiceTypesin interfaceIDiscoveryLocator- Returns:
- IServiceTypeID[] the resulting array of service type IDs. Will
not be
null. May be of length 0.
-
getServices
Description copied from interface:IDiscoveryLocatorSynchronously get service info about all known services- Specified by:
getServicesin interfaceIDiscoveryLocator- Returns:
- IServiceInfo[] the resulting array of service info instances.
Will not be
null. May be of length 0.
-
getServices
Description copied from interface:IDiscoveryLocatorSynchronously get service info about all known services of given service type- Specified by:
getServicesin interfaceIDiscoveryLocator- Parameters:
type- IServiceTypeID defining the type of service we are interested in getting service info about. Must not benull- Returns:
- IServiceInfo[] the resulting array of service info instances.
Will not be
null. May be of length 0.
-
registerService
Description copied from interface:IDiscoveryAdvertiserRegister the given service. This publishes the service defined by the serviceInfo to the underlying publishing mechanism- Specified by:
registerServicein interfaceIDiscoveryAdvertiser- Parameters:
aServiceInfo- IServiceInfo of the service to be published. Must not benull.
-
unregisterService
Description copied from interface:IDiscoveryAdvertiserUnregister a previously registered service defined by serviceInfo.- Specified by:
unregisterServicein interfaceIDiscoveryAdvertiser- Parameters:
aServiceInfo- IServiceInfo defining the service to unregister. Must not benull.
-
purgeCache
Description copied from interface:IDiscoveryLocatorPurges the underlying IServiceInfo cache if available in the current provider- Specified by:
purgeCachein interfaceIDiscoveryLocator- Overrides:
purgeCachein classAbstractDiscoveryContainerAdapter- Returns:
- The previous cache content
- See Also:
-
addServiceListener
Description copied from interface:IDiscoveryLocatorAdd a service listener. The given listener will have its method called when a service is discovered.- Specified by:
addServiceListenerin interfaceIDiscoveryLocator- Overrides:
addServiceListenerin classAbstractDiscoveryContainerAdapter- Parameters:
listener- IServiceListener to be notified. Must not benull.
-
addServiceListener
Description copied from interface:IDiscoveryLocatorAdd a service listener. The given listener will have its method called when a service with a type matching that specified by the first parameter is discovered.- Specified by:
addServiceListenerin interfaceIDiscoveryLocator- Overrides:
addServiceListenerin classAbstractDiscoveryContainerAdapter- Parameters:
type- String type to listen for. Must not benull. Must be formatted according to this specific IDiscoveryContainerlistener- IServiceListener to be notified. Must not benull.
-
addServiceTypeListener
Description copied from interface:IDiscoveryLocatorAdd a service type listener. The given listener will have its method called when a service type is discovered.- Specified by:
addServiceTypeListenerin interfaceIDiscoveryLocator- Overrides:
addServiceTypeListenerin classAbstractDiscoveryContainerAdapter- Parameters:
listener- the listener to be notified. Must not benull.
-
getContainerName
- Specified by:
getContainerNamein classAbstractDiscoveryContainerAdapter- Returns:
- The name of this discovery container
-