com.sap.conn.jco
Interface JCoAttributes

All Superinterfaces:
java.io.Serializable

public interface JCoAttributes
extends java.io.Serializable

Encapsulates a number of attributes of a connection, such as codepage information, system information of the partner, and other useful data.


Method Summary
 java.lang.String getClient()
          Retrieves the SAP client field from the attributes
 java.lang.String getCPICConversationID()
          Retrieves the low-level CPIC conversion ID for a connection
 java.lang.String getDestination()
          Retrieves the dest field of the connection attributes
 java.lang.String getHost()
          Retrieves host field of the attributes, i.e.
 java.lang.String getISOLanguage()
          Retrieves the logon language field of the connection attributes and returns it as a two-byte character string.
 java.lang.String getKernelRelease()
          Retrieves the release of the remote SAP system's kernel
 java.lang.String getLanguage()
          Retrieves the logon language field of the connection attributes and returns it as a one-byte character string.
 int getOwnBytesPerChar()
          Returns the number of bytes per character for the currently used local codepage.
 java.lang.String getOwnCharset()
          Retrieves the Java charset equivalent of the local SAP codepage.
 java.lang.String getOwnCodepage()
          Retrieves the local codepage in SAP notation.
 java.lang.String getOwnEncoding()
          Retrieves the MIME encoding equivalent of the local SAP codepage.
 int getPartnerBytesPerChar()
          Returns the number of bytes per character for the currently used remote codepage.
 java.lang.String getPartnerCharset()
          Retrieves the Java charset equivalent of the codepage used by the remote system.
 java.lang.String getPartnerCodepage()
          Retrieves the codepage used by the remote system in SAP notation.
 java.lang.String getPartnerEncoding()
          Retrieves the MIME encoding equivalent of the remote SAP codepage.
 java.lang.String getPartnerHost()
          Retrieves the partner host field of the attributes, i.e.
 java.lang.String getPartnerRelease()
          Retrieves the release of the remote SAP system
 int getPartnerReleaseNumber()
          Returns the release number of the partner as an integer, e.g.
 char getPartnerType()
          Retrieves the type which specifies the partner of the communication.
 java.lang.String getRelease()
          Retrieves the release of the local SAP system or transport library
 char getRfcRole()
          Retrieves the rfc_role field which describes the role of the connection.
 java.lang.String getSSOTicket()
          Retrieves the sso_ticket field
 java.lang.String getSystemID()
          Retrieves the SAP system ID from the attributes
 java.lang.String getSystemNumber()
          Retrieves the SAP system number from the attributes
 boolean getTrace()
          Retrieves the trace field of the attributes
 char getType()
          Retrieves the type which specifies the local program.
 java.lang.String getUser()
          Retrieves the user ID field from the connection attributes, the name of the user the connection is associated with.
 

Method Detail

getDestination

java.lang.String getDestination()
Retrieves the dest field of the connection attributes

Returns:
the destination as a string

getHost

java.lang.String getHost()
Retrieves host field of the attributes, i.e. the name of the local host

Returns:
local host name

getPartnerHost

java.lang.String getPartnerHost()
Retrieves the partner host field of the attributes, i.e. the name of the remote host.

Returns:
the remote host name

getSystemID

java.lang.String getSystemID()
Retrieves the SAP system ID from the attributes

Returns:
SAP SAP system ID

getSystemNumber

java.lang.String getSystemNumber()
Retrieves the SAP system number from the attributes

Returns:
SAP system number

getClient

java.lang.String getClient()
Retrieves the SAP client field from the attributes

Returns:
the SAP client

getUser

java.lang.String getUser()
Retrieves the user ID field from the connection attributes, the name of the user the connection is associated with.

Returns:
SAP user ID

getLanguage

java.lang.String getLanguage()
Retrieves the logon language field of the connection attributes and returns it as a one-byte character string.

Returns:
Single character logon language, e.g. "E","D".

getISOLanguage

java.lang.String getISOLanguage()
Retrieves the logon language field of the connection attributes and returns it as a two-byte character string.

Returns:
2-byte ISO language, e.g. "EN", "DE".

getOwnCodepage

java.lang.String getOwnCodepage()
Retrieves the local codepage in SAP notation.

Returns:
the local SAP code page (e.g. 1100, 8400, etc.)

getOwnCharset

java.lang.String getOwnCharset()
Retrieves the Java charset equivalent of the local SAP codepage.

Returns:
the charset used by the local machine (e.g. ISO8859_1, KSC5601, etc.)

getOwnEncoding

java.lang.String getOwnEncoding()
Retrieves the MIME encoding equivalent of the local SAP codepage.

Returns:
the MIME encoding used by the local machine (e.g. ISO-8856-1)

getOwnBytesPerChar

int getOwnBytesPerChar()
Returns the number of bytes per character for the currently used local codepage.

Returns:
the no. of bytes per character of the current codepage
Since:
JCo 3.0.2, 7.20

getPartnerCodepage

java.lang.String getPartnerCodepage()
Retrieves the codepage used by the remote system in SAP notation.

Returns:
the remote SAP code page (e.g. 1100, 8400, etc.)

getPartnerCharset

java.lang.String getPartnerCharset()
Retrieves the Java charset equivalent of the codepage used by the remote system.

Returns:
the charset used by the remote host (e.g. ISO8859_1, KSC5601, etc.)

getPartnerEncoding

java.lang.String getPartnerEncoding()
Retrieves the MIME encoding equivalent of the remote SAP codepage.

Returns:
the MIME encoding used by the remote host (e.g. ISO-8856-1)

getPartnerBytesPerChar

int getPartnerBytesPerChar()
Returns the number of bytes per character for the currently used remote codepage.

Returns:
the no. of bytes per character of the remote codepage
Since:
JCo 3.0.2, 7.20

getRelease

java.lang.String getRelease()
Retrieves the release of the local SAP system or transport library

Returns:
Local SAP system release

getPartnerRelease

java.lang.String getPartnerRelease()
Retrieves the release of the remote SAP system

Returns:
Remote SAP system release

getKernelRelease

java.lang.String getKernelRelease()
Retrieves the release of the remote SAP system's kernel

Returns:
Remote system kernel release

getPartnerType

char getPartnerType()
Retrieves the type which specifies the partner of the communication.

Valid partner types are:

ValueDescription
'3' ABAP System
'E' External Program
'R' Registered external program

Returns:
Remote partner type

getTrace

boolean getTrace()
Retrieves the trace field of the attributes

Returns:
true if trace is enabled, false otherwise

getRfcRole

char getRfcRole()
Retrieves the rfc_role field which describes the role of the connection. Valid role values are:

ValueDescription
'C'RFC Client
'S'RFC Server

Returns:
"C" if in client mode or "S" if in server mode

getType

char getType()
Retrieves the type which specifies the local program.

Valid local system types are:

ValueDescription
'2' R/2
'3' R/3
'E' External Program
'R' Registered external program
'F' Shared memory pipe

Returns:
Local system type

getCPICConversationID

java.lang.String getCPICConversationID()
Retrieves the low-level CPIC conversion ID for a connection

Returns:
CPIC Conversion ID

getSSOTicket

java.lang.String getSSOTicket()
Retrieves the sso_ticket field

Returns:
the sso_ticket or null if not set

getPartnerReleaseNumber

int getPartnerReleaseNumber()
Returns the release number of the partner as an integer, e.g.
NumberDescription
0 unknown
200R/2
317R/3 3.1H
400R/3 4.0A
401R/3 4.0B
450R/3 4.5A
451R/3 4.5B
461R/3 4.6B
462R/3 4.6C
610R/3 6.10
620R/3 6.20

Returns:
the release number as an integer


Copyright © 2008-2014 SAP AG. All Rights Reserved.