| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Module (Apache Axis2)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Module (Apache Axis2)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.axis2.modules</a></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><code><a href="../handlers/addressing/Addressing.html" title="class in org.apache.axis2.handlers.addressing">Addressing</a></code>, <code><a href="../jaxws/module/JAXWSModule.html" title="class in org.apache.axis2.jaxws.module">JAXWSModule</a></code>, <code><a href="../mex/MetadataExchangeModule.html" title="class in org.apache.axis2.mex">MetadataExchangeModule</a></code>, <code><a href="../mtompolicy/MTOMPolicy.html" title="class in org.apache.axis2.mtompolicy">MTOMPolicy</a></code>, <code><a href="../scripting/ScriptModule.html" title="class in org.apache.axis2.scripting">ScriptModule</a></code>, <code><a href="../handlers/soapmonitor/SOAPMonitorModule.html" title="class in org.apache.axis2.handlers.soapmonitor">SOAPMonitorModule</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">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 =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applyPolicy(org.apache.neethi.Policy,org.apache.axis2.description.AxisDescription)">applyPolicy</a></span>​(org.apache.neethi.Policy policy, |
| <a href="../description/AxisDescription.html" title="class in org.apache.axis2.description">AxisDescription</a> axisDescription)</code></th> |
| <td class="colLast"> |
| <div class="block">Evaluates specified policy for the specified AxisDescription.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canSupportAssertion(org.apache.neethi.Assertion)">canSupportAssertion</a></span>​(org.apache.neethi.Assertion assertion)</code></th> |
| <td class="colLast"> |
| <div class="block">Evaluate whether it can support the specified assertion and returns true if the assertion can |
| be supported.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#engageNotify(org.apache.axis2.description.AxisDescription)">engageNotify</a></span>​(<a href="../description/AxisDescription.html" title="class in org.apache.axis2.description">AxisDescription</a> axisDescription)</code></th> |
| <td class="colLast"> |
| <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 id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#init(org.apache.axis2.context.ConfigurationContext,org.apache.axis2.description.AxisModule)">init</a></span>​(<a href="../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configContext, |
| <a href="../description/AxisModule.html" title="class in org.apache.axis2.description">AxisModule</a> module)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shutdown(org.apache.axis2.context.ConfigurationContext)">shutdown</a></span>​(<a href="../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configurationContext)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="init(org.apache.axis2.context.ConfigurationContext,org.apache.axis2.description.AxisModule)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre class="methodSignature">void init​(<a href="../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configContext, |
| <a href="../description/AxisModule.html" title="class in org.apache.axis2.description">AxisModule</a> module) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="engageNotify(org.apache.axis2.description.AxisDescription)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>engageNotify</h4> |
| <pre class="methodSignature">void engageNotify​(<a href="../description/AxisDescription.html" title="class in org.apache.axis2.description">AxisDescription</a> axisDescription) |
| throws <a href="../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="paramLabel">Parameters:</span></dt> |
| <dd><code>axisDescription</code> - </dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="canSupportAssertion(org.apache.neethi.Assertion)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>canSupportAssertion</h4> |
| <pre class="methodSignature">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="paramLabel">Parameters:</span></dt> |
| <dd><code>assertion</code> - the assertion that the module must decide whether it can support or not.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the specified assertion can be supported by the module</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="applyPolicy(org.apache.neethi.Policy,org.apache.axis2.description.AxisDescription)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>applyPolicy</h4> |
| <pre class="methodSignature">void applyPolicy​(org.apache.neethi.Policy policy, |
| <a href="../description/AxisDescription.html" title="class in org.apache.axis2.description">AxisDescription</a> axisDescription) |
| throws <a href="../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="paramLabel">Parameters:</span></dt> |
| <dd><code>policy</code> - the policy that is applicable for the specified AxisDescription</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - if anything goes wrong.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="shutdown(org.apache.axis2.context.ConfigurationContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>shutdown</h4> |
| <pre class="methodSignature">void shutdown​(<a href="../context/ConfigurationContext.html" title="class in org.apache.axis2.context">ConfigurationContext</a> configurationContext) |
| throws <a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
