org.ops4j.pax.exam.rbc.internal

Interface RemoteBundleContext

All Superinterfaces:

Remote

All Known Implementing Classes:

RemoteBundleContextImpl

public interface RemoteBundleContext
extends Remote

Remote BundleContext like access.

TODO: this is probably somewhat too fluffy (too shaky interface) - improve here

Since:

0.3.0, December 10, 2008

Author:

Alin Dreghiciu (adreghiciu@gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
static long	NO_WAIT Timeout specifing that there should be no waiting.
static long	WAIT_FOREVER Timeout specifing that it should wait forever.

Method Summary

Modifier and Type	Method and Description
long	installBundle(String bundleUrl) Installs a bundle remotly.
long	installBundle(String bundleLocation, byte[] bundle) Installs a bundle remotly given the bundle content.
Object	remoteCall(Class<?> serviceType, String methodName, Class<?>[] methodParamTypes, String filter, org.ops4j.pax.exam.RelativeTimeout timeout, Object... actualParams) Makes a remote call on a service.
void	setBundleStartLevel(long bundleId, int startLevel) Sets bundle start level.
void	startBundle(long bundleId) Starts a bundle.
void	stopBundle(long bundleId) Stops a bundle.
void	uninstallBundle(long id)
void	waitForState(long bundleId, int state, org.ops4j.pax.exam.RelativeTimeout timeout) Waits for a bundle to be in a certain state and returns.

Field Detail

NO_WAIT

static final long NO_WAIT

Timeout specifing that there should be no waiting.

See Also:

Constant Field Values

WAIT_FOREVER

static final long WAIT_FOREVER

Timeout specifing that it should wait forever.

See Also:

Constant Field Values

Method Detail

remoteCall

Object remoteCall(Class<?> serviceType,
                  String methodName,
                  Class<?>[] methodParamTypes,
                  String filter,
                  org.ops4j.pax.exam.RelativeTimeout timeout,
                  Object... actualParams)
           throws RemoteException,
                  NoSuchServiceException,
                  NoSuchMethodException,
                  IllegalAccessException,
                  InvocationTargetException

Makes a remote call on a service.

Parameters:

serviceType - service class of the remote service

methodName - method name

methodParamTypes - method parameters types

filter - service filter

timeout - timeout for looking up the service

actualParams - actual parameters (must match the given method params)

Returns:

remote call rsult

Throws:

NoSuchServiceException - - If a service of the specified type cannot be located

NoSuchMethodException - - If the given method cannot be found

IllegalAccessException - - Specified method cannot be accessed

InvocationTargetException - - Wraps an eventual exception occured during method invocation

RemoteException - - Remote communication related exception (mandatory by RMI)

installBundle

long installBundle(String bundleUrl)
            throws RemoteException,
                   org.osgi.framework.BundleException

Installs a bundle remotly.

Parameters:

bundleUrl - url of the bundle to be installed. The url must be accessible from the remote OSGi container.

Returns:

bundle id of the installed bundle

Throws:

RemoteException - - Remote communication related exception (mandatory by RMI)

org.osgi.framework.BundleException - - Re-thrown from installing the bundle

installBundle

long installBundle(String bundleLocation,
                   byte[] bundle)
            throws RemoteException,
                   org.osgi.framework.BundleException

Installs a bundle remotly given the bundle content.

Parameters:

bundleLocation - bundle location

bundle - bundle content as a byte array

Returns:

bundle id of the installed bundle

Throws:

RemoteException - - Remote communication related exception (mandatory by RMI)

org.osgi.framework.BundleException - - Re-thrown from installing the bundle

startBundle

void startBundle(long bundleId)
          throws RemoteException,
                 org.osgi.framework.BundleException

Starts a bundle.

Parameters:

bundleId - id of the bundle to be started

Throws:

RemoteException - - Remote communication related exception (mandatory by RMI)

org.osgi.framework.BundleException - - Re-thrown from starting the bundle

stopBundle

void stopBundle(long bundleId)
         throws RemoteException,
                org.osgi.framework.BundleException

Stops a bundle.

Parameters:

bundleId - id of the bundle to be stopped

Throws:

RemoteException - - Remote communication related exception (mandatory by RMI)

org.osgi.framework.BundleException - - Re-thrown from stopping the bundle

setBundleStartLevel

void setBundleStartLevel(long bundleId,
                         int startLevel)
                  throws RemoteException,
                         org.osgi.framework.BundleException

Sets bundle start level.

Parameters:

bundleId - id of the bundle to which the start level should be set

startLevel - bundle start level

Throws:

RemoteException - - Remote communication related exception (mandatory by RMI)

org.osgi.framework.BundleException - - If bundle level cannot be set

waitForState

void waitForState(long bundleId,
                  int state,
                  org.ops4j.pax.exam.RelativeTimeout timeout)
           throws RemoteException,
                  org.osgi.framework.BundleException

Waits for a bundle to be in a certain state and returns.

Parameters:

bundleId - bundle id

state - expected state

timeout - max time to wait for state

Throws:

RemoteException - - Remote communication related exception (mandatory by RMI)

org.osgi.framework.BundleException - - If bundle cannot be found

org.ops4j.pax.exam.TimeoutException - - if timeout occured and expected state has not being reached

uninstallBundle

void uninstallBundle(long id)
              throws RemoteException,
                     org.osgi.framework.BundleException

Parameters:

id - of bundle to uninstall

Throws:

RemoteException - - Remote communication related exception (mandatory by RMI)

org.osgi.framework.BundleException - - If bundle cannot be found