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 communication partner, and other useful data.


Method Summary
 java.lang.String getClient()
          Retrieves the SAP client from the connection attributes.
 java.lang.String getCPICConversationID()
          Retrieves the low-level CPIC conversation ID from the connection attributes.
 java.lang.String getDestination()
          Retrieves the destination name from the connection attributes.
 java.lang.String getHost()
          Retrieves the host from the connection attributes.
 java.lang.String getISOLanguage()
          Retrieves the logon language from the connection attributes and returns it as a two-character string.
 java.lang.String getKernelRelease()
          Retrieves the release of the remote SAP system's kernel.
 java.lang.String getLanguage()
          Retrieves the logon language from the connection attributes and returns it as a one-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 from the connection attributes.
 java.lang.String getPartnerRelease()
          Retrieves the release of the remote SAP system.
 int getPartnerReleaseNumber()
          Returns the release number of the partner system as an integer.
 char getPartnerType()
          Retrieves the type which specifies the partner of the communication.
 java.lang.String getRelease()
          Retrieves the release of the local SAP system.
 char getRfcRole()
          Retrieves the RFC role from the connection attributes.
 java.lang.String getSSOTicket()
          Retrieves the SSO ticket from the connection attributes.
 java.lang.String getSystemID()
          Retrieves the SAP system ID from the connection attributes.
 java.lang.String getSystemNumber()
          Retrieves the SAP system number from the connection attributes.
 boolean getTrace()
          Retrieves the RFC trace flag from the connection attributes.
 char getType()
          Retrieves the type which specifies the local system.
 java.lang.String getUser()
          Retrieves the user ID from the connection attributes.
 

Method Detail

getDestination

java.lang.String getDestination()
Retrieves the destination name from the connection attributes.

Returns:
the destination name

getHost

java.lang.String getHost()
Retrieves the host from the connection attributes.

Returns:
the local host name

getPartnerHost

java.lang.String getPartnerHost()
Retrieves the partner host from the connection attributes.

Note: For load balanced destinations the partner host will only be available, if the corresponding destination is currently in a stateful context and a connection has been established.

Returns:
the remote partner host name

getSystemID

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

Returns:
the SAP system ID

getSystemNumber

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

Note: For load balanced destinations the system number will only be available, if the corresponding destination is currently in a stateful context and a connection has been established.

Returns:
the SAP system number

getClient

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

Returns:
the SAP client

getUser

java.lang.String getUser()
Retrieves the user ID from the connection attributes.

Returns:
the SAP user ID

getLanguage

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

Returns:
the 1-char logon language (e.g. "E", "D", etc.)

getISOLanguage

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

Returns:
the 2-char ISO logon language (e.g. "EN", "DE", etc.)

getOwnCodepage

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

Returns:
the local SAP codepage (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 host (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 host (e.g. ISO-8859-1, etc.)

getOwnBytesPerChar

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

Returns:
the number of bytes per character for the local codepage
Since:
JCo 3.0.2

getPartnerCodepage

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

Returns:
the remote SAP codepage (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 number of bytes per character for the remote codepage
Since:
JCo 3.0.2

getRelease

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

Returns:
the local SAP system release

getPartnerRelease

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

Returns:
the remote SAP system release

getKernelRelease

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

Returns:
the remote SAP 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:
the remote partner type

getTrace

boolean getTrace()
Retrieves the RFC trace flag from the connection attributes.

Returns:
true if the RFC trace is enabled; false otherwise

getRfcRole

char getRfcRole()
Retrieves the RFC role from the connection attributes.

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 system.

Valid local system types are:

ValueDescription
'3' ABAP system
'E' External program
'R' Registered external program

Returns:
the local system type

getCPICConversationID

java.lang.String getCPICConversationID()
Retrieves the low-level CPIC conversation ID from the connection attributes.

Note: The CPIC conversation ID will only be available, if the corresponding destination is currently in a stateful context and a connection has been established.

Returns:
the CPIC conversation ID

getSSOTicket

java.lang.String getSSOTicket()
Retrieves the SSO ticket from the connection attributes.

Returns:
the SSO ticket or null if not set

getPartnerReleaseNumber

int getPartnerReleaseNumber()
Returns the release number of the partner system as an integer.

For example:

NumberDescription
0 unknown
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
620AS ABAP 6.20
640AS ABAP 6.40
700AS ABAP 7.00
702AS ABAP 7.02
711AS ABAP 7.11
720AS ABAP 7.20
740AS ABAP 7.40
750AS ABAP 7.50

Returns:
the partner release number as an integer


Copyright © 2008-2016 SAP SE. All Rights Reserved.