baseservicebroker.html

turbine教程

 
<P>

<!-- ============ 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="mapping"><!-- --></A><H3>
mapping</H3>
<PRE>
protected org.apache.commons.configuration.Configuration <B>mapping</B></PRE>
<DL>
<DD>Mapping of Service names to class names.</DL>
<HR>

<A NAME="services"><!-- --></A><H3>
services</H3>
<PRE>
protected java.util.Hashtable <B>services</B></PRE>
<DL>
<DD>A repository of Service instances.</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="BaseServiceBroker()"><!-- --></A><H3>
BaseServiceBroker</H3>
<PRE>
protected <B>BaseServiceBroker</B>()</PRE>
<DL>
<DD>Default constructor of InitableBroker.

 This constructor does nothing.</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="isRegistered(java.lang.String)"><!-- --></A><H3>
isRegistered</H3>
<PRE>
public boolean <B>isRegistered</B>(java.lang.String&nbsp;serviceName)</PRE>
<DL>
<DD>Determines whether a service is registered in the configured
 <code>TurbineResources.properties</code>.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/turbine/services/ServiceBroker.html#isRegistered(java.lang.String)">isRegistered</A></CODE> in interface <CODE><A HREF="../../../../org/apache/turbine/services/ServiceBroker.html">ServiceBroker</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>serviceName</CODE> - The name of the service whose existance to check.<DT><B>Returns:</B><DD>Registration predicate for the desired services.</DL>
</DD>
</DL>
<HR>

<A NAME="initService(java.lang.String, java.lang.Object)"><!-- --></A><H3>
initService</H3>
<PRE>
public void <B>initService</B>(java.lang.String&nbsp;name,
                        java.lang.Object&nbsp;data)
                 throws <A HREF="../../../../org/apache/turbine/services/InitializationException.html">InitializationException</A></PRE>
<DL>
<DD>Performs early initialization of specified service.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/turbine/services/ServiceBroker.html#initService(java.lang.String, java.lang.Object)">initService</A></CODE> in interface <CODE><A HREF="../../../../org/apache/turbine/services/ServiceBroker.html">ServiceBroker</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the service (generally the
 <code>SERVICE_NAME</code> constant of the service's interface
 definition).<DD><CODE>data</CODE> - An object to use for initialization activities.<DT><B>Throws:</B><DD><CODE><A HREF="../../../../org/apache/turbine/services/InitializationException.html">InitializationException</A></CODE> - Initialization of this
 service was not successful.</DL>
</DD>
</DL>
<HR>

<A NAME="initServices(java.lang.Object)"><!-- --></A><H3>
initServices</H3>
<PRE>
public void <B>initServices</B>(java.lang.Object&nbsp;data)</PRE>
<DL>
<DD>Performs early initialization of all services.  Failed early
 initialization of a Service may be non-fatal to the system,
 thuss the exceptions are logged and then discarded.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/turbine/services/ServiceBroker.html#initServices(java.lang.Object)">initServices</A></CODE> in interface <CODE><A HREF="../../../../org/apache/turbine/services/ServiceBroker.html">ServiceBroker</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - An Object to use for initialization activities.</DL>
</DD>
</DL>
<HR>

<A NAME="initServices(java.lang.Object, boolean)"><!-- --></A><H3>
initServices</H3>
<PRE>
public void <B>initServices</B>(java.lang.Object&nbsp;data,
                         boolean&nbsp;report)
                  throws <A HREF="../../../../org/apache/turbine/services/InstantiationException.html">InstantiationException</A>,
                         <A HREF="../../../../org/apache/turbine/services/InitializationException.html">InitializationException</A></PRE>
<DL>
<DD>Performs early initiailzation of all services. You can decide
 to handle failed initizalizations if you wish, but then
 after one service fails, the other will not have the chance
 to initialize.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - An Object to use for initialization activities.<DD><CODE>report</CODE> - <code>true</code> if you want exceptions thrown.</DL>
</DD>
</DL>
<HR>

<A NAME="shutdownService(java.lang.String)"><!-- --></A><H3>
shutdownService</H3>
<PRE>
public void <B>shutdownService</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Shuts down a <code>Service</code>.

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

<A NAME="shutdownServices()"><!-- --></A><H3>
shutdownServices</H3>
<PRE>
public void <B>shutdownServices</B>()</PRE>
<DL>
<DD>Shuts down all Turbine services, releasing allocated resources and
 returning them to their initial (uninitialized) state.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/turbine/services/ServiceBroker.html#shutdownServices()">shutdownServices</A></CODE> in interface <CODE><A HREF="../../../../org/apache/turbine/services/ServiceBroker.html">ServiceBroker</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getService(java.lang.String)"><!-- --></A><H3>
getService</H3>
<PRE>
public <A HREF="../../../../org/apache/turbine/services/Service.html">Service</A> <B>getService</B>(java.lang.String&nbsp;name)
                   throws <A HREF="../../../../org/apache/turbine/services/InstantiationException.html">InstantiationException</A></PRE>
<DL>
<DD>Returns an instance of requested Service.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/turbine/services/ServiceBroker.html#getService(java.lang.String)">getService</A></CODE> in interface <CODE><A HREF="../../../../org/apache/turbine/services/ServiceBroker.html">ServiceBroker</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the Service requested.<DT><B>Returns:</B><DD>An instance of requested Service.<DT><B>Throws:</B><DD><CODE>InstantiationException,</CODE> - if the service is unknown or
 can't be initialized.</DL>
</DD>
</DL>
<HR>

<A NAME="getServiceInstance(java.lang.String)"><!-- --></A><H3>
getServiceInstance</H3>
<PRE>
protected <A HREF="../../../../org/apache/turbine/services/Service.html">Service</A> <B>getServiceInstance</B>(java.lang.String&nbsp;name)
                              throws <A HREF="../../../../org/apache/turbine/services/InstantiationException.html">InstantiationException</A></PRE>
<DL>
<DD>Retrieves an instance of a Service without triggering late
 initialization.

 Early initialization of a Service can require access to Service
 properties.  The Service must have its name and serviceBroker
 set by then.  Therefore, before calling
 Initable.initClass(Object), the class must be instantiated with
 InitableBroker.getInitableInstance(), and
 Service.setServiceBroker() and Service.setName() must be
 called.  This calls for two - level accessing the Services
 instances.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the service requested.<DT><B>Throws:</B><DD><CODE>InstantiationException,</CODE> - if the service is unknown or
 can't be initialized.</DL>
</DD>
</DL>
<HR>

<A NAME="getProperties(java.lang.String)"><!-- --></A><H3>
getProperties</H3>
<PRE>
public java.util.Properties <B>getProperties</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Returns the properites of a specific service.

 Generic ServiceBroker returns empty set of Properties.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/turbine/services/ServiceBroker.html#getProperties(java.lang.String)">getProperties</A></CODE> in interface <CODE><A HREF="../../../../org/apache/turbine/services/ServiceBroker.html">ServiceBroker</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the service.<DT><B>Returns:</B><DD>Properties of requested Service.</DL>
</DD>
</DL>
<HR>

<A NAME="getConfiguration(java.lang.String)"><!-- --></A><H3>
getConfiguration</H3>
<PRE>
public org.apache.commons.configuration.Configuration <B>getConfiguration</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Returns the Configuration of a specific service.

 Generic ServiceBroker returns empty Configuration<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../org/apache/turbine/services/ServiceBroker.html#getConfiguration(java.lang.String)">getConfiguration</A></CODE> in interface <CODE><A HREF="../../../../org/apache/turbine/services/ServiceBroker.html">ServiceBroker</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the service.<DT><B>Returns:</B><DD>Properties of requested Service.</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/BaseServiceBroker.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/BaseService.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/turbine/services/BaseUnicastRemoteService.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="BaseServiceBroker.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>