org.osgi.service.framework.SurrogateBundle Maven / Gradle / Ivy
/*
* Copyright (c) OSGi Alliance (2008, 2009). All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.osgi.service.framework;
import java.io.InputStream;
import org.osgi.framework.*;
/**
* 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 CompositeBundle
* @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 {
/**
* Returns the bundle context of the associated composite bundle.
* @return the bundle context of the composite bundle. A value
* of null is returned if the composite bundle does
* not have a valid bundle context.
*/
BundleContext getCompositeBundleContext();
/**
* This operation is not supported for surrogate bundles. A
* BundleException of type
* {@link BundleException#INVALID_OPERATION invalid operation} must be
* thrown.
*/
void update() throws BundleException;
/**
* This operation is not supported for surrogate bundles. A
* BundleException of type
* {@link BundleException#INVALID_OPERATION invalid operation} must be
* thrown.
*/
void update(InputStream input) throws BundleException;
/**
* This operation is not supported for surrogate bundles. A
* BundleException of type
* {@link BundleException#INVALID_OPERATION invalid operation} must be
* thrown.
*/
void uninstall() throws BundleException;
}