org.osgi.service.clusterinfo

Interface FrameworkManager

All Known Subinterfaces:

FrameworkNodeStatus

public interface FrameworkManager

Provides a management interface for accessing and managing a remote OSGi framework. This interface can be accessed remotely via Remote Services.

Method Summary

Modifier and Type	Method and Description
BundleDTO	getBundle(long id) Retrieve the bundle representation for a given bundle Id.
java.util.Map<java.lang.String,java.lang.String>	getBundleHeaders(long id) Get the header for a bundle given by its bundle Id.
java.util.Collection<BundleDTO>	getBundles() Get the bundle representations for all bundles currently installed in the managed framework.
BundleStartLevelDTO	getBundleStartLevel(long id) Get the start level for a bundle given by its bundle Id.
int	getBundleState(long id) Get the state for a given bundle Id.
FrameworkStartLevelDTO	getFrameworkStartLevel() Retrieves the current framework start level.
ServiceReferenceDTO	getServiceReference(long id) Get the service representation for a service given by its service Id.
java.util.Collection<ServiceReferenceDTO>	getServiceReferences() Get the service representations for all services.
java.util.Collection<ServiceReferenceDTO>	getServiceReferences(java.lang.String filter) Get the service representations for all services.
BundleDTO	installBundle(java.lang.String location) Install a new bundle given by an externally reachable location string, typically describing a URL.
void	setBundleStartLevel(long id, int startLevel) Set the start level for a bundle given by its bundle Id.
void	setFrameworkStartLevel(FrameworkStartLevelDTO startLevel) Sets the current framework start level.
void	startBundle(long id) Start a bundle given by its bundle Id.
void	startBundle(long id, int options) Start a bundle given by its bundle Id.
void	stopBundle(long id) Stop a bundle given by its bundle Id.
void	stopBundle(long id, int options) Stop a bundle given by its bundle Id.
BundleDTO	uninstallBundle(long id) Uninstall a bundle given by its bundle Id.
BundleDTO	updateBundle(long id) Updates a bundle given by its bundle Id using the bundle-internal update location.
BundleDTO	updateBundle(long id, java.lang.String url) Updates a bundle given by its URI path using the content at the specified URL.

Method Detail

getBundle

BundleDTO getBundle(long id)
             throws java.lang.Exception

Retrieve the bundle representation for a given bundle Id.

Parameters:

id - Addresses the bundle by its identifier.

Returns:

A BundleDTO for the requested bundle.

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

getBundleHeaders

java.util.Map<java.lang.String,java.lang.String> getBundleHeaders(long id)
                                                           throws java.lang.Exception

Get the header for a bundle given by its bundle Id.

Parameters:

id - Addresses the bundle by its identifier.

Returns:

Returns the map of headers entries.

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

getBundles

java.util.Collection<BundleDTO> getBundles()
                                    throws java.lang.Exception

Get the bundle representations for all bundles currently installed in the managed framework.

Returns:

Returns a collection of BundleDTO objects.

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

getBundleStartLevel

BundleStartLevelDTO getBundleStartLevel(long id)
                                 throws java.lang.Exception

Get the start level for a bundle given by its bundle Id.

Parameters:

id - Addresses the bundle by its identifier.

Returns:

Returns a BundleStartLevelDTO describing the current start level of the bundle.

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

getBundleState

int getBundleState(long id)
            throws java.lang.Exception

Get the state for a given bundle Id.

Parameters:

id - Addresses the bundle by its identifier.

Returns:

Returns the current bundle state as defined in Bundle.

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

getFrameworkStartLevel

FrameworkStartLevelDTO getFrameworkStartLevel()
                                       throws java.lang.Exception

Retrieves the current framework start level.

Returns:

Returns the current framework start level in the form of a FrameworkStartLevelDTO.

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

getServiceReference

ServiceReferenceDTO getServiceReference(long id)
                                 throws java.lang.Exception

Get the service representation for a service given by its service Id.

Parameters:

id - Addresses the service by its identifier.

Returns:

The service representation as ServiceReferenceDTO.

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

getServiceReferences

java.util.Collection<ServiceReferenceDTO> getServiceReferences()
                                                        throws java.lang.Exception

Get the service representations for all services.

Returns:

Returns the service representations in the form of ServiceReferenceDTO objects.

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

getServiceReferences

java.util.Collection<ServiceReferenceDTO> getServiceReferences(java.lang.String filter)
                                                        throws java.lang.Exception

Get the service representations for all services.

Parameters:

filter - Passes a filter to restrict the result set.

Returns:

Returns the service representations in the form of ServiceReferenceDTO objects.

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

installBundle

BundleDTO installBundle(java.lang.String location)
                 throws java.lang.Exception

Install a new bundle given by an externally reachable location string, typically describing a URL.

Parameters:

location - Passes the location string to retrieve the bundle content from.

Returns:

Returns the BundleDTO of the newly installed bundle.

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

setBundleStartLevel

void setBundleStartLevel(long id,
                         int startLevel)
                  throws java.lang.Exception

Set the start level for a bundle given by its bundle Id.

Parameters:

id - Addresses the bundle by its identifier.

startLevel - The target start level.

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

setFrameworkStartLevel

void setFrameworkStartLevel(FrameworkStartLevelDTO startLevel)
                     throws java.lang.Exception

Sets the current framework start level.

Parameters:

startLevel - set the framework start level to this target.

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

startBundle

void startBundle(long id)
          throws java.lang.Exception

Start a bundle given by its bundle Id.

Parameters:

id - Addresses the bundle by its identifier.

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

startBundle

void startBundle(long id,
                 int options)
          throws java.lang.Exception

Start a bundle given by its bundle Id.

Parameters:

id - Addresses the bundle by its identifier.

options - Passes additional options as defined in Bundle.start(int)

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

stopBundle

void stopBundle(long id)
         throws java.lang.Exception

Stop a bundle given by its bundle Id.

Parameters:

id - Addresses the bundle by its identifier.

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

stopBundle

void stopBundle(long id,
                int options)
         throws java.lang.Exception

Stop a bundle given by its bundle Id.

Parameters:

id - Addresses the bundle by its identifier.

options - Passes additional options as defined in Bundle.stop(int)

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

uninstallBundle

BundleDTO uninstallBundle(long id)
                   throws java.lang.Exception

Uninstall a bundle given by its bundle Id.

Parameters:

id - Addresses the bundle by its identifier.

Returns:

Returns the BundleDTO of the uninstalled bundle.

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

updateBundle

BundleDTO updateBundle(long id)
                throws java.lang.Exception

Updates a bundle given by its bundle Id using the bundle-internal update location.

Parameters:

id - Addresses the bundle by its identifier.

Returns:

Returns the BundleDTO of the updated bundle.

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.

updateBundle

BundleDTO updateBundle(long id,
                       java.lang.String url)
                throws java.lang.Exception

Updates a bundle given by its URI path using the content at the specified URL.

Parameters:

id - Addresses the bundle by its identifier.

url - The URL whose content is to be used to update the bundle.

Returns:

Returns the BundleDTO of the updated bundle.

Throws:

java.lang.Exception - An exception representing a failure in the underlying remote call.