Java 连接 SAP 配置文件
?Class?Use?Tree?Deprecated?Index?Help???PREV CLASS? ?NEXT CLASSFRAMES?? ?NO FRAMESSUMMARY: ?INNER?|?FIELD?|?CONSTR?|?METHODDETAIL: ?FIELD?|?CONSTR?|?METHOD

com.sap.mw.jco

Class JCO

java.lang.Object  |  +--com.sap.mw.jco.JCO

---

public class?JCOextends java.lang.Object

The SAP Java Connector (JCo) package provides an API which enables communication with SAP systems. The toolkit supports client as well as server functionality.

?

---

Inner Class SummaryField SummaryMethod SummaryMethods inherited from class java.lang.ObjectField Detail

?

UNINITIALIZED

public static final int UNINITIALIZED

The field info was not initialized yet

---

TYPE_INVALID

public static final int TYPE_INVALID

The field info does not contain a valid JCO data-type

---

TYPE_CHAR

public static final int TYPE_CHAR

1-byte or multibyte character. Fixed sized, blank padded. Corresponds to ABAP type 'C'.

---

TYPE_DATE

public static final int TYPE_DATE

Date ( YYYYYMMDD ). Corresponds to ABAP type 'D'.

---

TYPE_BCD

public static final int TYPE_BCD

Packed BCD number, any length between 1 and 16 bytes. Corresponds to ABAP type 'P'.

---

TYPE_TIME

public static final int TYPE_TIME

Time (HHMMSS). Corresponds to ABAP type 'T'

---

TYPE_BYTE

public static final int TYPE_BYTE

Raw data, binary, fixed length, zero padded. Corresponds to ABAP type 'X'.

---

TYPE_ITAB

public static final int TYPE_ITAB

Internal table. (Not used)

---

TYPE_NUM

public static final int TYPE_NUM

Digits, fixed size,'0' padded. Corresponds to ABAP type 'N'.

---

TYPE_FLOAT

public static final int TYPE_FLOAT

Floating point,double precision. Corresponds to ABAP type 'F'.

---

TYPE_INT

public static final int TYPE_INT

4-byte integer . Corresponds to ABAP type 'I'.

---

TYPE_INT2

public static final int TYPE_INT2

2-byte integer . Corresponds to ABAP type 's'.

---

TYPE_INT1

public static final int TYPE_INT1

1-byte integer . Corresponds to ABAP type 'b'.

---

TYPE_STRING

public static final int TYPE_STRING

Unicode string in UTF8 encoding. Corresponds to ABAP type 'g'.

---

TYPE_XSTRING

public static final int TYPE_XSTRING

Unicode string in binary encoding. Corresponds to ABAP type 'y'.

---

TYPE_STRUCTURE

public static final int TYPE_STRUCTURE

A heterogeneous structure. Corresponds to ABAP type 'u'.

---

TYPE_TABLE

public static final int TYPE_TABLE

A Table. Corresponds to ABAP type 'h'.

---

TYPE_EXCEPTION

public static final int TYPE_EXCEPTION

ABAP exception.

---

IDOC_VERSION_DEFAULT

public static final char IDOC_VERSION_DEFAULT

IDOC Version default

---

IDOC_VERSION_2

public static final char IDOC_VERSION_2

IDOC Version 2

---

IDOC_VERSION_3

public static final char IDOC_VERSION_3

IDOC Version 3

---

IMPORT_PARAMETER

public static final int IMPORT_PARAMETER

Flag that indicates an import parameter

---

EXPORT_PARAMETER

public static final int EXPORT_PARAMETER

Flag that indicates a export parameter

---

OPTIONAL_PARAMETER

public static final int OPTIONAL_PARAMETER

Flag that indicates an optional parameter

---

UNINITIALIZED_PARAMETER

public static final int UNINITIALIZED_PARAMETER

Flag that indicates an uninitialized parameter

---

INACTIVE_PARAMETER

public static final int INACTIVE_PARAMETER

Flag that indicates that the parameter is being excluded from a call

---

STATE_DISCONNECTED

public static final byte STATE_DISCONNECTED

Flag which is being set if the connection is in a closed state

---

STATE_CONNECTED

public static final byte STATE_CONNECTED

Flag which is being set if the client connection is connected

---

STATE_STOPPED

public static final byte STATE_STOPPED

Flag which is being set if the server has been stopped

---

STATE_STARTED

public static final byte STATE_STARTED

Flag which is being set if the server has been started

---

STATE_BUSY

public static final byte STATE_BUSY

Flag which indicates that the connection is busy

---

STATE_LISTENING

public static final byte STATE_LISTENING

Flag which indicates that the server is listening

---

STATE_USED

public static final byte STATE_USED

Flag which indicates that the client connection is allocated by a pool

---

STATE_TRANSACTION

public static final byte STATE_TRANSACTION

Flag which indicates that the connection is handling a transaction

---

STATE_SUSPENDED

public static final byte STATE_SUSPENDED

Flag which indicates that the connection has been temporarily suspended

---

SNC_OPEN

public static final byte SNC_OPEN

Flag for secure network communication, enables plain text communication, but with authorization

---

SNC_INTEGRITY

public static final byte SNC_INTEGRITY

Flag for secure network communication, ensure integrity of each data packet

---

SNC_PRIVACY

public static final byte SNC_PRIVACY

Flag for secure network communication, privacy protects each data packet

---

SNC_DEFAULT

public static final byte SNC_DEFAULT

Flag for secure network communication, uses built-in default settings

---

SNC_MAX

public static final byte SNC_MAX

Flag for secure network communication, uses maximal available securityMethod Detail

testCodepage

public static void testCodepage(java.lang.String?codepage)

Deprecated.?This method will be removed or modified in the next release.

?

Tests native codepage converter Internal use only.

---

testCodepage

public static void testCodepage(java.lang.String?codepage,                                int?mode)

Deprecated.?This method will be removed or modified in the next release.

?

Tests native codepage converter Internal use only.

---

getMiddlewareImplementation

public static final com.sap.mw.jco.IMiddleware getMiddlewareImplementation()

Returns the middleware implementation that is currently loaded
Note: This function is for internal use only. Do not use in application programs.Returns:the implementation of middleware layer currently used

---

getMiddlewareLayer

public static final java.lang.String getMiddlewareLayer()

Returns the name of the middleware layer that is currently loadedReturns:the name middleware layer currently used

---

setMiddlewareLayer

public static final void setMiddlewareLayer(java.lang.String?middleware_layer)

Sets the middleware layer to loadParameters:middleware_layer?- the middleware layer to load

---

getVersion

public static final java.lang.String getVersion()

Returns the version of the loaded middlewareReturns:the version of the loaded middleware

---

getPropertyInfo

public static final java.lang.String[][] getPropertyInfo()

Returns information about the properties which are understood by the JCO implementation. Each element of the array is a set of two?Strings?containg the name and description of a property, respectively.Returns:information about the properties which are understood by the implementation.

---

getProperties

public static final java.util.Properties getProperties()

Returns properties as set by this implementationReturns:properties as set by this implementation

---

getProperty

public static final java.lang.String getProperty(java.lang.String?key)

Returns the property for the specifid key or?null?if not foundParameters:key?- the property nameReturns:the property for the specifid key or?null?if not found

---

setProperty

public static final void setProperty(java.lang.String?key,                                     java.lang.String?value)

Sets the property for the given key. Defined properties are
property namedescriptionjco.jarmturns on jARM monitoring (allowed values are 1 or 0)jco.jdsrturns on jDSR monitoring (allowed values are 1 or 0)jco.jdsr.comp_namesets the component name in dsr contextParameters:key?- the property namevalue?- the value of the property

---

getMiddlewareVersion

public static final java.lang.String getMiddlewareVersion()

Returns the version of the loaded middlewareReturns:the version of the loaded middleware

---

getMiddlewareProperty

public static final java.lang.String getMiddlewareProperty(java.lang.String?key)

Returns the middleware property for the specifid key or?null?if not foundReturns:the middleware property for the specifid key

---

setMiddlewareProperty

public static final void setMiddlewareProperty(java.lang.String?key,                                               java.lang.String?value)

Sets a middleware property.Parameters:key?- the name of the propertyvalue?- the value of the property or?null?if the property should be removed

Depending on the type of middleware layer loaded, the properties that will be recognized may vary.
For?com.sap.mw.jco.rfc.MiddlewareRFC, i.e. the default RFC layer, the supported properties are:

?

jco.middleware.snc_libPath to the SNC libraryjco.middleware.wait_for_request_timeTime in seconds to wait incessantly for incoming requestsjco.middleware.max_startup_delayMaximum server startup delay time in secondsjco.middleware.allow_start_of_programsList of programs that are allowed to be started by the RFC library

?

---

getMiddlewarePropertyInfo

public static final java.lang.String[][] getMiddlewarePropertyInfo()

Returns information about the properties which are understood by the middleware implementation. Each element of the array is a set of two?Strings?containg the name and description of a property, respectively.Returns:information about the properties which are understood by the implementation.

---

getTraceLevel

public static int getTraceLevel()

Returns the trace levelReturns:the global trace level

---

setTraceLevel

public static void setTraceLevel(int?level)

Sets the trace levelParameters:level?- the global trace level. Pass?0?to switch the tracing off.

---

setTracePath

public static void setTracePath(java.lang.String?path)

Sets the path to write trace filesParameters:path?- to write the trace files. Pass?"."?to write the trace files in current folder.

---

addTraceListener

public static void addTraceListener(JCO.TraceListener?listener)

Adds a trace listener to the list of listenersParameters:listener?- the listener to addSee Also:removeTraceListener(com.sap.mw.jco.JCO.TraceListener)

---

removeTraceListener

public static void removeTraceListener(JCO.TraceListener?listener)

Removes a trace listener from the list of listenersParameters:listener?- the listener to removeSee Also:addTraceListener(com.sap.mw.jco.JCO.TraceListener)

---

fireTrace

public static void fireTrace(int?level,                             java.lang.String?message)

Issues a trace message.Parameters:level?- the trace levelmessage?- the trace message

---

addServerExceptionListener

public static void addServerExceptionListener(JCO.ServerExceptionListener?listener)

Adds an exception listener to the list of listeners.
If a listener is added as listener during firing of an event, it wont be notified about the last event.Parameters:listener?- the listener to addSee Also:removeServerExceptionListener(com.sap.mw.jco.JCO.ServerExceptionListener)

---

removeServerExceptionListener

public static void removeServerExceptionListener(JCO.ServerExceptionListener?listener)

Removes an exception listener from the list of listeners.
If a listener is removed from the list of listeners during firing of an event, it will be notified about the last event.Parameters:listener?- the listener to removeSee Also:addServerExceptionListener(com.sap.mw.jco.JCO.ServerExceptionListener)

---

addServerErrorListener

public static void addServerErrorListener(JCO.ServerErrorListener?listener)

Adds an error listener to the list of listeners.
If a listener is removed from the list of listeners during firing of an event, it will be notified about the last event.Parameters:listener?- the listener to addSee Also:removeServerErrorListener(com.sap.mw.jco.JCO.ServerErrorListener)

---

removeServerErrorListener

public static void removeServerErrorListener(JCO.ServerErrorListener?listener)

Removes an error listener from the list of listeners.
If a listener is removed from the list of listeners during firing of an event, it will be notified about the last event.Parameters:listener?- the listener to removeSee Also:addServerErrorListener(com.sap.mw.jco.JCO.ServerErrorListener)

---

addServerStateChangedListener

public static void addServerStateChangedListener(JCO.ServerStateChangedListener?listener)

Adds a state changed listener to the list of listeners.
If a listener is removed from the list of listeners during firing of an event, it will be notified about the last event.Parameters:listener?- the listener to addSee Also:removeServerStateChangedListener(com.sap.mw.jco.JCO.ServerStateChangedListener)

---

removeServerStateChangedListener

public static void removeServerStateChangedListener(JCO.ServerStateChangedListener?listener)

Removes a state changed listener from the list of listeners.
If a listener is removed from the list of listeners during firing of an event, it will be notified about the last event.Parameters:listener?- the listener to removeSee Also:addServerStateChangedListener(com.sap.mw.jco.JCO.ServerStateChangedListener)

---

createClient

public static JCO.Client createClient(java.util.Properties?properties)

Creates an instance of a client connection to a remote SAP system.Parameters:properties?- the connection parameters as a property list.Returns:the newly created client. Depending on the type of middleware layer loaded, the properties recognized by this method may vary.
For?com.sap.mw.jco.rfc.MiddlewareRFC, i.e. the default RFC layer, the supported properties are:

?

jco.client.clientSAP clientjco.client.userLogon userjco.client.alias_userAlias user namejco.client.passwdLogon passwordjco.client.langLogon languagejco.client.sysnrSAP system numberjco.client.ashostSAP application serverjco.client.mshostSAP message serverjco.client.gwhostGateway hostjco.client.gwservGateway servicejco.client.r3nameR/3 namejco.client.groupGroup of SAP application serversjco.client.tpnameProgram ID of external server programjco.client.tphostHost of external server programjco.client.typeType of remote host 2 = R/2, 3 = R/3, E = Externaljco.client.traceEnable/disable RFC trace (0 or 1)jco.client.codepageInitial codepage in SAP notationjco.client.abap_debugEnable ABAP debugging 0 or 1jco.client.use_sapguiUse remote SAP graphical user interface (0/1/2)jco.client.getsso2Get/Don't get a SSO ticket after logon (1 or 0)jco.client.mysapsso2Use the specified SAP Cookie Version 2 as logon ticketjco.client.x509certUse the specified X509 certificate as logon ticketjco.client.lcheckEnable/Disable logon check at open time, 1 (enable) or 0 (disable)jco.client.grt_dataAdditional data for GUIjco.client.use_guihostHost to which to redirect the remote GUIjco.client.use_guiservService to which to redirect of the remote GUIjco.client.use_guiprogidProgram ID of the server which starts the remote GUIjco.client.snc_modeSecure network connection (SNC) mode, 0 (off) or 1 (on)jco.client.snc_partnernameSNC partner, e.g. p:CN=R3, O=XYZ-INC, C=ENjco.client.snc_qopSNC level of security, 1 to 9jco.client.snc_mynameSNC name. Overrides default SNC partnerjco.client.snc_libPath to library which provides SNC servicejco.client.destR/2 destinationjco.client.saplogon_idString defined for SAPLOGON on 32-bit Windowsjco.client.extiddataData for external authentication (PAS)jco.client.extidtypeType of external authentication (PAS)jco.client.idle_timeoutIdle timeout (in seconds) for the connection after which it will be closed by R/3.?
Only positive values are allowed.jco.client.dsrEnable/Disable dsr support (0 or 1)

?

Note:?Depending on the SAP system release, logins using Single-Sign-On (SSO) or X509 certificates are being supported.
For SSO specify the user to be?$MYSAPSSO2$?and pass the base64 encoded ticket as as the?passwd?parameter.
For X509 specify the user to be?$X509CERT$?and pass the base64 encoded certificate as the?passwd?parameter. The logon with SSO or X.509 is based on SNC-encryption and can only be used in combination with a secure network connection.

---

createClient

public static JCO.Client createClient(java.lang.String[][]?params)

Creates an instance of a client to a remote SAP system using an array to specify the connection parameters. Each item in the array is a name/value pair where the first element is the name and the second is the value associated with the name, e.g.

     static String[][] login_params  = {        { "client" ,   "000"      },        { "user"   ,   "johndoe"  },        { "passwd" ,   "whoknows" },        { "lang"   ,   "EN"       },        ...     };        ...     JCO.Client = JCO.createClient(login_params); 

Note:?Depending on the SAP system release, logins using Single-Sign-On (SSO) or X509 certificates are being supported.
For SSO specify the user to be?$MYSAPSSO2$?and pass the base64 encoded ticket as as the?passwd?parameter.
For X509 specify the user to be?$X509CERT$?and pass the base64 encoded certificate as the?passwd?parameter. The logon with SSO or X.509 is based on SNC-encryption and can only be used in combination with a secure network connection.Parameters:params?- the connection parameters as an two-dimemsional array

---

createClient

public static JCO.Client createClient(java.lang.String?client,                                      java.lang.String?user,                                      java.lang.String?passwd,                                      java.lang.String?lang,                                      java.lang.String?ashost,                                      java.lang.String?sysnr)

Creates an instance of a client connection to a remote SAP system (no load balancing)

?

Parameters:client?- SAP logon clientuser?- SAP logon userpasswd?- SAP logon passwordlang?- SAP logon languageashost?- Host name of the application serversysnr?- SAP system numberReturns:the newly created client

---

createClient

public static JCO.Client createClient(java.lang.String?client,                                      java.lang.String?user,                                      java.lang.String?passwd,                                      java.lang.String?lang,                                      java.lang.String?ashost,                                      java.lang.String?sysnr,                                      java.lang.String?gwhost,                                      java.lang.String?gwserv)

Creates an instance of a client connection to a remote SAP system (no load balancing)Parameters:client?- SAP logon clientuser?- SAP logon userpasswd?- SAP logon passwordlang?- SAP logon languageashost?- Host name of the application serversysnr?- SAP system numbergwhost?- Host name of the SAP gatewaygwserv?- Service number of the SAP gatewayReturns:the newly created client

---

createClient

public static JCO.Client createClient(java.lang.String?client,                                      java.lang.String?user,                                      java.lang.String?passwd,                                      java.lang.String?lang,                                      java.lang.String?mshost,                                      java.lang.String?r3name,                                      java.lang.String?group)

Creates an instance of a client connection to a remote SAP system (with load balancing)Parameters:client?- SAP logon clientuser?- SAP logon userpasswd?- SAP logon passwordlang?- SAP logon languagemshost?- Host name of the message serverr3name?- Name of the SAP systemgroup?- Name of the group of application serversReturns:the newly created client

---

createClient

public static JCO.Client createClient(java.lang.String?client,                                      java.lang.String?user,                                      java.lang.String?passwd,                                      java.lang.String?lang,                                      java.lang.String?url)

Creates an instance of a client connection to a remote SAP system (with load balancing)Parameters:client?- SAP logon clientuser?- SAP logon userpasswd?- SAP logon passwordlang?- SAP logon languageurl?- the url to the remote hostReturns:the newly created client

---

createClient

public static JCO.Client createClient(java.lang.String?gwhost,                                      java.lang.String?gwserv,                                      java.lang.String?tpname)

Creates an instance of a client connection to a remote RFC server programParameters:gwhost?- Host name of the SAP gatewaygwserv?- Service number of the SAP gatewaytpname?- Program ID of an registered RFC server programReturns:the newly created client

---

createClient

public static JCO.Client createClient(java.lang.String?gwhost,                                      java.lang.String?gwserv,                                      java.lang.String?tpname,                                      java.lang.String?tphost)

Creates an instance of a client connection to a remote RFC server programParameters:gwhost?- Host name of the SAP gatewaygwserv?- Service number of the SAP gatewaytpname?- Program ID of an registered RFC server programtphost?- Host name where the external server runsReturns:the newly created client

---

getClientPoolManager

public static JCO.PoolManager getClientPoolManager()

Returns the pool managerReturns:the pool manager

---

addClientPool

public static void addClientPool(java.lang.String?key,                                 int?max_connections,                                 java.lang.String[][]?params)

Creates an instance of a client pool to a remote SAP system using an array to specify the connection parameters. Each item in the array is a name/value pair where the first element is the name and the second is the value associated with the name, e.g.

     static String[][] login_params  = {        { "client" ,   "000"      },        { "user"   ,   "johndoe"  },        { "passwd" ,   "whoknows" },        { "language" , "EN"       },        ...     };        ...     JCO.Client = JCO.getClient(MY_POOL); 

Parameters:key?- the name of the poolmax_connections?- max. number of connections allowed for the pool.
?Important:See also OSS notes 314530 and 316877 on how to setup the number of external connections in the SAP system and/or the SAP gateway.params?- the connection parameters as an two-dimensional array For a list of supported propertiesThrows:JCO.Exception?- thrown if a pool with the specified name already existsSee Also:createClient(Properties properties)

---

addClientPool

public static void addClientPool(java.lang.String?key,                                 int?max_connections,                                 java.util.Properties?properties)

Creates an instance of a client pool to a remote SAP systemParameters:key?- the name of the poolmax_connections?- max. number of connections allowed for the pool.
?Important:See also OSS notes 314530 and 316877 on how to setup the number of external connections in the SAP system and/or the SAP gateway.properties?- the connection parameters as a property listThrows:JCO.Exception?- thrown if a pool with the specified name already existsSee Also:createClient(Properties properties)

---

addClientPool

public static void addClientPool(java.lang.String?key,                                 int?max_connections,                                 java.lang.String?client,                                 java.lang.String?user,                                 java.lang.String?passwd,                                 java.lang.String?lang,                                 java.lang.String?ashost,                                 java.lang.String?sysnr)

Creates an instance of a client pool to a remote SAP system (no load balancing).
Note:?Depending on the SAP system release, logins using Single-Sign-On (SSO) or X509 certificates are being supported.
For SSO specify the user to be?$MYSAPSSO2$?and pass the base64 encoded ticket as as the?passwd?parameter.
For X509 specify the user to be?$X509CERT$?and pass the base64 encoded certificate as the?passwd?parameter.Parameters:key?- the name of the poolmax_connections?- max. number of connections allowed for the pool.
?Important:See also OSS notes 314530 and 316877 on how to setup the number of external connections in the SAP system and/or the SAP gateway.client?- SAP logon clientuser?- SAP logon userpasswd?- SAP logon passwordlang?- SAP logon languageashost?- Host name of the application serversysnr?- SAP system numberThrows:JCO.Exception?- thrown if a pool with the specified name already exists

---

addClientPool

public static void addClientPool(java.lang.String?key,                                 int?max_connections,                                 java.lang.String?client,                                 java.lang.String?user,                                 java.lang.String?passwd,                                 java.lang.String?lang,                                 java.lang.String?ashost,                                 java.lang.String?sysnr,                                 java.lang.String?gwhost,                                 java.lang.String?gwserv)

Creates an instance of a client pool to a remote SAP system (no load balancing).
Note:?Depending on the SAP system release, logins using Single-Sign-On (SSO) or X509 certificates are being supported.
For SSO specify the user to be?$MYSAPSSO2$?and pass the base64 encoded ticket as as the?passwd?parameter.
For X509 specify the user to be?$X509CERT$?and pass the base64 encoded certificate as the?passwd?parameter.Parameters:key?- the name of the poolmax_connections?- max. number of connections allowed for the pool.
?Important:See also OSS notes 314530 and 316877 on how to setup the number of external connections in the SAP system and/or the SAP gateway.client?- SAP logon clientuser?- SAP logon userpasswd?- SAP logon passwordlang?- SAP logon languageashost?- Host name of the application servergwhost?- Host name of the SAP gatewaygwserv?- Service number of the SAP gatewaysysnr?- SAP system numberThrows:JCO.Exception?- thrown if a pool with the specified name already exists

---

addClientPool

public static void addClientPool(java.lang.String?key,                                 int?max_connections,                                 java.lang.String?client,                                 java.lang.String?user,                                 java.lang.String?passwd,                                 java.lang.String?lang,                                 java.lang.String?mshost,                                 java.lang.String?r3name,                                 java.lang.String?group)

Creates an instance of a client pool to a remote SAP system (with load balancing).
Note:?Depending on the SAP system release, logins using Single-Sign-On (SSO) or X509 certificates are being supported.
For SSO specify the user to be?$MYSAPSSO2$?and pass the base64 encoded ticket as as the?passwd?parameter.
For X509 specify the user to be?$X509CERT$?and pass the base64 encoded certificate as the?passwd?parameter.Parameters:key?- the name of the poolmax_connections?- max. number of connections allowed for the pool.
?Important:See also OSS notes 314530 and 316877 on how to setup the number of external connections in the SAP system and/or the SAP gateway.client?- SAP logon clientuser?- SAP logon userpasswd?- SAP logon passwordlang?- SAP logon languagemshost?- Host name of the message serverr3name?- Name of the SAP systemgroup?- Name of the group of application serversThrows:JCO.Exception?- thrown if a pool with the specified name already exists

---

addClientPool

public static void addClientPool(java.lang.String?key,                                 int?max_connections,                                 java.lang.String?gwhost,                                 java.lang.String?gwserv,                                 java.lang.String?tpname)

Creates an instance of a client pool to a remote JCO server programParameters:key?- the name of the poolmax_connections?- max. number of connections allowed for the pool.
?Important:See also OSS notes 314530 and 316877 on how to setup the number of external connections in the SAP system and/or the SAP gateway.gwhost?- Host name of the SAP gatewaygwserv?- Service number of the SAP gatewaytpname?- Program ID of an registered JCO server programThrows:JCO.Exception?- thrown if a pool with the specified name already exists

---

addClientPool

public static void addClientPool(java.lang.String?key,                                 int?max_connections,                                 java.lang.String?gwhost,                                 java.lang.String?gwserv,                                 java.lang.String?tpname,                                 java.lang.String?tphost)

Creates an instance of a client pool to a remote JCO server program.Parameters:key?- the name of the poolmax_connections?- max. number of connections allowed for the pool.
?Important:See also OSS notes 314530 and 316877 on how to setup the number of external connections in the SAP system and/or the SAP gateway.gwhost?- Host name of the SAP gatewaygwserv?- Service number of the SAP gatewaytpname?- Program ID of an registered JCO server programtphost?- Host name where the external server runsThrows:JCO.Exception?- thrown if a pool with the specified name already exists

---

removeClientPool

public static void removeClientPool(java.lang.String?key)

Delete a client pool from the pool list.
Note:?The routine will close all open connections of the specified pool forcefully, before the pool is being removed.Parameters:key?- the name of the pool

---

getClient

public static JCO.Client getClient(java.lang.String?key)

Returns a client connection from the specified pool.
If no clients are available in pool, pool will wait max?max_wait_time?ms until an other thread releases a client. If no clients are released during the waiting and a client could not be allocated, a pool throws JCO.Exception with the error group set to?JCO.Exception.JCO_ERROR_RESOURCE.Parameters:key?- the name of the pool from which to take the connection fromReturns:a client connection from the specified pool or?nullThrows:JCO.Exception?- with the error group set to?JCO.Exception.JCO_ERROR_RESOURCE, if a client could not be allocated, i.e. the client pool is exhaustedJCO.Exception?- thrown if a client connection could not be established due to wrong logon data, network problems, etc.See Also:JCO.PoolManager.setMaxWaitTime(long),?Note:?Any client obtained by this method?must?be released with?JCO.releaseClient(),?releaseClient(com.sap.mw.jco.JCO.Client)

---

getClient

public static JCO.Client getClient(java.lang.String?key,                                   boolean?reset)

Returns a client connection from the specified pool.
Note:?Any client obtained by this method?must?be released with?JCO.releaseClient()Parameters:key?- the name of the pool from which to take the connection fromreset?- if?true?reset the connection, e.g. free all resources that might have been allocated on either the server side or by the local middleware library. On systems below SAP system 4.0A resetting a connection effectively means closing and subsequently reopening the connection which is a very expensive process. However, several scenarios (e.g. BAPIs) might need such reinitialized connections.
JCO.releaseClient(Client client)?will reset the connection automatically.Returns:a client connection from the specified pool or?nullThrows:JCO.Exception?- with the error group set to?JCO.Exception.JCO_ERROR_RESOURCE, if a client could not be allocated, i.e. the client pool is exhaustedJCO.Exception?- thrown if a client connection could not be established due to wrong logon data, network problems, etc.See Also:releaseClient(com.sap.mw.jco.JCO.Client)

---

releaseClient

public static void releaseClient(JCO.Client?client)

Releases a client connection to its pool.
It is neccessary to release all client connections that are obtained with?JCO.getClient(). Otherwise the pool will run out of connections at some time. As a result a?JCO.Exception?of the groupJCO_ERROR_RESOURCE?will be thrown by the?JCO.getClient()?method.?
The pool checks the client and decides to put it back to the cache or to remove it.?
Note:?After releasing a?JCO.Client?instance with this method you have to clear all references to it. Otherwise there will be a?JCO.Exception?thrown if it used once again.?
On SAP systems equal or above 4.0A the method resets the connection, i.e. frees all resources and context allocated on the server side (i.e. '/n' in SAP system) or by the local middleware layer.Parameters:client?- the client to be released to the poolThrows:JCO.Exception?- thrown if a connection could not be released cleanlySee Also:getClient(java.lang.String),?JCO.Pool.setResetOnRelease(boolean)

---

createParameterList

public static JCO.ParameterList createParameterList()

Returns a newly created parameter listReturns:an empty parameter list

---

createParameterList

public static JCO.ParameterList createParameterList(IMetaData?meta_data)

Returns a newly created and preconfigured parameter list as specified by the meta dataReturns:a preconfigured parameter list

---

createStructure

public static JCO.Structure createStructure(java.lang.String?name)

Creates a empty structureParameters:name?- the name of the structure

---

createStructure

public static JCO.Structure createStructure(IMetaData?meta_data)

Creates a new structure with data fields as described by the specified meta dataParameters:meta_data?- the meta data which describe the layout of the structure

---

createTable

public static JCO.Table createTable(java.lang.String?name)

Creates a new tableParameters:name?- the name of the table

---

createTable

public static JCO.Table createTable(IMetaData?meta_data)

Creates a new table with a column layout as described by the specified meta dataParameters:meta_data?- the meta data which describe the columns of the table

---

createFunction

public static JCO.Function createFunction(java.lang.String?name,                                          JCO.ParameterList?input,                                          JCO.ParameterList?output,                                          JCO.ParameterList?tables)

Creates a new JCO FunctionParameters:name?- the name of the functioninput?- the list of import parametersoutput?- the list of export parameterstables?- the list of table parametersReturns:the newly created function

---

createRepository

public static IRepository createRepository(java.lang.String?name,                                           java.lang.String?pool_name)

Creates a new repositoryParameters:name?- the name of the new repositorypool_name?- the name of the client pool which the repository uses to dynamically query the remote SAP system dictonary.

---

createRepository

public static IRepository createRepository(java.lang.String?name,                                           java.lang.String[]?pool_names)

Creates a new repositoryParameters:name?- the name of the new repositorypool_names?- the names of the client pools which the repository uses to dynamically query the remote SAP system dictonary.

---

createRepository

public static IRepository createRepository(java.lang.String?name,                                           JCO.Client?client)

Creates a new repositoryParameters:name?- the name of the new repositoryclient?- the client used to dynamically access the SAP system dictonary

---

?Class?Use?Tree?Deprecated?Index?Help???PREV CLASS? ?NEXT CLASSFRAMES?? ?NO FRAMESSUMMARY: ?INNER?|?FIELD?|?CONSTR?|?METHODDETAIL: ?FIELD?|?CONSTR?|?METHOD

---