| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_25) on Sat Jun 29 08:36:29 CEST 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>Handler (Apache Felix iPOJO ~ JavaDoc 1.10.1 API)</title> |
| <meta name="date" content="2013-06-29"> |
| <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="Handler (Apache Felix iPOJO ~ JavaDoc 1.10.1 API)"; |
| } |
| //--> |
| </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/Handler.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> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/felix/ipojo/FieldInterceptor.html" title="interface in org.apache.felix.ipojo"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/ipojo/HandlerFactory.html" title="interface in org.apache.felix.ipojo"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/ipojo/Handler.html" target="_top">Frames</a></li> |
| <li><a href="Handler.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><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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.felix.ipojo</div> |
| <h2 title="Class Handler" class="title">Class Handler</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.felix.ipojo.Handler</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/felix/ipojo/composite/CompositeHandler.html" title="class in org.apache.felix.ipojo.composite">CompositeHandler</a>, <a href="../../../../org/apache/felix/ipojo/PrimitiveHandler.html" title="class in org.apache.felix.ipojo">PrimitiveHandler</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.33">Handler</a> |
| extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Handler Abstract Class. |
| A handler is a 'piece' of</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd><a href="mailto:dev@felix.apache.org">Felix Project Team</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#HANDLER_LEVEL_PROPERTY">HANDLER_LEVEL_PROPERTY</a></strong></code> |
| <div class="block">The handler priority.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#HANDLER_NAME_PROPERTY">HANDLER_NAME_PROPERTY</a></strong></code> |
| <div class="block">The handler name property.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#HANDLER_NAMESPACE_PROPERTY">HANDLER_NAMESPACE_PROPERTY</a></strong></code> |
| <div class="block">The handler namespace property.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#HANDLER_TYPE_PROPERTY">HANDLER_TYPE_PROPERTY</a></strong></code> |
| <div class="block">The handler type property.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/felix/ipojo/HandlerManager.html" title="class in org.apache.felix.ipojo">HandlerManager</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#m_instance">m_instance</a></strong></code> |
| <div class="block">The HandlerManager managing the current handler.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#m_isValid">m_isValid</a></strong></code> |
| <div class="block">The current handler validity.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#Handler()">Handler</a></strong>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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>protected abstract void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#attach(org.apache.felix.ipojo.ComponentInstance)">attach</a></strong>(<a href="../../../../org/apache/felix/ipojo/ComponentInstance.html" title="interface in org.apache.felix.ipojo">ComponentInstance</a> instance)</code> |
| <div class="block">Attaches the current handler object to the given component instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#configure(org.apache.felix.ipojo.metadata.Element, java.util.Dictionary)">configure</a></strong>(<a href="../../../../org/apache/felix/ipojo/metadata/Element.html" title="class in org.apache.felix.ipojo.metadata">Element</a> metadata, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Dictionary.html?is-external=true" title="class or interface in java.util">Dictionary</a> configuration)</code> |
| <div class="block">Configures the handler.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#debug(java.lang.String)">debug</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</code> |
| <div class="block">Log method (debug).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#error(java.lang.String)">error</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</code> |
| <div class="block">Log method (error).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#error(java.lang.String, java.lang.Throwable)">error</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> exception)</code> |
| <div class="block">Log method (error).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/ipojo/architecture/HandlerDescription.html" title="class in org.apache.felix.ipojo.architecture">HandlerDescription</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#getDescription()">getDescription</a></strong>()</code> |
| <div class="block">Returns the current handler description.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/felix/ipojo/Handler.html" title="class in org.apache.felix.ipojo">Handler</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#getHandler(java.lang.String)">getHandler</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Get a plugged handler of the same container.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/ipojo/HandlerManager.html" title="class in org.apache.felix.ipojo">HandlerManager</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#getHandlerManager()">getHandlerManager</a></strong>()</code> |
| <div class="block">Gets the component instance of the current handler.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/felix/ipojo/util/Logger.html" title="class in org.apache.felix.ipojo.util">Logger</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#getLogger()">getLogger</a></strong>()</code> |
| <div class="block">Gets the logger to use in the handler.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#getValidity()">getValidity</a></strong>()</code> |
| <div class="block">Is the current handler valid.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#info(java.lang.String)">info</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</code> |
| <div class="block">Log method (info).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#initializeComponentFactory(org.apache.felix.ipojo.architecture.ComponentTypeDescription, org.apache.felix.ipojo.metadata.Element)">initializeComponentFactory</a></strong>(<a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html" title="class in org.apache.felix.ipojo.architecture">ComponentTypeDescription</a> typeDesc, |
| <a href="../../../../org/apache/felix/ipojo/metadata/Element.html" title="class in org.apache.felix.ipojo.metadata">Element</a> metadata)</code> |
| <div class="block">Initializes the component factory.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#isValid()">isValid</a></strong>()</code> |
| <div class="block">Checks if the current handler is valid.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#reconfigure(java.util.Dictionary)">reconfigure</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Dictionary.html?is-external=true" title="class or interface in java.util">Dictionary</a> configuration)</code> |
| <div class="block">Reconfigures the instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#setFactory(org.apache.felix.ipojo.Factory)">setFactory</a></strong>(<a href="../../../../org/apache/felix/ipojo/Factory.html" title="interface in org.apache.felix.ipojo">Factory</a> factory)</code> |
| <div class="block">Sets the factory attached to this handler object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#setValidity(boolean)">setValidity</a></strong>(boolean isValid)</code> |
| <div class="block">Sets the validity of the current handler.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#start()">start</a></strong>()</code> |
| <div class="block">Starts the handler |
| This method starts the management.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#stateChanged(int)">stateChanged</a></strong>(int state)</code> |
| <div class="block">This method is called when the component state changed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#stop()">stop</a></strong>()</code> |
| <div class="block">Stops the handler |
| This method stops the management.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#warn(java.lang.String)">warn</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</code> |
| <div class="block">Log method (warning).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/ipojo/Handler.html#warn(java.lang.String, java.lang.Throwable)">warn</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> exception)</code> |
| <div class="block">Log method (warning).</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="HANDLER_NAMESPACE_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HANDLER_NAMESPACE_PROPERTY</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.38">HANDLER_NAMESPACE_PROPERTY</a></pre> |
| <div class="block">The handler namespace property.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.ipojo.Handler.HANDLER_NAMESPACE_PROPERTY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="HANDLER_NAME_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HANDLER_NAME_PROPERTY</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.43">HANDLER_NAME_PROPERTY</a></pre> |
| <div class="block">The handler name property.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.ipojo.Handler.HANDLER_NAME_PROPERTY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="HANDLER_TYPE_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HANDLER_TYPE_PROPERTY</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.48">HANDLER_TYPE_PROPERTY</a></pre> |
| <div class="block">The handler type property.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.ipojo.Handler.HANDLER_TYPE_PROPERTY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="HANDLER_LEVEL_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HANDLER_LEVEL_PROPERTY</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.53">HANDLER_LEVEL_PROPERTY</a></pre> |
| <div class="block">The handler priority.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.ipojo.Handler.HANDLER_LEVEL_PROPERTY">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="m_isValid"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>m_isValid</h4> |
| <pre>protected boolean <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.59">m_isValid</a></pre> |
| <div class="block">The current handler validity. |
| This impacts directly the instance state.</div> |
| </li> |
| </ul> |
| <a name="m_instance"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>m_instance</h4> |
| <pre>protected <a href="../../../../org/apache/felix/ipojo/HandlerManager.html" title="class in org.apache.felix.ipojo">HandlerManager</a> <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.64">m_instance</a></pre> |
| <div class="block">The HandlerManager managing the current handler.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Handler()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Handler</h4> |
| <pre>public <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.33">Handler</a>()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setFactory(org.apache.felix.ipojo.Factory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFactory</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.71">setFactory</a>(<a href="../../../../org/apache/felix/ipojo/Factory.html" title="interface in org.apache.felix.ipojo">Factory</a> factory)</pre> |
| <div class="block">Sets the factory attached to this handler object. |
| This method must be override to depend on each component factory type.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - the factory to attach.</dd></dl> |
| </li> |
| </ul> |
| <a name="getLogger()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLogger</h4> |
| <pre>public abstract <a href="../../../../org/apache/felix/ipojo/util/Logger.html" title="class in org.apache.felix.ipojo.util">Logger</a> <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.78">getLogger</a>()</pre> |
| <div class="block">Gets the logger to use in the handler. |
| This method must be override to depend on each component factory type logging policy.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the logger.</dd></dl> |
| </li> |
| </ul> |
| <a name="warn(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>warn</h4> |
| <pre>public final void <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.85">warn</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</pre> |
| <div class="block">Log method (warning). |
| Log a warning message to the handler logger.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - the message to log</dd></dl> |
| </li> |
| </ul> |
| <a name="error(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>error</h4> |
| <pre>public final void <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.94">error</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</pre> |
| <div class="block">Log method (error). |
| Log an error message to the handler logger.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - the message to log</dd></dl> |
| </li> |
| </ul> |
| <a name="info(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>info</h4> |
| <pre>public final void <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.103">info</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</pre> |
| <div class="block">Log method (info). |
| Log an info message to the handler logger.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - the message to log</dd></dl> |
| </li> |
| </ul> |
| <a name="debug(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>debug</h4> |
| <pre>public final void <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.112">debug</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</pre> |
| <div class="block">Log method (debug). |
| Log a debug message to the handler logger.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - the message to log</dd></dl> |
| </li> |
| </ul> |
| <a name="warn(java.lang.String, java.lang.Throwable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>warn</h4> |
| <pre>public final void <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.123">warn</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> exception)</pre> |
| <div class="block">Log method (warning). |
| Log a warning message to the handler logger. |
| The message is sent with an attached exception.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - the message to log</dd><dd><code>exception</code> - the exception to attach with the message</dd></dl> |
| </li> |
| </ul> |
| <a name="error(java.lang.String, java.lang.Throwable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>error</h4> |
| <pre>public final void <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.134">error</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> exception)</pre> |
| <div class="block">Log method (error). |
| Log an error message to the handler logger. |
| The message is sent with an attached exception.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - the message to log</dd><dd><code>exception</code> - the exception to attach to the message</dd></dl> |
| </li> |
| </ul> |
| <a name="getHandler(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHandler</h4> |
| <pre>public abstract <a href="../../../../org/apache/felix/ipojo/Handler.html" title="class in org.apache.felix.ipojo">Handler</a> <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.146">getHandler</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Get a plugged handler of the same container. |
| This method must be call only in the start method (or after). |
| In the configure method, this method can not return a consistent |
| result as all handlers are not plugged.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - : name of the handler to find (class name or qualified handler name (ns:name)).</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the handler object or null if the handler is not found.</dd></dl> |
| </li> |
| </ul> |
| <a name="attach(org.apache.felix.ipojo.ComponentInstance)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>attach</h4> |
| <pre>protected abstract void <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.153">attach</a>(<a href="../../../../org/apache/felix/ipojo/ComponentInstance.html" title="interface in org.apache.felix.ipojo">ComponentInstance</a> instance)</pre> |
| <div class="block">Attaches the current handler object to the given component instance. |
| An attached handler becomes a part of the instance container.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>instance</code> - the component instance on which the current handler will be attached.</dd></dl> |
| </li> |
| </ul> |
| <a name="isValid()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValid</h4> |
| <pre>public final boolean <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.161">isValid</a>()</pre> |
| <div class="block">Checks if the current handler is valid. |
| This check tests the handler validity. |
| This method must not be override.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the handler is valid.</dd></dl> |
| </li> |
| </ul> |
| <a name="setValidity(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValidity</h4> |
| <pre>public final void <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.169">setValidity</a>(boolean isValid)</pre> |
| <div class="block">Sets the validity of the current handler.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>isValid</code> - if <code>true</code> the handler becomes valid, else it becomes invalid.</dd></dl> |
| </li> |
| </ul> |
| <a name="getValidity()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValidity</h4> |
| <pre>public final boolean <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.185">getValidity</a>()</pre> |
| <div class="block">Is the current handler valid.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the handler is valid, <code>false</code> otherwise.</dd></dl> |
| </li> |
| </ul> |
| <a name="getHandlerManager()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHandlerManager</h4> |
| <pre>public final <a href="../../../../org/apache/felix/ipojo/HandlerManager.html" title="class in org.apache.felix.ipojo">HandlerManager</a> <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.193">getHandlerManager</a>()</pre> |
| <div class="block">Gets the component instance of the current handler.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the component instance.</dd></dl> |
| </li> |
| </ul> |
| <a name="initializeComponentFactory(org.apache.felix.ipojo.architecture.ComponentTypeDescription, org.apache.felix.ipojo.metadata.Element)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initializeComponentFactory</h4> |
| <pre>public void <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.209">initializeComponentFactory</a>(<a href="../../../../org/apache/felix/ipojo/architecture/ComponentTypeDescription.html" title="class in org.apache.felix.ipojo.architecture">ComponentTypeDescription</a> typeDesc, |
| <a href="../../../../org/apache/felix/ipojo/metadata/Element.html" title="class in org.apache.felix.ipojo.metadata">Element</a> metadata) |
| throws <a href="../../../../org/apache/felix/ipojo/ConfigurationException.html" title="class in org.apache.felix.ipojo">ConfigurationException</a></pre> |
| <div class="block">Initializes the component factory. |
| This method aims to collect component factory properties. |
| Each handler wanting to contribute needs to override this |
| method and adds properties to the given component description. |
| By default, this method does nothing.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>typeDesc</code> - the component description.</dd><dd><code>metadata</code> - the component type metadata.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/ipojo/ConfigurationException.html" title="class in org.apache.felix.ipojo">ConfigurationException</a></code> - if the metadata are not correct (early detection).</dd></dl> |
| </li> |
| </ul> |
| <a name="configure(org.apache.felix.ipojo.metadata.Element, java.util.Dictionary)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>configure</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.219">configure</a>(<a href="../../../../org/apache/felix/ipojo/metadata/Element.html" title="class in org.apache.felix.ipojo.metadata">Element</a> metadata, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Dictionary.html?is-external=true" title="class or interface in java.util">Dictionary</a> configuration) |
| throws <a href="../../../../org/apache/felix/ipojo/ConfigurationException.html" title="class in org.apache.felix.ipojo">ConfigurationException</a></pre> |
| <div class="block">Configures the handler.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>metadata</code> - the metadata of the component</dd><dd><code>configuration</code> - the instance configuration</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/felix/ipojo/ConfigurationException.html" title="class in org.apache.felix.ipojo">ConfigurationException</a></code> - if the metadata are not correct.</dd></dl> |
| </li> |
| </ul> |
| <a name="stop()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.225">stop</a>()</pre> |
| <div class="block">Stops the handler |
| This method stops the management.</div> |
| </li> |
| </ul> |
| <a name="start()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.231">start</a>()</pre> |
| <div class="block">Starts the handler |
| This method starts the management.</div> |
| </li> |
| </ul> |
| <a name="stateChanged(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stateChanged</h4> |
| <pre>public void <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.238">stateChanged</a>(int state)</pre> |
| <div class="block">This method is called when the component state changed. |
| By default, this method does nothing.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>state</code> - the new instance state <a href="../../../../org/apache/felix/ipojo/ComponentInstance.html" title="interface in org.apache.felix.ipojo"><code>ComponentInstance</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getDescription()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescription</h4> |
| <pre>public <a href="../../../../org/apache/felix/ipojo/architecture/HandlerDescription.html" title="class in org.apache.felix.ipojo.architecture">HandlerDescription</a> <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.249">getDescription</a>()</pre> |
| <div class="block">Returns the current handler description. |
| The simplest description contains only the name and the validity of the handler. |
| If the handler override this method, it can customize the description. |
| By default, this method returns the simplest description.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the description of the handler.</dd></dl> |
| </li> |
| </ul> |
| <a name="reconfigure(java.util.Dictionary)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>reconfigure</h4> |
| <pre>public void <a href="../../../../src-html/org/apache/felix/ipojo/Handler.html#line.261">reconfigure</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Dictionary.html?is-external=true" title="class or interface in java.util">Dictionary</a> configuration)</pre> |
| <div class="block">Reconfigures the instance. |
| This method is called, when the instance is under reconfiguration. |
| The reconfiguration does not stops the instance, and so the handler supporting |
| the reconfiguration must override this method and handles this case. |
| By default, this method does nothing.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>configuration</code> - the new instance configuration.</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/Handler.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> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/felix/ipojo/FieldInterceptor.html" title="interface in org.apache.felix.ipojo"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/ipojo/HandlerFactory.html" title="interface in org.apache.felix.ipojo"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/ipojo/Handler.html" target="_top">Frames</a></li> |
| <li><a href="Handler.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><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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 © 2013. All rights reserved.</small></p> |
| </body> |
| </html> |