| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>Module (Apache Axis2)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Module (Apache Axis2)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Module.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/axis2/modules/Module.html" target="_top">Frames</a></li> |
| <li><a href="Module.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.axis2.modules</div> |
| <h2 title="Interface Module" class="title">Interface Module</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/axis2/handlers/addressing/Addressing.html" title="class in org.apache.axis2.handlers.addressing">Addressing</a>, <a href="../../../../org/apache/axis2/jaxws/module/JAXWSModule.html" title="class in org.apache.axis2.jaxws.module">JAXWSModule</a>, <a href="../../../../org/apache/axis2/mex/MetadataExchangeModule.html" title="class in org.apache.axis2.mex">MetadataExchangeModule</a>, <a href="../../../../org/apache/axis2/mtompolicy/MTOMPolicy.html" title="class in org.apache.axis2.mtompolicy">MTOMPolicy</a>, <a href="../../../../org/apache/axis2/scripting/ScriptModule.html" title="class in org.apache.axis2.scripting">ScriptModule</a>, <a href="../../../../org/apache/axis2/handlers/soapmonitor/SOAPMonitorModule.html" title="class in org.apache.axis2.handlers.soapmonitor">SOAPMonitorModule</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">Module</span></pre> |
| <div class="block">Every module provides an implementation of this class. Modules are in one of |
| two states: "available" or "engaged". All modules that the runtime |
| detects (from the system modules/ directory or from other means) are said to |
| be in the "available" state. If some service indicates a dependency on this |
| module then the module is initialized (once for the life of the system) and |
| the state changes to "initialized". |
| <p/> |
| <p/>Any module which is in the "engaged" state can be engaged as needed |
| by the engine to respond to a message. Currently module engagement is done |
| via deployment (using module.xml). In the future we may engage modules |
| programmatically by introducing an engage() method to this interface, thereby |
| allowing more dynamic scenarios.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/modules/Module.html#applyPolicy(org.apache.neethi.Policy, org.apache.axis2.description.AxisDescription)">applyPolicy</a></strong>(org.apache.neethi.Policy policy, |
| <a href="../../../../org/apache/axis2/description/AxisDescription.html" title="class in org.apache.axis2.description">AxisDescription</a> axisDescription)</code> |
| <div class="block">Evaluates specified policy for the specified AxisDescription.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/modules/Module.html#canSupportAssertion(org.apache.neethi.Assertion)">canSupportAssertion</a></strong>(org.apache.neethi.Assertion assertion)</code> |
| <div class="block">Evaluate whether it can support the specified assertion and returns true if the assertion can |
| be supported.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/modules/Module.html#engageNotify(org.apache.axis2.description.AxisDescription)">engageNotify</a></strong>(<a href="../../../../org/apache/axis2/description/AxisDescription.html" title="class in org.apache.axis2.description">AxisDescription</a> axisDescription)</code> |
| <div class="block">When engaging this module to some service or operation , module will be notify by calling this |
| method there module author can validate , add policy and do any thing that he want , and he can |
| refuse the engage as well</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/modules/Module.html#init(org.apache.axis2.context.ConfigurationContext, org.apache.axis2.description.AxisModule)">init</a></strong>(<a href="../../../../org/apache/axis2/context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configContext, |
| <a href="../../../../org/apache/axis2/description/AxisModule.html" title="class in org.apache.axis2.description">AxisModule</a> module)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/axis2/modules/Module.html#shutdown(org.apache.axis2.context.ConfigurationContext)">shutdown</a></strong>(<a href="../../../../org/apache/axis2/context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configurationContext)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="init(org.apache.axis2.context.ConfigurationContext, org.apache.axis2.description.AxisModule)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>void init(<a href="../../../../org/apache/axis2/context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configContext, |
| <a href="../../../../org/apache/axis2/description/AxisModule.html" title="class in org.apache.axis2.description">AxisModule</a> module) |
| throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="engageNotify(org.apache.axis2.description.AxisDescription)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>engageNotify</h4> |
| <pre>void engageNotify(<a href="../../../../org/apache/axis2/description/AxisDescription.html" title="class in org.apache.axis2.description">AxisDescription</a> axisDescription) |
| throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">When engaging this module to some service or operation , module will be notify by calling this |
| method there module author can validate , add policy and do any thing that he want , and he can |
| refuse the engage as well</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>axisDescription</code> - </dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="canSupportAssertion(org.apache.neethi.Assertion)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canSupportAssertion</h4> |
| <pre>boolean canSupportAssertion(org.apache.neethi.Assertion assertion)</pre> |
| <div class="block">Evaluate whether it can support the specified assertion and returns true if the assertion can |
| be supported.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>assertion</code> - the assertion that the module must decide whether it can support or not.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if the specified assertion can be supported by the module</dd></dl> |
| </li> |
| </ul> |
| <a name="applyPolicy(org.apache.neethi.Policy, org.apache.axis2.description.AxisDescription)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applyPolicy</h4> |
| <pre>void applyPolicy(org.apache.neethi.Policy policy, |
| <a href="../../../../org/apache/axis2/description/AxisDescription.html" title="class in org.apache.axis2.description">AxisDescription</a> axisDescription) |
| throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <div class="block">Evaluates specified policy for the specified AxisDescription. It computes the configuration that |
| is appropriate to support the policy and stores it the appropriate description.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>policy</code> - the policy that is applicable for the specified AxisDescription</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - if anything goes wrong.</dd></dl> |
| </li> |
| </ul> |
| <a name="shutdown(org.apache.axis2.context.ConfigurationContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>shutdown</h4> |
| <pre>void shutdown(<a href="../../../../org/apache/axis2/context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configurationContext) |
| throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Module.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/axis2/modules/Module.html" target="_top">Frames</a></li> |
| <li><a href="Module.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |