sessionreferenceprovider.html

jco book to connect java with SAP

<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="getCurrentSessionReference(java.lang.String)"><!-- --></A><H3>
getCurrentSessionReference</H3>
<PRE>
<A HREF="../../../../../com/sap/conn/jco/ext/JCoSessionReference.html" title="interface in com.sap.conn.jco.ext">JCoSessionReference</A> <B>getCurrentSessionReference</B>(java.lang.String&nbsp;scopeType)</PRE>
<DL>
<DD>This method is invoked by JCo in order to find out, in which session it is running. This
 is necessary in case of a <code>JCoContext</code> has been started, so that from now on the same 
 physical connection should be used for keeping alive the user context in the application
 server ABAP. If the scope type is <code>null</code> or the empty String, the default scope 
 should be used, according to the definition of the runtime environment.
 Runtime environments that do not provide a scope management within sessions, can simply 
 ignore the scope type parameter in their implementation of a SessionReferenceProvider.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>scopeType</CODE> - defines the scope, for which the session reference is needed
<DT><B>Returns:</B><DD>a JCoSessionReference that identifies the current session, in which the method is
         invoked</DL>
</DD>
</DL>
<HR>

<A NAME="isSessionAlive(java.lang.String)"><!-- --></A><H3>
isSessionAlive</H3>
<PRE>
boolean <B>isSessionAlive</B>(java.lang.String&nbsp;sessionId)</PRE>
<DL>
<DD>JCo will invoke this method in order to check whether a session is still alive. If 
 the session has been ended, JCo can release the connections associated with this session, and thus
 resources. In a standalone environment, this happens for example in a special timeout checker thread.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sessionId</CODE> - The session ID, for which it should be checked whether the session is alive.
<DT><B>Returns:</B><DD>true if the session is alive false otherwise</DL>
</DD>
</DL>
<HR>

<A NAME="jcoServerSessionStarted()"><!-- --></A><H3>
jcoServerSessionStarted</H3>
<PRE>
<A HREF="../../../../../com/sap/conn/jco/ext/JCoSessionReference.html" title="interface in com.sap.conn.jco.ext">JCoSessionReference</A> <B>jcoServerSessionStarted</B>()
                                            throws <A HREF="../../../../../com/sap/conn/jco/ext/SessionException.html" title="class in com.sap.conn.jco.ext">SessionException</A></PRE>
<DL>
<DD>The following four methods will be invoked by the JCo runtime to notify the
 implementation of the <code>SessionReferenceProvider</code> (Session Management) about
 the sessions initiated by an ABAP Application Server. 
 
 This method will be invoked before the first RFC call from an ABAP Application 
 Server is passed to the <code>JCoHandlerFactory</code> and as a consequence a session
 has been started.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the session reference for the new JCoServer session
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/sap/conn/jco/ext/SessionException.html" title="class in com.sap.conn.jco.ext">SessionException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="jcoServerSessionContinued(java.lang.String)"><!-- --></A><H3>
jcoServerSessionContinued</H3>
<PRE>
void <B>jcoServerSessionContinued</B>(java.lang.String&nbsp;sessionID)
                               throws <A HREF="../../../../../com/sap/conn/jco/ext/SessionException.html" title="class in com.sap.conn.jco.ext">SessionException</A></PRE>
<DL>
<DD>This method will be invoked before a subsequent RFC call for a <code>JCoServer</code>
 session is passed to the <code>JCoHandlerFactory</code>. This will only occur, if 
 the server connection was turned to stateful by the server or the client application.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sessionID</CODE> - sessionID of the continued <code>JCoServer</code> session
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/sap/conn/jco/ext/SessionException.html" title="class in com.sap.conn.jco.ext">SessionException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../../com/sap/conn/jco/server/JCoServerContext.html#setStateful(boolean)"><CODE>JCoServerContext.setStateful(boolean)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="jcoServerSessionPassivated(java.lang.String)"><!-- --></A><H3>
jcoServerSessionPassivated</H3>
<PRE>
void <B>jcoServerSessionPassivated</B>(java.lang.String&nbsp;sessionID)
                                throws <A HREF="../../../../../com/sap/conn/jco/ext/SessionException.html" title="class in com.sap.conn.jco.ext">SessionException</A></PRE>
<DL>
<DD>This method will be invoked after the processing of an RFC call 
 in a <code>JCoServer</code> session has finished .
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sessionID</CODE> - sessionID of the passivated <code>JCoServer</code> session
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/sap/conn/jco/ext/SessionException.html" title="class in com.sap.conn.jco.ext">SessionException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="jcoServerSessionFinished(java.lang.String)"><!-- --></A><H3>
jcoServerSessionFinished</H3>
<PRE>
void <B>jcoServerSessionFinished</B>(java.lang.String&nbsp;sessionID)</PRE>
<DL>
<DD>This method will be invoked when a <code>JCoServer</code> session has finished, i.e. the connection has been
 or will be closed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sessionID</CODE> - sessionID of the finished <code>JCoServer</code> session</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/SessionReferenceProvider.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/ext/SessionException.Type.html" title="enum in com.sap.conn.jco.ext"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html?com/sap/conn/jco/ext/SessionReferenceProvider.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="SessionReferenceProvider.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;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>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

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