annotate org.eclipse.osgi/osgi/src/org/osgi/framework/BundleActivator.d @ 105:bbe49769ec18

...
author Frank Benoit <benoit@tionex.de>
date Sun, 08 Nov 2009 12:42:30 +0100
parents 12b890a6392a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
86
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * $Header: /cvshome/build/org.osgi.framework/src/org/osgi/framework/BundleActivator.java,v 1.14 2007/02/21 16:49:05 hargrave Exp $
105
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
3 *
86
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * Copyright (c) OSGi Alliance (2000, 2007). All Rights Reserved.
105
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
5 *
86
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * Licensed under the Apache License, Version 2.0 (the "License");
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 * you may not use this file except in compliance with the License.
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * You may obtain a copy of the License at
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 *
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 * http://www.apache.org/licenses/LICENSE-2.0
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 *
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 * Unless required by applicable law or agreed to in writing, software
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 * distributed under the License is distributed on an "AS IS" BASIS,
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 * See the License for the specific language governing permissions and
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 * limitations under the License.
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 */
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18
105
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
19 // Port to the D programming language:
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
20 // Frank Benoit <benoit@tionex.de>
86
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 module org.osgi.framework.BundleActivator;
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 import java.lang.all;
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24
105
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
25 import org.osgi.framework.BundleContext; // packageimport
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
26
86
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 /**
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * Customizes the starting and stopping of a bundle.
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * <p>
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * <code>BundleActivator</code> is an interface that may be implemented when a
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * bundle is started or stopped. The Framework can create instances of a
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * bundle's <code>BundleActivator</code> as required. If an instance's
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * <code>BundleActivator.start</code> method executes successfully, it is
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * guaranteed that the same instance's <code>BundleActivator.stop</code>
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * method will be called when the bundle is to be stopped. The Framework must
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * not concurrently call a <code>BundleActivator</code> object.
105
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
37 *
86
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * <p>
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * <code>BundleActivator</code> is specified through the
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * <code>Bundle-Activator</code> Manifest header. A bundle can only specify a
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * single <code>BundleActivator</code> in the Manifest file. Fragment bundles
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 * must not have a <code>BundleActivator</code>. The form of the Manifest
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 * header is:
105
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
44 *
86
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 * <p>
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 * <code>Bundle-Activator: <i>class-name</i></code>
105
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
47 *
86
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 * <p>
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 * where <code><i>class-name</i></code> is a fully qualified Java classname.
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * <p>
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * The specified <code>BundleActivator</code> class must have a public
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * constructor that takes no parameters so that a <code>BundleActivator</code>
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 * object can be created by <code>Class.newInstance()</code>.
105
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
54 *
86
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 * @NotThreadSafe
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 * @version $Revision: 1.14 $
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 */
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 public interface BundleActivator {
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 /**
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 * Called when this bundle is started so the Framework can perform the
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 * bundle-specific activities necessary to start this bundle. This method
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 * can be used to register services or to allocate any resources that this
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 * bundle needs.
105
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
65 *
86
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 * <p>
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 * This method must complete and return to its caller in a timely manner.
105
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
68 *
86
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * @param context The execution context of the bundle being started.
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 * @throws java.lang.Exception If this method throws an exception, this
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 * bundle is marked as stopped and the Framework will remove this
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 * bundle's listeners, unregister all services registered by this
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 * bundle, and release all services used by this bundle.
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 */
105
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
75 public void start(BundleContext context) ;
86
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 /**
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 * Called when this bundle is stopped so the Framework can perform the
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 * bundle-specific activities necessary to stop the bundle. In general, this
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 * method should undo the work that the <code>BundleActivator.start</code>
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 * method started. There should be no active threads that were started by
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 * this bundle when this bundle returns. A stopped bundle must not call any
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 * Framework objects.
105
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
84 *
86
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 * <p>
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 * This method must complete and return to its caller in a timely manner.
105
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
87 *
86
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 * @param context The execution context of the bundle being stopped.
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 * @throws java.lang.Exception If this method throws an exception, the
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 * bundle is still marked as stopped, and the Framework will remove
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 * the bundle's listeners, unregister all services registered by the
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 * bundle, and release all services used by the bundle.
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 */
105
Frank Benoit <benoit@tionex.de>
parents: 86
diff changeset
94 public void stop(BundleContext context) ;
86
12b890a6392a Work on databinding
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 }