jco.html

jco book to connect java with SAP

<PRE>
public static java.util.List&lt;java.lang.String&gt; <B>getServerIDs</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getServerMonitor(java.lang.String)"><!-- --></A><H3>
getServerMonitor</H3>
<PRE>
public static <A HREF="../../../../com/sap/conn/jco/monitor/JCoServerMonitor.html" title="interface in com.sap.conn.jco.monitor">JCoServerMonitor</A> <B>getServerMonitor</B>(java.lang.String&nbsp;serverID)
                                         throws <A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></PRE>
<DL>
<DD>Returns the server monitor for the given server ID
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>serverID</CODE> - the server ID for which the monitor should be returned
<DT><B>Returns:</B><DD>the server monitor for the server
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></CODE> - if something goes wrong
<DD><CODE>java.lang.UnsupportedOperationException</CODE> - if server monitoring is not supported in the current environment</DL>
</DD>
</DL>
<HR>

<A NAME="getConnectionMonitor()"><!-- --></A><H3>
getConnectionMonitor</H3>
<PRE>
public static <A HREF="../../../../com/sap/conn/jco/monitor/JCoConnectionMonitor.html" title="class in com.sap.conn.jco.monitor">JCoConnectionMonitor</A> <B>getConnectionMonitor</B>()</PRE>
<DL>
<DD>Returns the connection monitor for all currently available connections.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the connection monitor
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></CODE> - if something goes wrong
<DD><CODE>java.lang.UnsupportedOperationException</CODE> - if the monitor is not supported in the current environment</DL>
</DD>
</DL>
<HR>

<A NAME="createThroughput()"><!-- --></A><H3>
createThroughput</H3>
<PRE>
public static <A HREF="../../../../com/sap/conn/jco/JCoThroughput.html" title="interface in com.sap.conn.jco">JCoThroughput</A> <B>createThroughput</B>()</PRE>
<DL>
<DD>Returns a newly created instance of JCoThroughput.
 
 Throughput instance can be used to measure the performance of an RFC call
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a newly created JCoThroughput</DL>
</DD>
</DL>
<HR>

<A NAME="getMiddlewareProperty(java.lang.String)"><!-- --></A><H3>
getMiddlewareProperty</H3>
<PRE>
public static java.lang.String <B>getMiddlewareProperty</B>(java.lang.String&nbsp;key)</PRE>
<DL>
<DD>Returns the current value for the given middleware property or null,
 if there is no value set.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - the name of the property for which you want to get the value
<DT><B>Returns:</B><DD>the current value of the property</DL>
</DD>
</DL>
<HR>

<A NAME="getProperty(java.lang.String)"><!-- --></A><H3>
getProperty</H3>
<PRE>
public static java.lang.String <B>getProperty</B>(java.lang.String&nbsp;key)</PRE>
<DL>
<DD>Returns the current value for the given JCo property or null,
 if there is no value set.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - the name of the property for which you want to get the value
<DT><B>Returns:</B><DD>the current value of the property</DL>
</DD>
</DL>
<HR>

<A NAME="setMiddlewareProperty(java.lang.String, java.lang.String)"><!-- --></A><H3>
setMiddlewareProperty</H3>
<PRE>
public static void <B>setMiddlewareProperty</B>(java.lang.String&nbsp;key,
                                         java.lang.String&nbsp;value)</PRE>
<DL>
<DD>Sets a value for the given middleware property. If the value is not applicaple
 to the given property, a JCoRuntimeException will be thrown.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - the name of the property for which you want to set the value<DD><CODE>value</CODE> - the new value, that the property should get
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></CODE> - if the value is not fitting to the property</DL>
</DD>
</DL>
<HR>

<A NAME="setProperty(java.lang.String, java.lang.String)"><!-- --></A><H3>
setProperty</H3>
<PRE>
public static void <B>setProperty</B>(java.lang.String&nbsp;key,
                               java.lang.String&nbsp;value)</PRE>
<DL>
<DD>Sets a value for the given JCo property. If the value is not applicaple
 to the given property, a JCoRuntimeException will be thrown.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - the name of the property for which you want to set the value<DD><CODE>value</CODE> - the new value, that the property should get
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sap/conn/jco/JCoRuntimeException.html" title="class in com.sap.conn.jco">JCoRuntimeException</A></CODE> - if the value is not fitting to the property</DL>
</DD>
</DL>
<HR>

<A NAME="addTraceListener(com.sap.conn.jco.JCoTraceListener)"><!-- --></A><H3>
addTraceListener</H3>
<PRE>
public static void <B>addTraceListener</B>(<A HREF="../../../../com/sap/conn/jco/JCoTraceListener.html" title="interface in com.sap.conn.jco">JCoTraceListener</A>&nbsp;listener)</PRE>
<DL>
<DD>Adds a trace listener, that receives all trace events of JCo
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - An instance of JCoTraceListener, that shall be added to the listener list</DL>
</DD>
</DL>
<HR>

<A NAME="removeTraceListener(com.sap.conn.jco.JCoTraceListener)"><!-- --></A><H3>
removeTraceListener</H3>
<PRE>
public static void <B>removeTraceListener</B>(<A HREF="../../../../com/sap/conn/jco/JCoTraceListener.html" title="interface in com.sap.conn.jco">JCoTraceListener</A>&nbsp;listener)</PRE>
<DL>
<DD>Removes the given trace listener from the list of JCoTraceListeners
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - An instance of JCoTraceListener, that shall be removed from the listener list</DL>
</DD>
</DL>
<HR>

<A NAME="setTrace(int, java.lang.String)"><!-- --></A><H3>
setTrace</H3>
<PRE>
public static void <B>setTrace</B>(int&nbsp;level,
                            java.lang.String&nbsp;path)</PRE>
<DL>
<DD>Turns on the JCo trace. 
 Allowed levels are [0 .. 10]. The common used are:
 <ul>
  <li> 0 - nothing
  <li> 1 - errors and warnings
  <li> 2 - execution path, errors and warnings
  <li> 3 - full execution path, errors and warnings
  <li> 4 - execution path, info messages, errors and warnings
  <li> 6 - full execution path, info messages, errors and warnings
  <li> 7 - debug messages, full execution path, info messages, errors and warnings
  <li> 8 - verbose debug messages, full execution path, info messages, errors and warnings
 </ul> 
 
 As path value <tt>null</tt>, <tt>stdout</tt>, <tt>stderr</tt> or
 an existing path are allowed.
 
 If path is equals <tt>null</tt> or <tt>stdout</tt> or <tt>stderr</tt>
 JCo will trace out to the standard output (error) stream. If at least one 
 <tt>JCoTraceListener</tt> is registered, the trace output will be sent 
 to the listener only. To redirect the JCo trace into a file, the path value
 has to be set to an existing directory.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>level</CODE> - [0 .. 10]<DD><CODE>path</CODE> - <tt>null</tt>, <tt>stdout</tt>, <tt>stderr</tt> or an existing path</DL>
</DD>
</DL>
<HR>

<A NAME="getTraceLevel()"><!-- --></A><H3>
getTraceLevel</H3>
<PRE>
public static int <B>getTraceLevel</B>()</PRE>
<DL>
<DD>Return the current trace level. 
 See documentation for the method setTrace
<P>
<DD><DL>

<DT><B>Returns:</B><DD>trace level [0..10]<DT><B>See Also:</B><DD><A HREF="../../../../com/sap/conn/jco/JCo.html#setTrace(int, java.lang.String)"><CODE>setTrace(int, String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getTracePath()"><!-- --></A><H3>
getTracePath</H3>
<PRE>
public static java.lang.String <B>getTracePath</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <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/JCo.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="../../../../com/sap/conn/jco/ConversionException.html" title="class in com.sap.conn.jco"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../com/sap/conn/jco/JCoAttributes.html" title="interface in com.sap.conn.jco"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?com/sap/conn/jco/JCo.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="JCo.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&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;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<i>Copyright &#169; 2008 SAP AG. All Rights Reserved.</i>
</BODY>
</HTML>