org.osgi.service.framework

Interface SurrogateBundle

All Superinterfaces:

Bundle, Comparable<Bundle>

All Known Implementing Classes:

SurrogateImpl

Deprecated.

This API proposal was rejected by the OSGi Alliance and will not be part of any OSGi specification. Please transition to the org.osgi.framework.hooks API to control resolution, bundle, and service isolation. This API will be removed from Equinox in the 3.9 release You are cautioned against relying upon this API.

public interface SurrogateBundle
extends Bundle

A surrogate bundle is installed in a child framework, and is the child-facing representation of the composite bundle in the parent framework.

A surrogate bundle does the following as specified by the composite manifest:

• Exports packages to the child framework from the parent framework. These packages are imported by the composite bundle installed in the parent framework.
• Imports packages from the child framework. These packages are exported by the composite bundle installed in the parent framework.
• Registers services from the parent framework with the child framework. These services are acquired by the composite bundle installed in the parent framework.
• Acquires services from the child framework. These services are registered by the composite bundle installed in the parent framework.

See Also:

CompositeBundle

Field Summary

Fields inherited from interface org.osgi.framework.Bundle

ACTIVE, INSTALLED, RESOLVED, SIGNERS_ALL, SIGNERS_TRUSTED, START_ACTIVATION_POLICY, START_TRANSIENT, STARTING, STOP_TRANSIENT, STOPPING, UNINSTALLED

Method Summary

Methods

Modifier and Type	Method and Description
BundleContext	getCompositeBundleContext() Deprecated. Returns the bundle context of the associated composite bundle.
void	uninstall() Deprecated. This operation is not supported for surrogate bundles.
void	update() Deprecated. This operation is not supported for surrogate bundles.
void	update(InputStream input) Deprecated. This operation is not supported for surrogate bundles.

Methods inherited from interface org.osgi.framework.Bundle

adapt, findEntries, getBundleContext, getBundleId, getDataFile, getEntry, getEntryPaths, getHeaders, getHeaders, getLastModified, getLocation, getRegisteredServices, getResource, getResources, getServicesInUse, getSignerCertificates, getState, getSymbolicName, getVersion, hasPermission, loadClass, start, start, stop, stop

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getCompositeBundleContext

BundleContext getCompositeBundleContext()

Deprecated.

Returns the bundle context of the associated composite bundle.

Returns:

the bundle context of the composite bundle. A value of null is returned if the composite bundle does not have a valid bundle context.

update

void update()
            throws BundleException

Deprecated.

This operation is not supported for surrogate bundles. A BundleException of type invalid operation must be thrown.

Specified by:

update in interface Bundle

Throws:

BundleException - If this bundle could not be updated. BundleException types thrown by this method include: BundleException.READ_ERROR, BundleException.DUPLICATE_BUNDLE_ERROR, BundleException.MANIFEST_ERROR, BundleException.NATIVECODE_ERROR, BundleException.RESOLVE_ERROR, BundleException.STATECHANGE_ERROR, and BundleException.ACTIVATOR_ERROR.

See Also:

Bundle.update(InputStream)

update

void update(InputStream input)
            throws BundleException

Deprecated.

This operation is not supported for surrogate bundles. A BundleException of type invalid operation must be thrown.

Specified by:

update in interface Bundle

Parameters:

input - The InputStream from which to read the new bundle or null to indicate the Framework must create the input stream from this bundle's Bundle-UpdateLocation Manifest header, if present, or this bundle's original location. The input stream must always be closed when this method completes, even if an exception is thrown.

Throws:

BundleException - If this bundle could not be updated. BundleException types thrown by this method include: BundleException.READ_ERROR, BundleException.DUPLICATE_BUNDLE_ERROR, BundleException.MANIFEST_ERROR, BundleException.NATIVECODE_ERROR, BundleException.RESOLVE_ERROR, BundleException.STATECHANGE_ERROR, and BundleException.ACTIVATOR_ERROR.

See Also:

Bundle.stop(), Bundle.start()

uninstall

void uninstall()
               throws BundleException

Deprecated.

This operation is not supported for surrogate bundles. A BundleException of type invalid operation must be thrown.

Specified by:

uninstall in interface Bundle

Throws:

BundleException - If the uninstall failed. This can occur if another thread is attempting to change this bundle's state and does not complete in a timely manner. BundleException types thrown by this method include: BundleException.STATECHANGE_ERROR

See Also:

Bundle.stop()