baseinitablebroker.html

turbine教程

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="initables"><!-- --></A><H3>
initables</H3>
<PRE>
protected java.util.Hashtable <B>initables</B></PRE>
<DL>
<DD>A repository of Initable instances.</DL>
<HR>

<A NAME="stack"><!-- --></A><H3>
stack</H3>
<PRE>
protected java.util.Stack <B>stack</B></PRE>
<DL>
<DD>Names of classes being early-initialized are pushed onto this
 stack.  A name appearing twice indicates a circular dependency
 chain.</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="BaseInitableBroker()"><!-- --></A><H3>
BaseInitableBroker</H3>
<PRE>
protected <B>BaseInitableBroker</B>()</PRE>
<DL>
<DD>Default constructor of InitableBorker.

 This constructor does nothing. Your brokers should be
 singletons, therefore their constructors should be
 private. They should also have public YourBroker getInstance()
 methods.</DL>

<!-- ============ 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="initClass(java.lang.String, java.lang.Object)"><!-- --></A><H3>
initClass</H3>
<PRE>
public void <B>initClass</B>(java.lang.String&nbsp;className,
                      java.lang.Object&nbsp;data)
               throws <A HREF="../../../../org/apache/turbine/services/InitializationException.html">InitializationException</A></PRE>
<DL>
<DD>Performs early initialization of an Initable class.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/turbine/services/InitableBroker.html#initClass(java.lang.String, java.lang.Object)">initClass</A></CODE> in interface <CODE><A HREF="../../../../org/apache/turbine/services/InitableBroker.html">InitableBroker</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>className</CODE> - The name of the class to be initailized.<DD><CODE>data</CODE> - An Object to be used for initialization activities.<DT><B>Throws:</B><DD><CODE><A HREF="../../../../org/apache/turbine/services/InitializationException.html">InitializationException</A></CODE> - Initialization was not successful.</DL>
</DD>
</DL>
<HR>

<A NAME="shutdownClass(java.lang.String)"><!-- --></A><H3>
shutdownClass</H3>
<PRE>
public void <B>shutdownClass</B>(java.lang.String&nbsp;className)</PRE>
<DL>
<DD>Shuts down an <code>Initable</code>.

 This method is used to release resources allocated by an
 <code>Initable</code>, and return it to its initial (uninitailized)
 state.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/turbine/services/InitableBroker.html#shutdownClass(java.lang.String)">shutdownClass</A></CODE> in interface <CODE><A HREF="../../../../org/apache/turbine/services/InitableBroker.html">InitableBroker</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>className</CODE> - The name of the class to be uninitialized.</DL>
</DD>
</DL>
<HR>

<A NAME="getInitable(java.lang.String)"><!-- --></A><H3>
getInitable</H3>
<PRE>
public <A HREF="../../../../org/apache/turbine/services/Initable.html">Initable</A> <B>getInitable</B>(java.lang.String&nbsp;className)
                     throws <A HREF="../../../../org/apache/turbine/services/InstantiationException.html">InstantiationException</A></PRE>
<DL>
<DD>Provides an instance of Initable class ready to work.

 If the requested class couldn't be instatiated or initialized,
 an InstantiationException will be thrown. You needn't handle
 this exception in your code, since it indicates fatal
 misconfigurtion of the system.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/turbine/services/InitableBroker.html#getInitable(java.lang.String)">getInitable</A></CODE> in interface <CODE><A HREF="../../../../org/apache/turbine/services/InitableBroker.html">InitableBroker</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>className</CODE> - The name of the Initable requested.<DT><B>Returns:</B><DD>An instance of the requested Initable.<DT><B>Throws:</B><DD><CODE>InstantiationException,</CODE> - if there was a problem
 during instantiation or initialization of the Initable.</DL>
</DD>
</DL>
<HR>

<A NAME="getInitableInstance(java.lang.String)"><!-- --></A><H3>
getInitableInstance</H3>
<PRE>
protected <A HREF="../../../../org/apache/turbine/services/Initable.html">Initable</A> <B>getInitableInstance</B>(java.lang.String&nbsp;className)
                                throws <A HREF="../../../../org/apache/turbine/services/InstantiationException.html">InstantiationException</A></PRE>
<DL>
<DD>Retrieves an instance of an Initable from the repository.

 If the requested class is not present in the repository, it is
 instantiated and passed a reference to the broker, saved and
 then returned.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>className</CODE> - The name of the class to be instantiated.<DT><B>Throws:</B><DD><CODE>InstantiationException,</CODE> - if the requested class can't
 be instantiated.</DL>
</DD>
</DL>
<HR>

<A NAME="notice(java.lang.String)"><!-- --></A><H3>
notice</H3>
<PRE>
public void <B>notice</B>(java.lang.String&nbsp;msg)</PRE>
<DL>
<DD>Output a diagnostic notice.

 This method is used by the service framework classes for producing
 tracing mesages that might be useful for debugging (newline terminated).

 <p>The default implementation uses system error stream. When writing
 your own, remeber to direct that message to the proper logging
 mechanism.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - the message to print.</DL>
</DD>
</DL>
<HR>

<A NAME="error(java.lang.Throwable)"><!-- --></A><H3>
error</H3>
<PRE>
public void <B>error</B>(java.lang.Throwable&nbsp;t)</PRE>
<DL>
<DD>Output an error message.

 This method is used by the service framework classes for displaying
 stacktraces of any exceptions that might be caught during processing.

 <p>The default implementation uses system error stream. When writing
 your own, remeber to direct that message to the proper logging
 mechanism.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msg</CODE> - the message to print.</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>&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="class-use/BaseInitableBroker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&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/turbine/services/BaseInitable.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/turbine/services/BaseService.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>  &nbsp;
&nbsp;<A HREF="BaseInitableBroker.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>
Copyright &copy; 2000-2002 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>