intakeservice.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="SERVICE_NAME"><!-- --></A><H3>
SERVICE_NAME</H3>
<PRE>
public static final java.lang.String <B>SERVICE_NAME</B></PRE>
<DL>
<DD>The key under which this service is stored in TurbineServices.</DL>
<HR>

<A NAME="XML_PATH"><!-- --></A><H3>
XML_PATH</H3>
<PRE>
public static final java.lang.String <B>XML_PATH</B></PRE>
<DL>
<DD>The property specifying the location of the xml specification.</DL>
<HR>

<A NAME="DEFAULT_POOL_CAPACITY"><!-- --></A><H3>
DEFAULT_POOL_CAPACITY</H3>
<PRE>
public static final int <B>DEFAULT_POOL_CAPACITY</B></PRE>
<DL>
<DD>The default pool capacity.</DL>

<!-- ========= 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="getGroup(java.lang.String)"><!-- --></A><H3>
getGroup</H3>
<PRE>
public <A HREF="../../../../../org/apache/turbine/services/intake/model/Group.html">Group</A> <B>getGroup</B>(java.lang.String&nbsp;groupName)
               throws <A HREF="../../../../../org/apache/turbine/util/TurbineException.html">TurbineException</A></PRE>
<DL>
<DD>Gets an instance of a named group either from the pool
 or by calling the Factory Service if the pool is empty.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>groupName</CODE> - the name of the group.<DT><B>Returns:</B><DD>a Group instance.<DT><B>Throws:</B><DD><CODE><A HREF="../../../../../org/apache/turbine/util/TurbineException.html">TurbineException</A></CODE> - if recycling fails.</DL>
</DD>
</DL>
<HR>

<A NAME="releaseGroup(org.apache.turbine.services.intake.model.Group)"><!-- --></A><H3>
releaseGroup</H3>
<PRE>
public boolean <B>releaseGroup</B>(<A HREF="../../../../../org/apache/turbine/services/intake/model/Group.html">Group</A>&nbsp;instance)</PRE>
<DL>
<DD>Puts a group back to the pool.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>instance</CODE> - the object instance to recycle.<DT><B>Returns:</B><DD>true if the instance was accepted.</DL>
</DD>
</DL>
<HR>

<A NAME="getCapacity(java.lang.String)"><!-- --></A><H3>
getCapacity</H3>
<PRE>
public int <B>getCapacity</B>(java.lang.String&nbsp;groupName)</PRE>
<DL>
<DD>Gets the capacity of the pool for a named group.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>groupName</CODE> - the name of the group.</DL>
</DD>
</DL>
<HR>

<A NAME="setCapacity(java.lang.String, int)"><!-- --></A><H3>
setCapacity</H3>
<PRE>
public void <B>setCapacity</B>(java.lang.String&nbsp;groupName,
                        int&nbsp;capacity)</PRE>
<DL>
<DD>Sets the capacity of the pool for a named group.
 Note that the pool will be cleared after the change.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>groupName</CODE> - the name of the group.<DD><CODE>capacity</CODE> - the new capacity.</DL>
</DD>
</DL>
<HR>

<A NAME="getSize(java.lang.String)"><!-- --></A><H3>
getSize</H3>
<PRE>
public int <B>getSize</B>(java.lang.String&nbsp;groupName)</PRE>
<DL>
<DD>Gets the current size of the pool for a named group.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>groupName</CODE> - the name of the group.</DL>
</DD>
</DL>
<HR>

<A NAME="clearPool(java.lang.String)"><!-- --></A><H3>
clearPool</H3>
<PRE>
public void <B>clearPool</B>(java.lang.String&nbsp;groupName)</PRE>
<DL>
<DD>Clears instances of a named group from the pool.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>groupName</CODE> - the name of the group.</DL>
</DD>
</DL>
<HR>

<A NAME="clearPool()"><!-- --></A><H3>
clearPool</H3>
<PRE>
public void <B>clearPool</B>()</PRE>
<DL>
<DD>Clears all instances from the pool.</DL>
<HR>

<A NAME="getGroupNames()"><!-- --></A><H3>
getGroupNames</H3>
<PRE>
public java.lang.String[] <B>getGroupNames</B>()</PRE>
<DL>
<DD>Names of all the defined groups.<DD><DL>
<DT><B>Returns:</B><DD>array of names.</DL>
</DD>
</DL>
<HR>

<A NAME="getGroupKey(java.lang.String)"><!-- --></A><H3>
getGroupKey</H3>
<PRE>
public java.lang.String <B>getGroupKey</B>(java.lang.String&nbsp;groupName)</PRE>
<DL>
<DD>Gets the key (usually a short identifier) for a group.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>groupName</CODE> - the name of the group.<DT><B>Returns:</B><DD>the key.</DL>
</DD>
</DL>
<HR>

<A NAME="getGroupName(java.lang.String)"><!-- --></A><H3>
getGroupName</H3>
<PRE>
public java.lang.String <B>getGroupName</B>(java.lang.String&nbsp;groupKey)</PRE>
<DL>
<DD>Gets the group name given its key.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>the</CODE> - the key.<DT><B>Returns:</B><DD>groupName the name of the group.</DL>
</DD>
</DL>
<HR>

<A NAME="getFieldSetter(java.lang.String, java.lang.String)"><!-- --></A><H3>
getFieldSetter</H3>
<PRE>
public java.lang.reflect.Method <B>getFieldSetter</B>(java.lang.String&nbsp;className,
                                               java.lang.String&nbsp;propName)</PRE>
<DL>
<DD>Gets the Method that can be used to set a property.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>className</CODE> - the name of the object.<DD><CODE>propName</CODE> - the name of the property.<DT><B>Returns:</B><DD>the setter.</DL>
</DD>
</DL>
<HR>

<A NAME="getFieldGetter(java.lang.String, java.lang.String)"><!-- --></A><H3>
getFieldGetter</H3>
<PRE>
public java.lang.reflect.Method <B>getFieldGetter</B>(java.lang.String&nbsp;className,
                                               java.lang.String&nbsp;propName)</PRE>
<DL>
<DD>Gets the Method that can be used to get a property value.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>className</CODE> - the name of the object.<DD><CODE>propName</CODE> - the name of the property.<DT><B>Returns:</B><DD>the getter.</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/IntakeService.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;PREV CLASS&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="IntakeService.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;CONSTR&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;CONSTR&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>