jco.server.html

SAP ERP的二次开发

<A NAME="abort(java.lang.String)"><!-- --></A><H3>
abort</H3>
<PRE>
public void <B>abort</B>(java.lang.String&nbsp;message)</PRE>
<DL>
<DD>Aborts the connection to the remote system, i.e.
  tries to send a final message to the host before it disconnects.<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/sap/mw/jco/JCO.Connection.html#abort(java.lang.String)">abort</A></CODE> in class <CODE><A HREF="../../../../com/sap/mw/jco/JCO.Connection.html">JCO.Connection</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the final message which will be sent to the remote system.</DL>
</DD>
</DL>
<HR>

<A NAME="start()"><!-- --></A><H3>
start</H3>
<PRE>
public void <B>start</B>()</PRE>
<DL>
<DD>Starts or resumes execution of the server thread<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="stop()"><!-- --></A><H3>
stop</H3>
<PRE>
public void <B>stop</B>()</PRE>
<DL>
<DD>Forces the server and its underlying thread to stop execution
  The server can not be restarted after this method has been
  called. To temporarily stop a server use <tt>suspend()</tt>
  instead.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>See Also: </B><DD><A HREF="../../../../com/sap/mw/jco/JCO.Server.html#suspend()"><CODE>suspend()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="suspend()"><!-- --></A><H3>
suspend</H3>
<PRE>
public void <B>suspend</B>()</PRE>
<DL>
<DD>Forces the server to temporarily stop execution.
  The server can be restarted using the start() method.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>See Also: </B><DD><A HREF="../../../../com/sap/mw/jco/JCO.Server.html#start()"><CODE>start()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="run()"><!-- --></A><H3>
run</H3>
<PRE>
public void <B>run</B>()</PRE>
<DL>
<DD>Implements the run method from the runnable interface<DD><DL>
<DT><B>Specified by: </B><DD><CODE>run</CODE> in interface <CODE>java.lang.Runnable</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="isAlive()"><!-- --></A><H3>
isAlive</H3>
<PRE>
public boolean <B>isAlive</B>()</PRE>
<DL>
<DD>Checks whether the server is still alive<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/sap/mw/jco/JCO.Connection.html#isAlive()">isAlive</A></CODE> in class <CODE><A HREF="../../../../com/sap/mw/jco/JCO.Connection.html">JCO.Connection</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD><tt>true</tt> if the server is alive, <tt>false</tt> otherwise</DL>
</DD>
</DL>
<HR>

<A NAME="checkAuthorization(java.lang.String, int, java.lang.String, byte[])"><!-- --></A><H3>
checkAuthorization</H3>
<PRE>
protected boolean <B>checkAuthorization</B>(java.lang.String&nbsp;function_name,
                                  int&nbsp;authorization_mode,
                                  java.lang.String&nbsp;authorization_partner,
                                  byte[]&nbsp;authorization_key)</PRE>
<DL>
<DD>Called by the jni-layer to check for authorization in case of SNC usage
 for the server connection.<br>
 
  Derived servers will override this function to actually implement
  the authorization handling. The method has to return <tt>true</tt> if the
  the request should be accepted and it returns <tt>false</tt> if the caller
  is not authorized to invoke the function.<br>

  <em>Note:</em>This method will be invoked only if SNC is used on the server connection.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>function_name</CODE> - the function that has been called by a remote client<DD><CODE>authorization_mode</CODE> - the mode of the authorization:
 <table border=1>
 <tr><th>Mode                </th><th>Description                           </th></tr>
 <tr><td>AUTHORIZATION_SNC   </td><td>Secure Network compliant authorization</td></tr>
 <tr><td>AUTHORIZATION_BASIC </td><td>Basic authorization                   </td></tr>
 </table><DD><CODE>authorization_partner</CODE> - the partner (system) name where the request comes from<DD><CODE>authorization_key</CODE> - the authorization key as binary data depending on the mode<DT><B>Returns:</B><DD>true if the request should be accepted and <tt>false</tt> otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="handleRequest(com.sap.mw.jco.JCO.Function)"><!-- --></A><H3>
handleRequest</H3>
<PRE>
protected void <B>handleRequest</B>(<A HREF="../../../../com/sap/mw/jco/JCO.Function.html">JCO.Function</A>&nbsp;function)
                   throws java.lang.Exception</PRE>
<DL>
<DD>Called after a request for a service has arrived.<br>
  Derived servers will override this function to actually implement
  a specific request handling.<br>
  When this routine exits without any pending exception the output
  parameters and tables will be sent back to the calling SAP system.
  If an exception has been thrown and is still pending, JCo handles it
  according to the following rules:<br>
  a) The exception is a <tt>JCO.AbapException</tt> or
  <tt>JCO.J2EEAbapException</tt> or the message text of the
  exception is the name of one of the exceptions specified in the call
  interface of the ABAP module. JCo will raise a corresponding ABAP
  exception in such a case and pass the exception's message text
  into the SAP system variables SY-MSGV1 to SY-MSGV4.<br>
  b) The exception is not a JCO.AbapException and the message text does
  not correspond to one of the ABAP exceptions. In this case JCo will
  raise a system exception in the calling SAP system.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>function</CODE> - the function that has been called by a remote client</DL>
</DD>
</DL>
<HR>

<A NAME="handleRequest(com.sap.mw.jco.JCO.Request, com.sap.mw.jco.JCO.Response)"><!-- --></A><H3>
handleRequest</H3>
<PRE>
protected void <B>handleRequest</B>(<A HREF="../../../../com/sap/mw/jco/JCO.Request.html">JCO.Request</A>&nbsp;request,
                          <A HREF="../../../../com/sap/mw/jco/JCO.Response.html">JCO.Response</A>&nbsp;response)
                   throws java.lang.Exception</PRE>
<DL>
<DD>Called after a request for a service has arrived.<br>
  Derived servers will override this function to actually implement
  a specific request handling.<br>
  When this routine exits without any pending exception the output
  parameters and tables will be sent back to the calling SAP system.
  If an exception has been thrown and is still pending, JCo handles it
  according to the following rules:<br>
  a) The exception is a <tt>JCO.AbapException</tt> or
  <tt>JCO.J2EEAbapException</tt> or the message text of the
  exception is the name of one of the exceptions specified in the call
  interface of the ABAP module. JCo will raise a corresponding ABAP
  exception in such a case and pass the exception's message text
  into the SAP system variables SY-MSGV1 to SY-MSGV4.<br>
  b) The exception is not a JCO.AbapException and the message text does
  not correspond to one of the ABAP exceptions. In this case JCo will
  raise a system exception in the calling SAP system.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the request container filled with the data from the calling program<DD><CODE>response</CODE> - the response container whose contents will be send back to
                  the calling SAP system.</DL>
</DD>
</DL>
<HR>

<A NAME="onCheckTID(java.lang.String)"><!-- --></A><H3>
onCheckTID</H3>
<PRE>
protected boolean <B>onCheckTID</B>(java.lang.String&nbsp;tid)</PRE>
<DL>
<DD>This function will be invoked when a transactional RFC is being called from a
  SAP system. The function has to store the TID in permanent storage and return <tt>true</tt>.
  The method has to return <tt>false</tt> if the a transaction with this ID has already
  been processed. Throw an exception if anything goes wrong. The transaction processing will be
  aborted thereafter.<br>
  Derived servers must override this method to actually implement the transaction ID management.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>tid</CODE> - the transaction ID<DT><B>Returns:</B><DD><tt>true</tt> if the ID is valid and not in use, <tt>false</tt> otherwise</DL>
</DD>
</DL>
<HR>

<A NAME="onConfirmTID(java.lang.String)"><!-- --></A><H3>
onConfirmTID</H3>
<PRE>
protected void <B>onConfirmTID</B>(java.lang.String&nbsp;tid)</PRE>
<DL>
<DD>This function will be called after the <em>local</em> transaction has been completed.
  All resources associated with this TID can be released.<br>
  Derived servers must override this method to actually implement the transaction ID management.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>tid</CODE> - the transaction ID</DL>
</DD>
</DL>
<HR>

<A NAME="onCommit(java.lang.String)"><!-- --></A><H3>
onCommit</H3>
<PRE>
protected void <B>onCommit</B>(java.lang.String&nbsp;tid)</PRE>
<DL>
<DD>This function will be called after <em>all</em> RFC functions belonging to a certain transaction
  have been successfully completed. <br>
  Derived servers can override this method to locally commit the transaction.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>tid</CODE> - the transaction ID</DL>
</DD>
</DL>
<HR>

<A NAME="onRollback(java.lang.String)"><!-- --></A><H3>
onRollback</H3>
<PRE>
protected void <B>onRollback</B>(java.lang.String&nbsp;tid)</PRE>
<DL>
<DD>This function will be called if an error in one of the RFC functions belonging to
  a certain transaction has occurred.<br>
  Derived servers can override this method to locally rollback the transaction.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>tid</CODE> - the transaction ID</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.Server.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.Response.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../com/sap/mw/jco/JCO.ServerErrorListener.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.Server.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>

</BODY>
</HTML>