📄 initable.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd"><!--NewPage--><HTML><HEAD><!-- Generated by javadoc on Fri Dec 06 19:57:07 CET 2002 --><TITLE>jakarta-turbine-2 2.2 API: Interface Initable</TITLE><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"></HEAD><BODY BGCOLOR="white"><!-- ========== START OF NAVBAR ========== --><A NAME="navbar_top"><!-- --></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"><TR><TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><A NAME="navbar_top_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Initable.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR></TABLE></TD><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM></EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> PREV CLASS <A HREF="../../../../org/apache/turbine/services/InitableBroker.html"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="Initable.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><!-- =========== END OF NAVBAR =========== --><HR><!-- ======== START OF CLASS DATA ======== --><H2><FONT SIZE="-1">org.apache.turbine.services</FONT><BR>Interface Initable</H2><DL><DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../org/apache/turbine/services/assemblerbroker/AssemblerBrokerService.html">AssemblerBrokerService</A>, <A HREF="../../../../org/apache/turbine/services/castor/CastorService.html">CastorService</A>, <A HREF="../../../../org/apache/turbine/services/component/ComponentService.html">ComponentService</A>, <A HREF="../../../../org/apache/turbine/services/factory/FactoryService.html">FactoryService</A>, <A HREF="../../../../org/apache/turbine/services/freemarker/FreeMarkerService.html">FreeMarkerService</A>, <A HREF="../../../../org/apache/turbine/services/cache/GlobalCacheService.html">GlobalCacheService</A>, <A HREF="../../../../org/apache/turbine/services/jsp/JspService.html">JspService</A>, <A HREF="../../../../org/apache/turbine/services/localization/LocalizationService.html">LocalizationService</A>, <A HREF="../../../../org/apache/turbine/services/logging/LoggingService.html">LoggingService</A>, <A HREF="../../../../org/apache/turbine/services/db/MapBrokerService.html">MapBrokerService</A>, <A HREF="../../../../org/apache/turbine/services/mimetype/MimeTypeService.html">MimeTypeService</A>, <A HREF="../../../../org/apache/turbine/services/naming/NamingService.html">NamingService</A>, <A HREF="../../../../org/apache/turbine/services/db/PoolBrokerService.html">PoolBrokerService</A>, <A HREF="../../../../org/apache/turbine/services/pool/PoolService.html">PoolService</A>, <A HREF="../../../../org/apache/turbine/services/pull/PullService.html">PullService</A>, <A HREF="../../../../org/apache/turbine/services/resources/ResourceService.html">ResourceService</A>, <A HREF="../../../../org/apache/turbine/services/rundata/RunDataService.html">RunDataService</A>, <A HREF="../../../../org/apache/turbine/services/schedule/ScheduleService.html">ScheduleService</A>, <A HREF="../../../../org/apache/turbine/services/security/SecurityService.html">SecurityService</A>, <A HREF="../../../../org/apache/turbine/services/Service.html">Service</A>, <A HREF="../../../../org/apache/turbine/services/servlet/ServletService.html">ServletService</A>, <A HREF="../../../../org/apache/turbine/services/template/TemplateService.html">TemplateService</A>, <A HREF="../../../../org/apache/turbine/services/uniqueid/UniqueIdService.html">UniqueIdService</A>, <A HREF="../../../../org/apache/turbine/services/upload/UploadService.html">UploadService</A>, <A HREF="../../../../org/apache/turbine/services/velocity/VelocityService.html">VelocityService</A>, <A HREF="../../../../org/apache/turbine/services/webmacro/WebMacroService.html">WebMacroService</A>, <A HREF="../../../../org/apache/turbine/services/xmlrpc/XmlRpcService.html">XmlRpcService</A>, <A HREF="../../../../org/apache/turbine/services/xslt/XSLTService.html">XSLTService</A></DD></DL><DL><DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/turbine/services/BaseInitable.html">BaseInitable</A></DD></DL><HR><DL><DT>public interface <B>Initable</B></DL><P>Classes that implement this interface need initialization before they can work. These classes rely also on an <code>InitableBroker</code> that ensures that there is only one instance of the class in the system, and handles dependencies between <code>Initables</code>.<P><DL><DT><B>Version: </B><DD>$Id: Initable.java,v 1.1.1.1 2001/08/16 05:08:46 jvanzyl Exp $</DD><DT><B>Author: </B><DD><a href="mailto:burton@apache.org">Kevin Burton</a>, <a href="mailto:krzewski@e-point.pl">Rafal Krzewski</a></DD></DL><HR><P><!-- ======== INNER CLASS SUMMARY ======== --><!-- =========== FIELD SUMMARY =========== --><!-- ======== CONSTRUCTOR SUMMARY ======== --><!-- ========== METHOD SUMMARY =========== --><A NAME="method_summary"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TD COLSPAN=2><FONT SIZE="+2"><B>Method Summary</B></FONT></TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/apache/turbine/services/Initable.html#getInit()">getInit</A></B>()</CODE><BR> Returns initialization status of an Initable.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/apache/turbine/services/Initable.html#init()">init</A></B>()</CODE><BR> Performs late initialization of an Initable.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/apache/turbine/services/Initable.html#init(java.lang.Object)">init</A></B>(java.lang.Object data)</CODE><BR> Performs early initailization of an Initable During the startup of the system, different objects may be passed to your class using this method.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/apache/turbine/services/Initable.html#setInitableBroker(org.apache.turbine.services.InitableBroker)">setInitableBroker</A></B>(<A HREF="../../../../org/apache/turbine/services/InitableBroker.html">InitableBroker</A> broker)</CODE><BR> Provides an Initable with a reference to the InitableBroker that instantiated this object, so that it can access other Initables.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/apache/turbine/services/Initable.html#shutdown()">shutdown</A></B>()</CODE><BR> Returns an <code>Initable</code> to an uninitialized state.</TD></TR></TABLE> <P><!-- ============ FIELD DETAIL =========== --><!-- ========= CONSTRUCTOR DETAIL ======== --><!-- ============ METHOD DETAIL ========== --><A NAME="method_detail"><!-- --></A><TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TD COLSPAN=1><FONT SIZE="+2"><B>Method Detail</B></FONT></TD></TR></TABLE><A NAME="setInitableBroker(org.apache.turbine.services.InitableBroker)"><!-- --></A><H3>setInitableBroker</H3><PRE>public void <B>setInitableBroker</B>(<A HREF="../../../../org/apache/turbine/services/InitableBroker.html">InitableBroker</A> broker)</PRE><DL><DD>Provides an Initable with a reference to the InitableBroker that instantiated this object, so that it can access other Initables.<DD><DL><DT><B>Parameters:</B><DD><CODE>broker</CODE> - The InitableBroker that instantiated this object.</DL></DD></DL><HR><A NAME="init(java.lang.Object)"><!-- --></A><H3>init</H3><PRE>public void <B>init</B>(java.lang.Object data) throws <A HREF="../../../../org/apache/turbine/services/InitializationException.html">InitializationException</A></PRE><DL><DD>Performs early initailization of an Initable During the startup of the system, different objects may be passed to your class using this method. It should ignore any objects that it doesn't need or understand. After the class changes its internal state so that getInit() returns true, this method will be called no more, and late initialization will not be performed. If your class relies on early initialization, and the object it expects was not received, you can use late initialization to throw an exception and complain.<DD><DL><DT><B>Parameters:</B><DD><CODE>data</CODE> - An Object to use for initialization activities.<DT><B>Throws:</B><DD><CODE>InitializationException,</CODE> - if initilaization of this class was not successful.</DL></DD></DL><HR><A NAME="init()"><!-- --></A><H3>init</H3><PRE>public void <B>init</B>() throws <A HREF="../../../../org/apache/turbine/services/InitializationException.html">InitializationException</A></PRE><DL><DD>Performs late initialization of an Initable. When your class is being requested from an InitableBroker, it will call getInit(), and if it returns false, this method will be invoked.<DD><DL><DT><B>Throws:</B><DD><CODE>InitializationException,</CODE> - if initialization of this class was not successful.</DL></DD></DL><HR><A NAME="shutdown()"><!-- --></A><H3>shutdown</H3><PRE>public void <B>shutdown</B>()</PRE><DL><DD>Returns an <code>Initable</code> to an uninitialized state. <p>This method must release all resources allocated by the <code>Initable</code> implementation, and resetting its internal state. You may chose to implement this operation or not. If you support this operation, getInit() should return false after successful shutdown of the service.</DL><HR><A NAME="getInit()"><!-- --></A><H3>getInit</H3><PRE>public boolean <B>getInit</B>()</PRE><DL><DD>Returns initialization status of an Initable.<DD><DL><DT><B>Returns:</B><DD>Initialization status of an Initable.</DL></DD></DL><!-- ========= END OF CLASS DATA ========= --><HR><!-- ========== START OF NAVBAR ========== --><A NAME="navbar_bottom"><!-- --></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"><TR><TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><A NAME="navbar_bottom_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Initable.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR></TABLE></TD><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM></EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> PREV CLASS <A HREF="../../../../org/apache/turbine/services/InitableBroker.html"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> <A HREF="Initable.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: INNER | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><!-- =========== END OF NAVBAR =========== --><HR>Copyright © 2000-2002 Apache Software Foundation. All Rights Reserved.</BODY></HTML>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -