|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.ecf.core.AbstractContainer org.eclipse.ecf.provider.generic.SOContainer org.eclipse.ecf.provider.generic.ClientSOContainer org.eclipse.ecf.provider.generic.TCPClientSOContainer org.eclipse.ecf.provider.remoteservice.generic.RemoteServiceContainer
public class RemoteServiceContainer
Field Summary | |
---|---|
protected IRemoteServiceContainerAdapter |
registry
|
Fields inherited from class org.eclipse.ecf.provider.generic.TCPClientSOContainer |
---|
DEFAULT_COMM_NAME, DEFAULT_TCP_CONNECT_TIMEOUT |
Fields inherited from class org.eclipse.ecf.provider.generic.ClientSOContainer |
---|
CONNECTED, CONNECTING, connection, connectionState, connectLock, connectPolicy, DEFAULT_CONNECT_TIMEOUT, DISCONNECTED, remoteServerID |
Fields inherited from class org.eclipse.ecf.provider.generic.SOContainer |
---|
config, DEFAULT_OBJECT_ARG_KEY, DEFAULT_OBJECT_ARGTYPES_KEY, groupManager, isClosing, loadingThreadGroup, policy, receiver, sharedObjectManager, sharedObjectMessageSerializer, sharedObjectThreadGroup |
Constructor Summary | |
---|---|
RemoteServiceContainer(ISharedObjectContainerConfig config)
|
|
RemoteServiceContainer(ISharedObjectContainerConfig config,
int ka)
|
Method Summary | |
---|---|
void |
addRemoteServiceListener(IRemoteServiceListener listener)
Add listener for remote service registration/unregistration for this container |
org.eclipse.equinox.concurrent.future.IFuture |
asyncGetRemoteServiceReferences(ID[] idFilter,
java.lang.String clazz,
java.lang.String filter)
Asynchronously returns an array of IRemoteServiceReference objects. |
org.eclipse.equinox.concurrent.future.IFuture |
asyncGetRemoteServiceReferences(ID target,
ID[] idFilter,
java.lang.String clazz,
java.lang.String filter)
Asynchronously returns an array of IRemoteServiceReference objects. |
org.eclipse.equinox.concurrent.future.IFuture |
asyncGetRemoteServiceReferences(ID target,
java.lang.String clazz,
java.lang.String filter)
Asynchronously returns an array of IRemoteServiceReference objects. |
protected void |
createRegistry()
|
IRemoteFilter |
createRemoteFilter(java.lang.String filter)
Creates a IRemoteFilter object. |
IRemoteServiceReference[] |
getAllRemoteServiceReferences(java.lang.String clazz,
java.lang.String filter)
Returns an array of IRemoteServiceReference objects. |
IRemoteService |
getRemoteService(IRemoteServiceReference ref)
Get remote service for given IRemoteServiceReference. |
IRemoteServiceID |
getRemoteServiceID(ID containerID,
long containerRelativeID)
Get a remote service ID from a containerID and a containerRelative long value. |
Namespace |
getRemoteServiceNamespace()
Get namespace to use for this remote service provider. |
IRemoteServiceReference |
getRemoteServiceReference(IRemoteServiceID serviceID)
Get the remote service reference known to this container for the given IRemoteServiceID. |
IRemoteServiceReference[] |
getRemoteServiceReferences(ID[] idFilter,
java.lang.String clazz,
java.lang.String filter)
Returns an array of IRemoteServiceReference objects. |
IRemoteServiceReference[] |
getRemoteServiceReferences(ID target,
ID[] idFilter,
java.lang.String clazz,
java.lang.String filter)
Returns an array of IRemoteServiceReference objects. |
IRemoteServiceReference[] |
getRemoteServiceReferences(ID target,
java.lang.String clazz,
java.lang.String filter)
Returns an array of IRemoteServiceReference objects. |
IRemoteServiceRegistration |
registerRemoteService(java.lang.String[] clazzes,
java.lang.Object service,
java.util.Dictionary properties)
Register a new remote service. |
void |
removeRemoteServiceListener(IRemoteServiceListener listener)
Remove remote service registration/unregistration listener for this container. |
void |
setConnectContextForAuthentication(IConnectContext connectContext)
Set connect context for authentication upon subsequent calls to IRemoteServiceConsumer.getRemoteServiceReferences(ID[], String, String) or IRemoteServiceConsumer.asyncGetRemoteServiceReferences(ID[], String, String) . |
boolean |
ungetRemoteService(IRemoteServiceReference ref)
Unget IRemoteServiceReference. |
Methods inherited from class org.eclipse.ecf.provider.generic.TCPClientSOContainer |
---|
createConnection, getConnectTimeout, main |
Methods inherited from class org.eclipse.ecf.core.AbstractContainer |
---|
addListener, fireContainerEvent, 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.core.runtime.IAdaptable |
---|
getAdapter |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Methods inherited from interface org.eclipse.ecf.core.IContainer |
---|
addListener, removeListener |
Field Detail |
---|
protected IRemoteServiceContainerAdapter registry
Constructor Detail |
---|
public RemoteServiceContainer(ISharedObjectContainerConfig config)
public RemoteServiceContainer(ISharedObjectContainerConfig config, int ka)
Method Detail |
---|
protected void createRegistry()
public void addRemoteServiceListener(IRemoteServiceListener listener)
IRemoteServiceConsumer
addRemoteServiceListener
in interface IRemoteServiceConsumer
addRemoteServiceListener
in interface IRemoteServiceContainerAdapter
addRemoteServiceListener
in interface IRemoteServiceHost
listener
- notified of service registration/unregistration events. Must
not be null
.public IRemoteService getRemoteService(IRemoteServiceReference ref)
IRemoteServiceConsumer
IRemoteServiceContainerAdapter.ungetRemoteService(IRemoteServiceReference)
when the IRemoteService will no longer be used.
getRemoteService
in interface IRemoteServiceConsumer
getRemoteService
in interface IRemoteServiceContainerAdapter
ref
- the IRemoteServiceReference for the desired service. Must not
be null
.
null
is
returned.IRemoteServiceConsumer.ungetRemoteService(IRemoteServiceReference)
public IRemoteServiceReference[] getRemoteServiceReferences(ID[] idFilter, java.lang.String clazz, java.lang.String filter) throws org.osgi.framework.InvalidSyntaxException
IRemoteServiceConsumer
IRemoteServiceReference
objects. The
returned array of IRemoteServiceReference
objects contains
services that were registered under the specified class and match the
specified idFilter, and filter criteria.
Note this method assumes that the enclosing container has previously
been connected, and uses the idFilter to filter among targets within the
previously connected set of container IDs. To request connection as
part of reference lookup, see IRemoteServiceConsumer.getRemoteServiceReferences(ID, String, String)
.
The list is valid at the time of the call to this method, however since the Framework is a very dynamic environment, services can be modified or unregistered at anytime.
idFilter
is used to select a registered services that were
registered by a given set of containers with id in idFilter. Only
services exposed by a container with id in idFilter will be returned.
If idFilter
is null
, all containers are
considered to match the filter.
filter
is used to select the registered service whose
properties objects contain keys and values which satisfy the filter. See
Filter
for a description of the filter string syntax.
If filter
is null
, all registered services
are considered to match the filter. If filter
cannot be
parsed, an InvalidSyntaxException
will be thrown with a human
readable message where the filter became unparsable.
getRemoteServiceReferences
in interface IRemoteServiceConsumer
getRemoteServiceReferences
in interface IRemoteServiceContainerAdapter
idFilter
- an array of ID instances that will restrict the search for
matching container ids If null, all remote containers will be
considered in search for matching IRemoteServiceReference
instances. May be null
.clazz
- the fully qualified name of the interface class that describes
the desired service. Must not be null
.filter
- The filter criteria. May be null
.
null
if no services are found that match the search.
org.osgi.framework.InvalidSyntaxException
- If filter contains an invalid filter string that cannot be parsed.public IRemoteServiceRegistration registerRemoteService(java.lang.String[] clazzes, java.lang.Object service, java.util.Dictionary properties)
IRemoteServiceContainerAdapter
registerRemoteService
in interface IRemoteServiceContainerAdapter
registerRemoteService
in interface IRemoteServiceHost
clazzes
- the interface classes that the service exposes to remote
clients. Must not be null
and must not be an
empty array.service
- the service object. Under normal conditions this object must
null
null
is if
the service property Constants.SERVICE_REGISTER_PROXY
is set
in the properties. If Constants.SERVICE_REGISTER_PROXY
is set
in the properties parameter (to an arbitrary value), then the service
object may then be null
.properties
- to be associated with service
null
.public void removeRemoteServiceListener(IRemoteServiceListener listener)
IRemoteServiceConsumer
removeRemoteServiceListener
in interface IRemoteServiceConsumer
removeRemoteServiceListener
in interface IRemoteServiceContainerAdapter
removeRemoteServiceListener
in interface IRemoteServiceHost
listener
- to remove. Must not be null
.public boolean ungetRemoteService(IRemoteServiceReference ref)
IRemoteServiceConsumer
IRemoteServiceContainerAdapter.getRemoteService(IRemoteServiceReference)
.
If this method returns true, then the previously used IRemoteService will
no longer be usable.
ungetRemoteService
in interface IRemoteServiceConsumer
ungetRemoteService
in interface IRemoteServiceContainerAdapter
ref
- the IRemoteServiceReference to unget
IRemoteServiceConsumer.getRemoteService(IRemoteServiceReference)
public org.eclipse.equinox.concurrent.future.IFuture asyncGetRemoteServiceReferences(ID[] idFilter, java.lang.String clazz, java.lang.String filter)
IRemoteServiceConsumer
IRemoteServiceReference
objects. The
returned array of IRemoteServiceReference
objects contains
services that were registered under the specified class and match the
specified idFilter, and filter criteria.
Note this method assumes that the enclosing container has previously
been connected, and uses the idFilter to filter among targets within the
previously connected set of container IDs. To request connection as
part of reference lookup, see IRemoteServiceConsumer.getRemoteServiceReferences(ID, String, String)
.
The IFuture is returned immediately, and subsequent calls to IFuture.get()
or IFuture.get(long)
will return the actual results received. The type of
the Object returned from IFuture.get()
will be IRemoteServiceReference [].
The list is valid at the time of the call to this method, however since the Framework is a very dynamic environment, services can be modified or unregistered at anytime.
idFilter
is used to select a registered services that were
registered by a given set of containers with id in idFilter. Only
services exposed by a container with id in idFilter will be returned.
If idFilter
is null
, all containers are
considered to match the filter.
filter
is used to select the registered service whose
properties objects contain keys and values which satisfy the filter. See
Filter
for a description of the filter string syntax.
asyncGetRemoteServiceReferences
in interface IRemoteServiceConsumer
asyncGetRemoteServiceReferences
in interface IRemoteServiceContainerAdapter
idFilter
- an array of ID instances that will restrict the search for
matching container ids If null, all remote containers will be
considered in search for matching IRemoteServiceReference
instances. May be null
.clazz
- the fully qualified name of the interface class that describes
the desired service. Must not be null
.filter
- The filter criteria. May be null
.
null
.public Namespace getRemoteServiceNamespace()
IRemoteServiceConsumer
getRemoteServiceNamespace
in interface IRemoteServiceConsumer
getRemoteServiceNamespace
in interface IRemoteServiceContainerAdapter
getRemoteServiceNamespace
in interface IRemoteServiceHost
null
.public IRemoteFilter createRemoteFilter(java.lang.String filter) throws org.osgi.framework.InvalidSyntaxException
IRemoteServiceConsumer
IRemoteFilter
object. This IRemoteFilter
object may
be used to match a IRemoteServiceReference
object or a
Dictionary
object.
If the filter cannot be parsed, an InvalidSyntaxException
will be
thrown with a human readable message where the filter became unparsable.
createRemoteFilter
in interface IRemoteServiceConsumer
createRemoteFilter
in interface IRemoteServiceContainerAdapter
filter
- The filter string.
IRemoteFilter
object encapsulating the filter string.
org.osgi.framework.InvalidSyntaxException
- If filter
contains an invalid
filter string that cannot be parsed.FrameworkUtil.createFilter(String)
public IRemoteServiceReference getRemoteServiceReference(IRemoteServiceID serviceID)
IRemoteServiceConsumer
getRemoteServiceReference
in interface IRemoteServiceConsumer
getRemoteServiceReference
in interface IRemoteServiceContainerAdapter
serviceID
- the serviceID to retrieve the IRemoteServiceReference for.
null
if no IRemoteServiceReference found for the given serviceID.public IRemoteServiceID getRemoteServiceID(ID containerID, long containerRelativeID)
IRemoteServiceConsumer
null
if not.
getRemoteServiceID
in interface IRemoteServiceConsumer
getRemoteServiceID
in interface IRemoteServiceContainerAdapter
getRemoteServiceID
in interface IRemoteServiceHost
containerID
- the containerID that is the server/host for the remote service. Must not be null
. This
must be the containerID for the server/host of the remote service.containerRelativeID
- the long value identifying the remote service relative to the container ID.
null
if it is not.public void setConnectContextForAuthentication(IConnectContext connectContext)
IRemoteServiceConsumer
IRemoteServiceConsumer.getRemoteServiceReferences(ID[], String, String)
or IRemoteServiceConsumer.asyncGetRemoteServiceReferences(ID[], String, String)
. This
method should be called with a non-null connectContext in order to allow
authentication to occur during.
setConnectContextForAuthentication
in interface IRemoteServiceConsumer
setConnectContextForAuthentication
in interface IRemoteServiceContainerAdapter
connectContext
- the connect context to use for authenticating.
If null
, then no authentication will be
attempted.public IRemoteServiceReference[] getRemoteServiceReferences(ID target, java.lang.String clazz, java.lang.String filter) throws org.osgi.framework.InvalidSyntaxException, ContainerConnectException
IRemoteServiceConsumer
Returns an array of IRemoteServiceReference
objects. The
returned array of IRemoteServiceReference
objects contains
services that were registered under the specified class and match the
specified idFilter, and filter criteria.
The list is valid at the time of the call to this method, however since the Framework is a very dynamic environment, services can be modified or unregistered at anytime.
target is a remote container to connect to.
filter
is used to select the registered service whose
properties objects contain keys and values which satisfy the filter. See
Filter
for a description of the filter string syntax.
If filter
is null
, all registered services
are considered to match the filter. If filter
cannot be
parsed, an InvalidSyntaxException
will be thrown with a human
readable message where the filter became unparsable.
getRemoteServiceReferences
in interface IRemoteServiceConsumer
getRemoteServiceReferences
in interface IRemoteServiceContainerAdapter
target
- an target to connect to if enclosing container is not already
connected. May be null
.clazz
- the fully qualified name of the interface class that describes
the desired service. Must not be null
.filter
- The filter criteria. May be null
.
null
if no services are found that match the search.
org.osgi.framework.InvalidSyntaxException
- If filter contains an invalid filter string that cannot be parsed.
ContainerConnectException
public org.eclipse.equinox.concurrent.future.IFuture asyncGetRemoteServiceReferences(ID target, java.lang.String clazz, java.lang.String filter)
IRemoteServiceConsumer
IRemoteServiceReference
objects. The
returned array of IRemoteServiceReference
objects contains
services that were registered under the specified class and match the
specified idFilter, and filter criteria.
The IFuture is returned immediately, and subsequent calls to IFuture.get()
or IFuture.get(long)
will return the actual results received. The type of
the Object returned from IFuture.get()
will be IRemoteServiceReference [].
The list is valid at the time of the call to this method, however since the Framework is a very dynamic environment, services can be modified or unregistered at anytime.
idFilter
is used to select a registered services that were
registered by a given set of containers with id in idFilter. Only
services exposed by a container with id in idFilter will be returned.
target is a remote container to connect to.
filter
is used to select the registered service whose
properties objects contain keys and values which satisfy the filter. See
Filter
for a description of the filter string syntax.
asyncGetRemoteServiceReferences
in interface IRemoteServiceConsumer
asyncGetRemoteServiceReferences
in interface IRemoteServiceContainerAdapter
target
- an target to connect to if enclosing container is not already
connected. May be null
.clazz
- the fully qualified name of the interface class that describes
the desired service. Must not be null
.filter
- The filter criteria. May be null
.
null
.public IRemoteServiceReference[] getAllRemoteServiceReferences(java.lang.String clazz, java.lang.String filter) throws org.osgi.framework.InvalidSyntaxException
IRemoteServiceConsumer
Returns an array of IRemoteServiceReference
objects. The
returned array of IRemoteServiceReference
objects contains
services that were registered under the specified class, or if the clazz
parameter is null
all services registered.
The list is valid at the time of the call to this method, however since the remote service container is a very dynamic environment, services can be modified or unregistered at anytime.
filter
is used to select the registered service whose
properties objects contain keys and values which satisfy the filter. See
Filter
for a description of the filter string syntax.
If filter
is null
, all registered services
are considered to match the filter. If filter
cannot be
parsed, an InvalidSyntaxException
will be thrown with a human
readable message where the filter became unparsable.
getAllRemoteServiceReferences
in interface IRemoteServiceConsumer
getAllRemoteServiceReferences
in interface IRemoteServiceContainerAdapter
clazz
- the fully qualified name of the interface class that describes
the desired service. May be null
.filter
- The filter criteria. May be null
.
null
if no services are found that match the search.
org.osgi.framework.InvalidSyntaxException
- If filter contains an invalid filter string that cannot be parsed.public IRemoteServiceReference[] getRemoteServiceReferences(ID target, ID[] idFilter, java.lang.String clazz, java.lang.String filter) throws org.osgi.framework.InvalidSyntaxException, ContainerConnectException
IRemoteServiceConsumer
IRemoteServiceReference
objects. The
returned array of IRemoteServiceReference
objects contains
services that were registered under the specified class and match the
specified idFilter, and filter criteria.
Note this method assumes that the enclosing container has previously
been connected, and uses the idFilter to filter among targets within the
previously connected set of container IDs. To request connection as
part of reference lookup, see IRemoteServiceConsumer.getRemoteServiceReferences(ID, String, String)
.
The list is valid at the time of the call to this method, however since the Framework is a very dynamic environment, services can be modified or unregistered at anytime.
target
is a remote container to connect to. If null
, no connection attempt is made.
idFilter
is used to select a registered services that were
registered by a given set of containers with id in idFilter. Only
services exposed by a container with id in idFilter will be returned. If idFilter
is null
, all containers are
considered to match the filter.
filter
is used to select the registered service whose
properties objects contain keys and values which satisfy the filter. See
Filter
for a description of the filter string syntax.
If filter
is null
, all registered services
are considered to match the filter. If filter
cannot be
parsed, an InvalidSyntaxException
will be thrown with a human
readable message where the filter became unparsable.
getRemoteServiceReferences
in interface IRemoteServiceConsumer
getRemoteServiceReferences
in interface IRemoteServiceContainerAdapter
target
- a target container to connect to if enclosing container is not already
connected. May be null
.idFilter
- an array of ID instances that will restrict the search for
matching container ids If null, all remote containers will be
considered in search for matching IRemoteServiceReference
instances. May be null
.clazz
- the fully qualified name of the interface class that describes
the desired service. Must not be null
.filter
- The filter criteria. May be null
.
null
if no services are found that match the search.
org.osgi.framework.InvalidSyntaxException
- If filter contains an invalid filter string that cannot be parsed.
ContainerConnectException
public org.eclipse.equinox.concurrent.future.IFuture asyncGetRemoteServiceReferences(ID target, ID[] idFilter, java.lang.String clazz, java.lang.String filter)
IRemoteServiceConsumer
IRemoteServiceReference
objects. The
returned array of IRemoteServiceReference
objects contains
services that were registered under the specified class and match the
specified idFilter, and filter criteria.
The IFuture is returned immediately, and subsequent calls to IFuture.get()
or IFuture.get(long)
will return the actual results received. The type of
the Object returned from IFuture.get()
will be IRemoteServiceReference [].
The list is valid at the time of the call to this method, however since the Framework is a very dynamic environment, services can be modified or unregistered at anytime.
target
is a remote container to connect to. If null
, no connection attempt is made.
idFilter
is used to select a registered services that were
registered by a given set of containers with id in idFilter. Only
services exposed by a container with id in idFilter will be returned. If idFilter
is null
, all containers are
considered to match the filter.
filter
is used to select the registered service whose
properties objects contain keys and values which satisfy the filter. See
Filter
for a description of the filter string syntax.
If filter
is null
, all registered services
are considered to match the filter. If filter
cannot be
parsed, an InvalidSyntaxException
will be thrown with a human
readable message where the filter became unparsable.
asyncGetRemoteServiceReferences
in interface IRemoteServiceConsumer
asyncGetRemoteServiceReferences
in interface IRemoteServiceContainerAdapter
target
- an target to connect to if enclosing container is not already
connected. May be null
.idFilter
- an array of ID instances that will restrict the search for
matching container ids If null, all remote containers will be
considered in search for matching IRemoteServiceReference
instances. May be null
.clazz
- the fully qualified name of the interface class that describes
the desired service. Must not be null
.filter
- The filter criteria. May be null
.
null
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |