org.ops4j.pax.swissbox.framework

Class RemoteFrameworkImpl

java.lang.Object

org.ops4j.pax.swissbox.framework.RemoteFrameworkImpl

All Implemented Interfaces:

Remote, RemoteFramework

public class RemoteFrameworkImpl
extends Object
implements RemoteFramework

Implements the RemoteFramework interface by instantiating a local Framework, exporting it via an RMI registry and delegating all remote calls to the local framework.

Author:

Harald Wellmann

Field Summary

Fields inherited from interface org.ops4j.pax.swissbox.framework.RemoteFramework

RMI_NAME_KEY, RMI_PORT_KEY, TIMEOUT_KEY

Constructor Summary

Constructors

Constructor and Description
RemoteFrameworkImpl(Map<String,String> frameworkProperties)

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.
org.osgi.framework.launch.FrameworkFactory	findFrameworkFactory()
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[] bundleData) 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
static void	main(String[] args)
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteFrameworkImpl

public RemoteFrameworkImpl(Map<String,String> frameworkProperties)
                    throws RemoteException,
                           AlreadyBoundException,
                           org.osgi.framework.BundleException

Throws:

RemoteException

AlreadyBoundException

org.osgi.framework.BundleException

Method Detail

init

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

Description copied from interface: RemoteFramework

Initializes the framework.

Specified by:

init in interface RemoteFramework

Throws:

RemoteException

org.osgi.framework.BundleException

See Also:

Framework#init}

start

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

Description copied from interface: RemoteFramework

Starts the framework.

Specified by:

start in interface RemoteFramework

Throws:

RemoteException

org.osgi.framework.BundleException

See Also:

Framework#start}

stop

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

Description copied from interface: RemoteFramework

Stops the framework.

Specified by:

stop in interface RemoteFramework

Throws:

RemoteException

org.osgi.framework.BundleException

See Also:

Framework#start}

installBundle

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

Description copied from interface: RemoteFramework

Installs a bundle remotely.

Specified by:

installBundle in interface RemoteFramework

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

public long installBundle(String bundleUrl,
                 boolean start,
                 int startLevel)
                   throws RemoteException,
                          org.osgi.framework.BundleException

Description copied from interface: RemoteFramework

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

Specified by:

installBundle in interface RemoteFramework

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

public long installBundle(String bundleLocation,
                 byte[] bundleData,
                 boolean start,
                 int startLevel)
                   throws RemoteException,
                          org.osgi.framework.BundleException

Description copied from interface: RemoteFramework

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

Specified by:

installBundle in interface RemoteFramework

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

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

Description copied from interface: RemoteFramework

Installs a bundle remotely, given the bundle content.

Specified by:

installBundle in interface RemoteFramework

Parameters:

bundleLocation - The location identifier of the bundle to install

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

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

Description copied from interface: RemoteFramework

Starts a bundle.

Specified by:

startBundle in interface RemoteFramework

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

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

Description copied from interface: RemoteFramework

Stops a bundle.

Specified by:

stopBundle in interface RemoteFramework

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

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

Description copied from interface: RemoteFramework

Sets bundle start level.

Specified by:

setBundleStartLevel in interface RemoteFramework

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

uninstallBundle

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

Specified by:

uninstallBundle in interface RemoteFramework

Parameters:

id - of bundle to uninstall

Throws:

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

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

findFrameworkFactory

public org.osgi.framework.launch.FrameworkFactory findFrameworkFactory()

callService

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

Description copied from interface: RemoteFramework

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.

Specified by:

callService in interface RemoteFramework

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

setFrameworkStartLevel

public void setFrameworkStartLevel(int startLevel)
                            throws RemoteException

Description copied from interface: RemoteFramework

Sets the framework startlevel.

Specified by:

setFrameworkStartLevel in interface RemoteFramework

Throws:

RemoteException

See Also:

StartLevel#setStartLevel(int)}

setFrameworkStartLevel

public boolean setFrameworkStartLevel(int startLevel,
                             long timeout)
                               throws RemoteException

Description copied from interface: RemoteFramework

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

Specified by:

setFrameworkStartLevel in interface RemoteFramework

Returns:

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

Throws:

RemoteException

See Also:

StartLevel#setStartLevel(int)}

waitForState

public void waitForState(long bundleId,
                int state,
                long timeoutInMillis)
                  throws RemoteException,
                         org.osgi.framework.BundleException

Description copied from interface: RemoteFramework

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

Specified by:

waitForState in interface RemoteFramework

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

getBundleState

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

Description copied from interface: RemoteFramework

Returns the state of the bundle with the given ID.

Specified by:

getBundleState in interface RemoteFramework

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()}

getServiceReferences

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

Description copied from interface: RemoteFramework

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

Specified by:

getServiceReferences in interface RemoteFramework

Returns:

Throws:

RemoteException

org.osgi.framework.BundleException

org.osgi.framework.InvalidSyntaxException

getServiceReferences

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

Description copied from interface: RemoteFramework

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

Specified by:

getServiceReferences in interface RemoteFramework

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

invokeMethodOnService

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

Description copied from interface: RemoteFramework

Invokes a method on this reference in the remote framework

Specified by:

invokeMethodOnService in interface RemoteFramework

Returns:

Throws:

RemoteException

Exception

invokeMethodOnService

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

Description copied from interface: RemoteFramework

Invokes a method on this reference in the remote framework

Specified by:

invokeMethodOnService in interface RemoteFramework

Returns:

Throws:

RemoteException

Exception

main

public static void main(String[] args)
                 throws RemoteException,
                        AlreadyBoundException,
                        org.osgi.framework.BundleException,
                        InterruptedException

Throws:

RemoteException

AlreadyBoundException

org.osgi.framework.BundleException

InterruptedException