📄 destinationdataprovider.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_14) on Mon Apr 06 00:12:36 CEST 2009 -->
<TITLE>
DestinationDataProvider (JCo API 3.0)
</TITLE>
<META NAME="keywords" CONTENT="com.sap.conn.jco.ext.DestinationDataProvider interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../sap.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="DestinationDataProvider (JCo API 3.0)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" 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_top_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> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DestinationDataProvider.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../com/sap/conn/jco/ext/DestinationDataEventListener.html" title="interface in com.sap.conn.jco.ext"><B>PREV CLASS</B></A>
<A HREF="../../../../../com/sap/conn/jco/ext/Environment.html" title="class in com.sap.conn.jco.ext"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/sap/conn/jco/ext/DestinationDataProvider.html" target="_top"><B>FRAMES</B></A>
<A HREF="DestinationDataProvider.html" target="_top"><B>NO FRAMES</B></A>
<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: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sap.conn.jco.ext</FONT>
<BR>
Interface DestinationDataProvider</H2>
<HR>
<DL>
<DT><PRE>public interface <B>DestinationDataProvider</B></DL>
</PRE>
<P>
The class implements this interface to provide the properties for a client connection to a remote SAP system. Depending on the type of middleware layer loaded, the properties that need to be provided by the implementation of the DestinationDataProvider may vary.<br> For <tt>MiddlewareJavaRfc</tt>, i.e. the default RFC layer, the supported properties are:<p> <table border=1> <tr><td>jco.client.client </td><td>SAP client</td></tr> <tr><td>jco.client.user </td><td>Logon user</td></tr> <tr><td>jco.client.alias_user </td><td>Logon user alias</td></tr> <tr><td>jco.client.passwd </td><td>Logon password</td></tr> <tr><td>jco.client.lang </td><td>Logon language</td></tr> <tr><td>jco.client.saprouter </td><td>SAP router string to use for a system protected by a firewall</td></tr> <tr><td>jco.client.sysnr </td><td>SAP system number</td></tr> <tr><td>jco.client.ashost </td><td>SAP application server</td></tr> <tr><td>jco.client.mshost </td><td>SAP message server</td></tr> <tr><td>jco.client.msserv </td><td>optional: SAP message server port to use instead of the default sapms<sysid> </td></tr> <tr><td>jco.client.gwhost </td><td>Gateway host</td></tr> <tr><td>jco.client.gwserv </td><td>Gateway service</td></tr> <tr><td>jco.client.r3name </td><td>System ID of the SAP system</td></tr> <tr><td>jco.client.group </td><td>Group of SAP application servers</td></tr> <tr><td>jco.client.tpname </td><td>Program ID of external server program</td></tr> <tr><td>jco.client.tphost </td><td>Host of external server program</td></tr> <tr><td>jco.client.type </td><td>Type of remote host 2 = R/2, 3 = R/3, E = External</td></tr> <tr><td>jco.client.trace </td><td>Enable/disable RFC trace (0 or 1)</td></tr> <tr><td>jco.client.cpic_trace </td><td>Enable/disable CPIC trace (-1 [take over environment value], 0 no trace, 1,2,3 different amount of trace) </td></tr> <tr><td>jco.client.use_sapgui </td><td>Start a SAP GUI and associate with the connection. (0 - do not start [default], 1 start GUI, 2 start GUI and hide if not used)</td></tr> <tr><td>jco.client.codepage </td><td>Initial codepage in SAP notation</td></tr> <tr><td>jco.client.getsso2 </td><td>Get/Don't get a SSO ticket after logon (1 or 0)</td></tr> <tr><td>jco.client.mysapsso2 </td><td>Use the specified SAP Cookie Version 2 as logon ticket</td></tr> <tr><td>jco.client.x509cert </td><td>Use the specified X509 certificate as logon ticket</td></tr> <tr><td>jco.client.lcheck </td><td>Enable/Disable logon check at open time, 1 (enable) or 0 (disable)</td></tr> <tr><td>jco.client.snc_mode </td><td>Secure network connection (SNC) mode, 0 (off) or 1 (on)</td></tr> <tr><td>jco.client.snc_partnername</td><td>SNC partner, e.g. p:CN=R3, O=XYZ-INC, C=EN</td></tr> <tr><td>jco.client.snc_qop </td><td>SNC level of security, 1 to 9</td></tr> <tr><td>jco.client.snc_myname </td><td>SNC name. Overrides default SNC partner</td></tr> <tr><td>jco.client.snc_lib </td><td>Path to library which provides SNC service</td></tr> <tr><td>jco.client.dsr </td><td>Enable/Disable dsr support (0 or 1)</td></tr> <tr><td>jco.destination.peak_limit </td><td>Maximum number of active connections that can be created for a destination simultaneously</td></tr> <tr><td>jco.destination.pool_capacity </td><td>Maximum number of idle connections kept open by the destination. A value of <tt>0</tt> has the effect that there is no connection pooling. </td></tr> <tr><td>jco.destination.expiration_time </td><td>Time in ms after that the connections hold by the destination can be closed</td></tr> <tr><td>jco.destination.expiration_check_period</td><td>Period in ms after that the destination checks the released connections for expiration</td></tr> <tr><td>jco.destination.max_get_client_time </td><td>Max time in ms to wait for a connection, if the max allowed number of connections is allocated by the application</td></tr> <tr><td>jco.destination.repository_destination</td><td>Specifies which destination should be used as repository, i.e. use this destination's repository</td></tr> <tr><td>jco.destination.repository.user</td> <td>Optional: If repository destination is not set, and this property is set, it will be used as user for repository calls. This allows using a different user for repository lookups </td></tr> <tr><td>jco.destination.repository.passwd</td><td>The password for a repository user. Mandatory, if a repository user should be used. </td></tr> <tr><td>jco.destination.repository.snc_mode</td><td>Optional: If SNC is used for this destination, it is possible to turn it off for repository connections, if this property is set to 0. Defaults to the value of jco.client.snc_mode</td></tr> </table> <p> The properties build 4 properties groups: <ul> <li>user logon properties</li> <li>configuration for physical connection <li>SNC configuration <li>destination configuration </ul> <dl> <dt>user logon properties</dt> <dd> SAP client and language<br> user/user alias with password or SSO Ticket </dd> <dt>configuration for physical connection</dt> <dd> <dl> <dt>direct connection to SAP instance</dt> <dd>SAP application server and system number<br> </dd> <dt>load balancing connection to a group of SAP instances</dt> <dd> System ID of the SAP system, SAP message server and the group name of SAP application servers are mandatory.<br> To avoid lookup in the configuration file you may define SAP message server port </dd> </dl> SAP router string can be used in both cases, if the SAP systems is behind an SAP router. </dd> <dt>SNC configuration</dt> <dd> SNC mode has to be set to 1, if secure communication is required<br> Depends on your need define other SNC property. See for details <a href="http://service.sap.com/security">security in details</a> </dd> <dt>destination configuration</dt> <dd> Number of connection can be created by the destination and kept open for reuse,<br> waiting time, if all connections are in use,<br> repository configuration. </dd> </dl> <p> <em>Note:</em> Depending on the SAP system release, logins using Single-Sign-On (SSO) or X.509 certificates are being supported.<br> The logon with X.509 is based on SNC-encryption and can only be used in combination with a secure network connection. </p>
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_ALIAS_USER">JCO_ALIAS_USER</A></B></CODE>
<BR>
Logon user alias, can be used instead of logon user</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_ASHOST">JCO_ASHOST</A></B></CODE>
<BR>
SAP ABAP application server, mandatory for a direct connection</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_CLIENT">JCO_CLIENT</A></B></CODE>
<BR>
SAP client, mandatory logon parameter</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_CODEPAGE">JCO_CODEPAGE</A></B></CODE>
<BR>
additional logon parameter to define the codepage that will used to convert the logon parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_CPIC_TRACE">JCO_CPIC_TRACE</A></B></CODE>
<BR>
Enable/disable CPIC trace [0..3]</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_DEST">JCO_DEST</A></B></CODE>
<BR>
For internal purposes only</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_EXPIRATION_PERIOD">JCO_EXPIRATION_PERIOD</A></B></CODE>
<BR>
Period in ms after that the destination checks the released connections for expiration</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_EXPIRATION_TIME">JCO_EXPIRATION_TIME</A></B></CODE>
<BR>
Time in ms after that a free connections hold internally by the destination can be closed</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_GETSSO2">JCO_GETSSO2</A></B></CODE>
<BR>
Order a SSO ticket after logon, the obtained ticket is available in the destination attributes</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_GROUP">JCO_GROUP</A></B></CODE>
<BR>
Group of SAP application servers, mandatory for a logon balancing connection</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/sap/conn/jco/ext/DestinationDataProvider.html#JCO_GWHOST">JCO_GWHOST</A></B></CODE>
<BR>
For internal purposes only</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -