org.ops4j.pax.swissbox.framework

Interface RemoteFramework

All Superinterfaces:

Remote

All Known Implementing Classes:

RemoteFrameworkImpl

public interface RemoteFramework
extends Remote

An RMI-capable variant of the OSGi Framework interface.

Author:

Harald Wellmann

Field Summary

Fields

Modifier and Type	Field and Description
static String	RMI_NAME_KEY System property key for the name to be used for the remote framework in the RMI registry.
static String	RMI_PORT_KEY System property key for RMI registry port.
static String	TIMEOUT_KEY System property key for the framework shutdown timeout (milliseconds in decimal representation).

Method Summary

Methods

Modifier and Type	Method and Description
void	callService(String filter, String methodName) Looks up a service matching the given filter and invokes a service method with the given name.
int	getBundleState(long bundleId) Returns the state of the bundle with the given ID.
RemoteServiceReference[]	getServiceReferences(String filter) Fetch an array of RemoteServiceReference to interact with them, this is a snapshot of the current state and must be recalled to update
RemoteServiceReference[]	getServiceReferences(String filter, long timeout, TimeUnit timeUnit) Fetch an array of RemoteServiceReference to interact with them, this is a snapshot of the current state and must be recalled to update
void	init() Initializes the framework.
long	installBundle(String bundleUrl) Installs a bundle remotely.
long	installBundle(String bundleUrl, boolean start, int startLevel) Installs a bundle remotely, sets its start level and optionally starts it.
long	installBundle(String bundleLocation, byte[] bundle) Installs a bundle remotely, given the bundle content.
long	installBundle(String bundleLocation, byte[] bundleData, boolean start, int startLevel) Installs a bundle remotely, given the bundle content, autostart it if requested and set its startlevel
Object	invokeMethodOnService(RemoteServiceReference reference, String methodName, Class<?>[] parameterTypes, Object[] args) Invokes a method on this reference in the remote framework
Object	invokeMethodOnService(RemoteServiceReference reference, String methodName, Object... args) Invokes a method on this reference in the remote framework
void	setBundleStartLevel(long bundleId, int startLevel) Sets bundle start level.
void	setFrameworkStartLevel(int startLevel) Sets the framework startlevel.
boolean	setFrameworkStartLevel(int startLevel, long timeout) Sets the framework startlevel and waits for at most the given timeout (in ms) for the startlevel to be reached.
void	start() Starts the framework.
void	startBundle(long bundleId) Starts a bundle.
void	stop() Stops the framework.
void	stopBundle(long bundleId) Stops a bundle.
void	uninstallBundle(long id)
void	waitForState(long bundleId, int state, long timeoutInMillis) Waits for a bundle to be in a certain state and returns.

Field Detail

RMI_PORT_KEY

static final String RMI_PORT_KEY

System property key for RMI registry port.

See Also:

Constant Field Values

RMI_NAME_KEY

static final String RMI_NAME_KEY

System property key for the name to be used for the remote framework in the RMI registry.

See Also:

Constant Field Values

TIMEOUT_KEY

static final String TIMEOUT_KEY

System property key for the framework shutdown timeout (milliseconds in decimal representation).

See Also:

Constant Field Values

Method Detail

init

void init()
          throws RemoteException,
                 org.osgi.framework.BundleException

Initializes the framework.

Throws:

RemoteException

org.osgi.framework.BundleException

See Also:

Framework#init}

start

void start()
           throws RemoteException,
                  org.osgi.framework.BundleException

Starts the framework.

Throws:

RemoteException

org.osgi.framework.BundleException

See Also:

Framework#start}

stop

void stop()
          throws RemoteException,
                 org.osgi.framework.BundleException

Stops the framework.

Throws:

RemoteException

org.osgi.framework.BundleException

See Also:

Framework#start}

installBundle

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

Installs a bundle remotely.

Parameters:

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

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 bundleUrl,
                 boolean start,
                 int startLevel)
                   throws RemoteException,
                          org.osgi.framework.BundleException

Installs a bundle remotely, sets its start level and optionally starts it.

Parameters:

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

start - indicates whether the bundle will be started

startLevel - start level for this bundle

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[] bundleData,
                 boolean start,
                 int startLevel)
                   throws RemoteException,
                          org.osgi.framework.BundleException

Installs a bundle remotely, given the bundle content, autostart it if requested and set its startlevel

Parameters:

bundleLocation - The location identifier of the bundle to install

bundleData - bundle content as a byte array

start - indicates whether the bundle will be started

startLevel - start level for this bundle

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 remotely, given the bundle content.

Parameters:

bundleLocation - The location identifier of the bundle to install

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,
                long timeoutInMillis)
                  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

timeoutInMillis - 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

callService

void callService(String filter,
               String methodName)
                 throws RemoteException,
                        org.osgi.framework.BundleException

Looks up a service matching the given filter and invokes a service method with the given name. The method is expected to have either a parameter of type Object[] or no parameters. It will be invoked with an empty argument list.

Parameters:

filter - LDAP service filter

methodName - service method name

Throws:

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

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

invokeMethodOnService

Object invokeMethodOnService(RemoteServiceReference reference,
                           String methodName,
                           Object... args)
                             throws RemoteException,
                                    Exception

Invokes a method on this reference in the remote framework

Parameters:

name -

args -

Returns:

Throws:

RemoteException

Exception

invokeMethodOnService

Object invokeMethodOnService(RemoteServiceReference reference,
                           String methodName,
                           Class<?>[] parameterTypes,
                           Object[] args)
                             throws RemoteException,
                                    Exception

Invokes a method on this reference in the remote framework

Parameters:

name -

args -

Returns:

Throws:

RemoteException

Exception

getServiceReferences

RemoteServiceReference[] getServiceReferences(String filter)
                                              throws RemoteException,
                                                     org.osgi.framework.BundleException,
                                                     org.osgi.framework.InvalidSyntaxException

Fetch an array of RemoteServiceReference to interact with them, this is a snapshot of the current state and must be recalled to update

Parameters:

filter -

Returns:

Throws:

RemoteException

org.osgi.framework.BundleException

org.osgi.framework.InvalidSyntaxException

getServiceReferences

RemoteServiceReference[] getServiceReferences(String filter,
                                            long timeout,
                                            TimeUnit timeUnit)
                                              throws RemoteException,
                                                     org.osgi.framework.BundleException,
                                                     org.osgi.framework.InvalidSyntaxException

Fetch an array of RemoteServiceReference to interact with them, this is a snapshot of the current state and must be recalled to update

Parameters:

filter -

timeout - wait the specified amout of time in relation to the timeunit for a service matchign the filter to appear

Returns:

Throws:

RemoteException

org.osgi.framework.BundleException

org.osgi.framework.InvalidSyntaxException

setFrameworkStartLevel

void setFrameworkStartLevel(int startLevel)
                            throws RemoteException

Sets the framework startlevel.

Parameters:

startLevel -

Throws:

RemoteException

See Also:

StartLevel#setStartLevel(int)}

setFrameworkStartLevel

boolean setFrameworkStartLevel(int startLevel,
                             long timeout)
                               throws RemoteException

Sets the framework startlevel and waits for at most the given timeout (in ms) for the startlevel to be reached.

Parameters:

startLevel -

Returns:

true if the start level has been reached within the given timeout

Throws:

RemoteException

See Also:

StartLevel#setStartLevel(int)}

getBundleState

int getBundleState(long bundleId)
                   throws RemoteException,
                          org.osgi.framework.BundleException

Returns the state of the bundle with the given ID.

Parameters:

bundleId - bundle ID

Returns:

state of bundle

Throws:

RemoteException

org.osgi.framework.BundleException - if there is no bundle with the given ID

See Also:

org.osgi.framework.Bundle#getState()}