org.ops4j.pax.scanner
Interface InstallableBundle

All Known Implementing Classes:
InstallableBundleImpl

public interface InstallableBundle

A bundle that can be iterated, installed and/or started.

Since:
August 17, 2007
Author:
Alin Dreghiciu

Method Summary
 org.osgi.framework.Bundle getBundle()
          Return the installed bundle.
 InstallableBundle install()
          Installs the bundle.
 InstallableBundle start()
          Starts the installed bundle regardles the fact that the bundle was marked that it should not start.
 InstallableBundle startIfNecessary()
          Starts the installed bundle if the bundle should be started.
 

Method Detail

getBundle

org.osgi.framework.Bundle getBundle()
Return the installed bundle. If the bunndle was not installed returns null.

Returns:
the installed bundle

install

InstallableBundle install()
                          throws org.osgi.framework.BundleException
Installs the bundle.

Returns:
itself, for fluent api usage
Throws:
org.osgi.framework.BundleException - if the bundle could not be installed

startIfNecessary

InstallableBundle startIfNecessary()
                                   throws org.osgi.framework.BundleException
Starts the installed bundle if the bundle should be started. If the bundle was not installed before it will first try to install the bundle.

Returns:
itself, for fluent api usage
Throws:
org.osgi.framework.BundleException - if the bundle could not be installed

start

InstallableBundle start()
                        throws org.osgi.framework.BundleException
Starts the installed bundle regardles the fact that the bundle was marked that it should not start. If the bundle was not installed before it will first try to install the bundle.

Returns:
itself, for fluent api usage
Throws:
org.osgi.framework.BundleException - if the bundle could not be installed


Copyright © 2006-2011 OPS4J - Open Participation Software for Java. All Rights Reserved.