summaryrefslogtreecommitdiffstats
path: root/site/site-publish/doc/javadoc/java-sca-1.4/org/apache/tuscany/sca/core/ModuleActivator.html
blob: 4462aa6639a5255d15602b7880ee0424578a0697 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_11) on Tue Jan 27 20:37:57 CST 2009 -->
<TITLE>
ModuleActivator
</TITLE>

<META NAME="date" CONTENT="2009-01-27">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="ModuleActivator";
    }
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();">
<HR>


<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/tuscany/sca/core/ExtensionPointRegistry.html" title="interface in org.apache.tuscany.sca.core"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/tuscany/sca/core/ModuleActivatorExtensionPoint.html" title="interface in org.apache.tuscany.sca.core"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html?org/apache/tuscany/sca/core/ModuleActivator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ModuleActivator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->

<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.tuscany.sca.core</FONT>
<BR>
Interface ModuleActivator</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/tuscany/sca/extension/helper/impl/BindingsActivator.html" title="class in org.apache.tuscany.sca.extension.helper.impl">BindingsActivator</A>, <A HREF="../../../../../org/apache/tuscany/sca/host/corba/jee/CorbaRuntimeModuleActivator.html" title="class in org.apache.tuscany.sca.host.corba.jee">CorbaRuntimeModuleActivator</A>, <A HREF="../../../../../org/apache/tuscany/sca/host/corba/jse/CorbaRuntimeModuleActivator.html" title="class in org.apache.tuscany.sca.host.corba.jse">CorbaRuntimeModuleActivator</A>, <A HREF="../../../../../org/apache/tuscany/sca/host/corba/jse/tns/CorbaRuntimeModuleActivator.html" title="class in org.apache.tuscany.sca.host.corba.jse.tns">CorbaRuntimeModuleActivator</A>, <A HREF="../../../../../org/apache/tuscany/sca/core/databinding/module/DataBindingModuleActivator.html" title="class in org.apache.tuscany.sca.core.databinding.module">DataBindingModuleActivator</A>, <A HREF="../../../../../org/apache/tuscany/sca/extension/helper/impl/ImplementationsActivator.html" title="class in org.apache.tuscany.sca.extension.helper.impl">ImplementationsActivator</A>, <A HREF="../../../../../org/apache/tuscany/sca/implementation/java/impl/JavaImplementationActivator.html" title="class in org.apache.tuscany.sca.implementation.java.impl">JavaImplementationActivator</A>, <A HREF="../../../../../org/apache/tuscany/sca/implementation/java/module/JavaRuntimeModuleActivator.html" title="class in org.apache.tuscany.sca.implementation.java.module">JavaRuntimeModuleActivator</A>, <A HREF="../../../../../org/apache/tuscany/sca/http/jetty/module/JettyRuntimeModuleActivator.html" title="class in org.apache.tuscany.sca.http.jetty.module">JettyRuntimeModuleActivator</A>, <A HREF="../../../../../org/apache/tuscany/sca/binding/sca/jms/JMSBroker.html" title="class in org.apache.tuscany.sca.binding.sca.jms">JMSBroker</A>, <A HREF="../../../../../org/apache/tuscany/sca/implementation/java/impl/JSR250Activator.html" title="class in org.apache.tuscany.sca.implementation.java.impl">JSR250Activator</A>, <A HREF="../../../../../org/apache/tuscany/sca/binding/notification/NotificationBindingModuleActivator.html" title="class in org.apache.tuscany.sca.binding.notification">NotificationBindingModuleActivator</A>, <A HREF="../../../../../org/apache/tuscany/sca/implementation/notification/NotificationModuleActivator.html" title="class in org.apache.tuscany.sca.implementation.notification">NotificationModuleActivator</A>, <A HREF="../../../../../org/apache/tuscany/sca/osgi/runtime/OSGiRuntimeModuleActivator.html" title="class in org.apache.tuscany.sca.osgi.runtime">OSGiRuntimeModuleActivator</A>, <A HREF="../../../../../org/apache/tuscany/sca/http/tomcat/module/TomcatRuntimeModuleActivator.html" title="class in org.apache.tuscany.sca.http.tomcat.module">TomcatRuntimeModuleActivator</A>, <A HREF="../../../../../org/apache/tuscany/sca/policy/transaction/TransactionModuleActivator.html" title="class in org.apache.tuscany.sca.policy.transaction">TransactionModuleActivator</A>, <A HREF="../../../../../org/apache/tuscany/sca/host/webapp/WebAppModuleActivator.html" title="class in org.apache.tuscany.sca.host.webapp">WebAppModuleActivator</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>ModuleActivator</B></DL>
</PRE>

<P>
ModuleActivator represents a module that plugs into the Tuscany system. Each 
 module should provide an implementation of this interface and register the 
 ModuleActivator implementation class by defining a file named 
 
 "META-INF/services/org.apache.tuscany.core.ModuleActivator"
 
 The content of the file is the class name of the ModuleActivator implementation. 
 The implementation class must have a no-arg constructor. The same instance 
 will be used to invoke all the methods during different phases of the module 
 activation. Note that the start and stop methods defined by this interface
 take a reference to the Tuscany SCA runtime ExtensionPointRegistry. This 
 gives the ModuleActivator the opportunity to add extension points to the
 registry as it is requested to start up and remove them when it is requested
 to shut down.
<P>

<P>
<HR>

<P>

<!-- ========== METHOD SUMMARY =========== -->

<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/core/ModuleActivator.html#start(org.apache.tuscany.sca.core.ExtensionPointRegistry)">start</A></B>(<A HREF="../../../../../org/apache/tuscany/sca/core/ExtensionPointRegistry.html" title="interface in org.apache.tuscany.sca.core">ExtensionPointRegistry</A>&nbsp;registry)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is invoked when the module is started by the Tuscany system.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/tuscany/sca/core/ModuleActivator.html#stop(org.apache.tuscany.sca.core.ExtensionPointRegistry)">stop</A></B>(<A HREF="../../../../../org/apache/tuscany/sca/core/ExtensionPointRegistry.html" title="interface in org.apache.tuscany.sca.core">ExtensionPointRegistry</A>&nbsp;registry)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is invoked when the module is stopped by the Tuscany system.</TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="start(org.apache.tuscany.sca.core.ExtensionPointRegistry)"><!-- --></A><H3>
start</H3>
<PRE>
void <B>start</B>(<A HREF="../../../../../org/apache/tuscany/sca/core/ExtensionPointRegistry.html" title="interface in org.apache.tuscany.sca.core">ExtensionPointRegistry</A>&nbsp;registry)</PRE>
<DL>
<DD>This method is invoked when the module is started by the Tuscany system.
 It can be used by this module to register extensions against extension
 points.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>registry</CODE> - The extension point registry</DL>
</DD>
</DL>
<HR>

<A NAME="stop(org.apache.tuscany.sca.core.ExtensionPointRegistry)"><!-- --></A><H3>
stop</H3>
<PRE>
void <B>stop</B>(<A HREF="../../../../../org/apache/tuscany/sca/core/ExtensionPointRegistry.html" title="interface in org.apache.tuscany.sca.core">ExtensionPointRegistry</A>&nbsp;registry)</PRE>
<DL>
<DD>This method is invoked when the module is stopped by the Tuscany system.
 It can be used by this module to unregister extensions against the
 extension points.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>registry</CODE> - The extension point registry</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../org/apache/tuscany/sca/core/ExtensionPointRegistry.html" title="interface in org.apache.tuscany.sca.core"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/tuscany/sca/core/ModuleActivatorExtensionPoint.html" title="interface in org.apache.tuscany.sca.core"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html?org/apache/tuscany/sca/core/ModuleActivator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ModuleActivator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>