jco.poolmanager.html

SAP ERP的二次开发

 that the application using this pool never invokes functions, that maintain a state on the 
 ABAP server.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pool_name</CODE> - the name of the pool from which to take the connection<DD><CODE>reset</CODE> - if <tt>true</tt> reset the connection, e.g. free all resources
      that might have been allocated on either the server side or by the local
      middleware layer. On SAP systems below 4.0A resetting a connection
      effectively means closing and subsequently reopening the connection
      which is a very expensive process. However, several scenarios
      (e.g. BAPIs) might need such reinitialized connections. Use with care !<DT><B>Returns:</B><DD>the newly created client or <tt>null</tt> in the case when the
      thread which was waiting for the client has been interrupted.<DT><B>Throws:</B><DD><CODE><A HREF="../../../../com/sap/mw/jco/JCO.Exception.html">JCO.Exception</A></CODE> - with the error group set to <tt>JCO.Exception.JCO_ERROR_RESOURCE</tt>,
      if a client could not be allocated, i.e. the client pool is exhausted<DD><CODE><A HREF="../../../../com/sap/mw/jco/JCO.Exception.html">JCO.Exception</A></CODE> - thrown if a client connection could not be established due to wrong logon data,
      network problems, etc.<DT><B>See Also: </B><DD><A HREF="../../../../com/sap/mw/jco/JCO.html#releaseClient(com.sap.mw.jco.JCO.Client)"><CODE>JCO.releaseClient(com.sap.mw.jco.JCO.Client)</CODE></A>, 
<A HREF="../../../../com/sap/mw/jco/JCO.PoolManager.html#setMaxWaitTime(long)"><CODE>setMaxWaitTime(long)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="releaseClient(com.sap.mw.jco.JCO.Client)"><!-- --></A><H3>
releaseClient</H3>
<PRE>
public void <B>releaseClient</B>(<A HREF="../../../../com/sap/mw/jco/JCO.Client.html">JCO.Client</A>&nbsp;client)</PRE>
<DL>
<DD>Returns the client connection to the pool.<br>
  On SAP systems equal or above 4.0A the method resets the connection, i.e.
  frees all resources and context allocated on the server side (i.e. '/n' in SAP system)
  or by the local middleware layer unless specified differently by the pool's
  <tt>setResetOnRelease()</tt> method.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>client</CODE> - the client connection which is being returned to its pool<DT><B>Throws:</B><DD><CODE><A HREF="../../../../com/sap/mw/jco/JCO.Exception.html">JCO.Exception</A></CODE> - thrown if a connection could not be released cleanly<DT><B>See Also: </B><DD><A HREF="../../../../com/sap/mw/jco/JCO.PoolManager.html#getClient(java.lang.String)"><CODE>getClient(java.lang.String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="detachFromPool(com.sap.mw.jco.JCO.Client)"><!-- --></A><H3>
detachFromPool</H3>
<PRE>
public void <B>detachFromPool</B>(<A HREF="../../../../com/sap/mw/jco/JCO.Client.html">JCO.Client</A>&nbsp;client)</PRE>
<DL>
<DD>Detaches a client-connection from the pool. The client wont be closed.
  This method converts a pooled client to a single client. Only pooled
  clients, those aren't released, can be detached from its pool.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>client</CODE> - the client connection which is being returned to its pool<DT><B>Throws:</B><DD><CODE><A HREF="../../../../com/sap/mw/jco/JCO.Exception.html">JCO.Exception</A></CODE> - thrown if a connection could not be removed from pool cleanly</DL>
</DD>
</DL>
<HR>

<A NAME="removeConnection(com.sap.mw.jco.JCO.Connection)"><!-- --></A><H3>
removeConnection</H3>
<PRE>
public void <B>removeConnection</B>(<A HREF="../../../../com/sap/mw/jco/JCO.Connection.html">JCO.Connection</A>&nbsp;connection)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>This method will be removed in the next release.<br>Use <code>JCO.releaseClient(connection) instead</code></I>
<P>
<DD>Closes a connection and removes it from the pool<DD><DL>
<DT><B>Parameters:</B><DD><CODE>connection</CODE> - the connection which will be removed from its pool<DT><B>See Also: </B><DD><A HREF="../../../../com/sap/mw/jco/JCO.html#releaseClient(com.sap.mw.jco.JCO.Client)"><CODE>JCO.releaseClient(com.sap.mw.jco.JCO.Client)</CODE></A>, 
<A HREF="../../../../com/sap/mw/jco/JCO.PoolManager.html#releaseClient(com.sap.mw.jco.JCO.Client)"><CODE>releaseClient(com.sap.mw.jco.JCO.Client)</CODE></A>, 
<A HREF="../../../../com/sap/mw/jco/JCO.html#releaseClient(com.sap.mw.jco.JCO.Client)"><CODE>JCO.releaseClient(com.sap.mw.jco.JCO.Client)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getTimeoutCheckPeriod()"><!-- --></A><H3>
getTimeoutCheckPeriod</H3>
<PRE>
public long <B>getTimeoutCheckPeriod</B>()</PRE>
<DL>
<DD>Returns the default value for the timeout check period in milliseconds.
 This value will be used for new pools created by the pool manager.<br>
 The timeout check period specifies the periodical time interval after
 which all connections that have been released to a pool and are held
 open by the pool for possible future reuse are being checked for timeouts.
 Connections that have not been used for at least the <tt>connection
 timeout</tt> interval will be closed.<br>
 The default value is -1 and means that the timeout check period has
 not been specified by an application, so the default value of 60
 seconds (60000 ms) will be used.<DD><DL>
<DT><B>Returns:</B><DD>the timeout check period in milliseconds<DT><B>See Also: </B><DD><A HREF="../../../../com/sap/mw/jco/JCO.Pool.html#getTimeoutCheckPeriod()"><CODE>JCO.Pool.getTimeoutCheckPeriod()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setTimeoutCheckPeriod(long)"><!-- --></A><H3>
setTimeoutCheckPeriod</H3>
<PRE>
public void <B>setTimeoutCheckPeriod</B>(long&nbsp;timeout_check_period)</PRE>
<DL>
<DD>Sets the default value for the timeout check period in milliseconds.
 This value will be used for new pools created by the pool manager.<br>
 The timeout check period specifies the periodical time interval after
 which all connections that have been released to the pool and are held
 open by the pool for possible future reuse are being checked for timeouts.
 Connections that have not been used for at least the <tt>connection timeout</tt>
 interval will be closed.<br>
 A timeout check period of <tt>0</tt> disables the timeout checks.<br>
 The default value is 60 seconds (60000 ms).<DD><DL>
<DT><B>Parameters:</B><DD><CODE>timeout_check_period</CODE> - the timeout check period in milliseconds.<DT><B>Throws:</B><DD><CODE>java.lang.IllegalArgumentException</CODE> - if timeout_check_period is negative.<DT><B>See Also: </B><DD><A HREF="../../../../com/sap/mw/jco/JCO.Pool.html#setTimeoutCheckPeriod(long)"><CODE>JCO.Pool.setTimeoutCheckPeriod(long)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getConnectionTimeout()"><!-- --></A><H3>
getConnectionTimeout</H3>
<PRE>
public long <B>getConnectionTimeout</B>()</PRE>
<DL>
<DD>Returns the default value for the connection timeout in milliseconds.
 This value will be used for new pools created by the pool manager.<br>
 The default value is -1 and means that the connection timeout has not
 been specified by an application, so the default value of 10 minutes
  (600000 ms) will be used.<DD><DL>
<DT><B>Returns:</B><DD>the connection timeout in milliseconds<DT><B>See Also: </B><DD><A HREF="../../../../com/sap/mw/jco/JCO.Pool.html#getConnectionTimeout()"><CODE>JCO.Pool.getConnectionTimeout()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setConnectionTimeout(long)"><!-- --></A><H3>
setConnectionTimeout</H3>
<PRE>
public void <B>setConnectionTimeout</B>(long&nbsp;connection_timeout)</PRE>
<DL>
<DD>Sets the default value for the connection timeout in milliseconds.
 This value will be used for new pools created by the pool manager.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>connection_timeout</CODE> - the new value for the connection timeout in milliseconds<DT><B>See Also: </B><DD><A HREF="../../../../com/sap/mw/jco/JCO.Pool.html#setConnectionTimeout(long)"><CODE>JCO.Pool.setConnectionTimeout(long)</CODE></A>, 
<A HREF="../../../../com/sap/mw/jco/JCO.PoolManager.html#getConnectionTimeout()"><CODE>getConnectionTimeout()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getMaxWaitTime()"><!-- --></A><H3>
getMaxWaitTime</H3>
<PRE>
public final long <B>getMaxWaitTime</B>()</PRE>
<DL>
<DD>Returns the maximum time to wait in a connection request for a free
 connection. This value will be used for new pools created by the pool
 manager.<br>
 The default value is -1 and means that the maximum time to wait has not
 been specified by an application, so the default value of 30 seconds
  (30000 ms) will be used.<DD><DL>
<DT><B>Returns:</B><DD>Returns the maximum time to wait for a free connection
 in milliseconds<DT><B>See Also: </B><DD><A HREF="../../../../com/sap/mw/jco/JCO.Pool.html#getMaxWaitTime()"><CODE>JCO.Pool.getMaxWaitTime()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setMaxWaitTime(long)"><!-- --></A><H3>
setMaxWaitTime</H3>
<PRE>
public final void <B>setMaxWaitTime</B>(long&nbsp;max_wait_time)</PRE>
<DL>
<DD>Sets the maximum time to wait in a connection request for a free
 connection. This property will be used for new pools created by the
 pool manager.<br>
 If a pool is exhausted and after the specified time still no connection
 became available a <tt>JCO.Exception</tt> with the key
 <tt>JCO_ERROR_RESOURCE</tt> will be thrown.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>max_wait_time</CODE> - the maximum time to wait for a free connection
 in milliseconds<DD><CODE>max_wait_time</CODE> - the time to wait for a connection request<DT><B>See Also: </B><DD><A HREF="../../../../com/sap/mw/jco/JCO.PoolManager.html#getMaxWaitTime()"><CODE>getMaxWaitTime()</CODE></A>, 
<A HREF="../../../../com/sap/mw/jco/JCO.Pool.html#setMaxWaitTime(long)"><CODE>JCO.Pool.setMaxWaitTime(long)</CODE></A></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="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/JCO.PoolManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-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="../../../../com/sap/mw/jco/JCO.PoolChangedListener.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../com/sap/mw/jco/JCO.Record.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="JCO.PoolManager.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;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>

</BODY>
</HTML>