jcodestination.html

jco book to connect java with SAP

getSystemNumber</H3>
<PRE>
java.lang.String <B>getSystemNumber</B>()</PRE>
<DL>
<DD>Returns the SAP system number as specified in the destination
 properties. Returns null if this property was not set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>SAP system number<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_SYSNR"><CODE>DestinationDataProvider.JCO_SYSNR</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getLogonGroup()"><!-- --></A><H3>
getLogonGroup</H3>
<PRE>
java.lang.String <B>getLogonGroup</B>()</PRE>
<DL>
<DD>Returns the logon group as specified in the destination
 properties. Returns null if this property was not set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>logon group<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_GROUP"><CODE>DestinationDataProvider.JCO_GROUP</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getMessageServerHost()"><!-- --></A><H3>
getMessageServerHost</H3>
<PRE>
java.lang.String <B>getMessageServerHost</B>()</PRE>
<DL>
<DD>Returns the SAP message server as specified in the destination
 properties. Returns null if this property was not set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>SAP message server<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_MSHOST"><CODE>DestinationDataProvider.JCO_MSHOST</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getMessageServerService()"><!-- --></A><H3>
getMessageServerService</H3>
<PRE>
java.lang.String <B>getMessageServerService</B>()</PRE>
<DL>
<DD>Returns the SAP message server port as specified in the destination
 properties. Returns null if this property was not set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>SAP message server port<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_MSSERV"><CODE>DestinationDataProvider.JCO_MSSERV</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getR3Name()"><!-- --></A><H3>
getR3Name</H3>
<PRE>
java.lang.String <B>getR3Name</B>()</PRE>
<DL>
<DD>Returns the System ID of the SAP system as specified in the destination
 properties. Returns null if this property was not set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>System ID of the SAP system<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_R3NAME"><CODE>DestinationDataProvider.JCO_R3NAME</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getTPHost()"><!-- --></A><H3>
getTPHost</H3>
<PRE>
java.lang.String <B>getTPHost</B>()</PRE>
<DL>
<DD>Returns the Host of external server program as specified in the destination
 properties. Returns null if this property was not set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Host of external server program<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_TPHOST"><CODE>DestinationDataProvider.JCO_TPHOST</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getTPName()"><!-- --></A><H3>
getTPName</H3>
<PRE>
java.lang.String <B>getTPName</B>()</PRE>
<DL>
<DD>Returns the Program ID of external server program as specified in the destination
 properties. Returns null if this property was not set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Program ID of external server program<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_TPNAME"><CODE>DestinationDataProvider.JCO_TPNAME</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getSncLibrary()"><!-- --></A><H3>
getSncLibrary</H3>
<PRE>
java.lang.String <B>getSncLibrary</B>()</PRE>
<DL>
<DD>Returns the path to SNC library as specified in the destination
 properties. Returns null if this property was not set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>path to SNC library<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_SNC_LIBRARY"><CODE>DestinationDataProvider.JCO_SNC_LIBRARY</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getSncMode()"><!-- --></A><H3>
getSncMode</H3>
<PRE>
java.lang.String <B>getSncMode</B>()</PRE>
<DL>
<DD>Returns the SNC mode as specified in the destination
 properties. Returns null if this property was not set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>SNC mode<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_SNC_MODE"><CODE>DestinationDataProvider.JCO_SNC_MODE</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getSncMyName()"><!-- --></A><H3>
getSncMyName</H3>
<PRE>
java.lang.String <B>getSncMyName</B>()</PRE>
<DL>
<DD>Returns the own SNC name as specified in the destination
 properties. Returns null if this property was not set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>own SNC name<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_SNC_MYNAME"><CODE>DestinationDataProvider.JCO_SNC_MYNAME</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getSncPartnerName()"><!-- --></A><H3>
getSncPartnerName</H3>
<PRE>
java.lang.String <B>getSncPartnerName</B>()</PRE>
<DL>
<DD>Returns the SNC partner as specified in the destination
 properties. Returns null if this property was not set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>SNC partner<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_SNC_PARTNERNAME"><CODE>DestinationDataProvider.JCO_SNC_PARTNERNAME</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getSncQOP()"><!-- --></A><H3>
getSncQOP</H3>
<PRE>
java.lang.String <B>getSncQOP</B>()</PRE>
<DL>
<DD>Returns the SNC level of security as specified in the destination
 properties. Returns null if this property was not set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>SNC level of security<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_SNC_QOP"><CODE>DestinationDataProvider.JCO_SNC_QOP</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getAliasUser()"><!-- --></A><H3>
getAliasUser</H3>
<PRE>
java.lang.String <B>getAliasUser</B>()</PRE>
<DL>
<DD>Returns the alias of the logon user as specified in the destination
 properties. Returns null if this property was not set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>alias of the logon user<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_ALIAS_USER"><CODE>DestinationDataProvider.JCO_ALIAS_USER</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getClient()"><!-- --></A><H3>
getClient</H3>
<PRE>
java.lang.String <B>getClient</B>()</PRE>
<DL>
<DD>Returns SAP client as specified in the destination
 properties. Returns null if this property was not set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>SAP client<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_CLIENT"><CODE>DestinationDataProvider.JCO_CLIENT</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getLanguage()"><!-- --></A><H3>
getLanguage</H3>
<PRE>
java.lang.String <B>getLanguage</B>()</PRE>
<DL>
<DD>Returns the logon language as specified in the destination
 properties. Returns null if this property was not set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>logon language<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_LANG"><CODE>DestinationDataProvider.JCO_LANG</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getUser()"><!-- --></A><H3>
getUser</H3>
<PRE>
java.lang.String <B>getUser</B>()</PRE>
<DL>
<DD>Returns the logon user as specified in the destination
 properties. Returns null if this property was not set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>logon user<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_USER"><CODE>DestinationDataProvider.JCO_USER</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getLogonCheck()"><!-- --></A><H3>
getLogonCheck</H3>
<PRE>
java.lang.String <B>getLogonCheck</B>()</PRE>
<DL>
<DD>Returns the logon check mode as specified in the destination
 properties. Returns null if this property was not set.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>logon check mode<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_LCHECK"><CODE>DestinationDataProvider.JCO_LCHECK</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getPeakLimit()"><!-- --></A><H3>
getPeakLimit</H3>
<PRE>
int <B>getPeakLimit</B>()</PRE>
<DL>
<DD>Returns the maximum number of connections, that can be created
 for the destination simultaneously. This value is always greater than or equal to 
 pool capacity.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>maximum number of active connections</DL>
</DD>
</DL>
<HR>

<A NAME="getPoolCapacity()"><!-- --></A><H3>
getPoolCapacity</H3>
<PRE>
int <B>getPoolCapacity</B>()</PRE>
<DL>
<DD>Returns the maximum number of idle connections, that will be kept
 open in a pool.
 <br>A value of <tt>0</tt> means that the connections will be closed immedeatly 
 after being released, which has the effect that there is no connection pooling.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>maximum number of pooled connections</DL>
</DD>
</DL>
<HR>

<A NAME="getExpirationTime()"><!-- --></A><H3>
getExpirationTime</H3>
<PRE>
long <B>getExpirationTime</B>()</PRE>
<DL>
<DD>Returns the time in ms, after which a free connection,
 that is hold internally for the destination,
 is being regarded as expired and will be closed during
 next run of the expiration checker.
 <br><tt>0</tt> means the connections will be closed immediately 
 after release.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>expiration time</DL>
</DD>
</DL>
<HR>

<A NAME="getExpirationCheckPeriod()"><!-- --></A><H3>
getExpirationCheckPeriod</H3>