com.sap.mw.jco
Class JCO.Attributes

java.lang.Object
  |
  +--com.sap.mw.jco.JCO.Attributes
Enclosing class:
JCO

public static class JCO.Attributes
extends java.lang.Object

Attributes is a class which holds a number of attributes of a connection, such as codepage information, system information of the partner, etc.


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. the name of the local host
 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. the name of the remote host.
 java.lang.String getPartnerRelease()
          Retrieves the release of the remote SAP system
 char getPartnerType()
          Retrieves the type which specifies the partner of the communication. Valid partner types are: ValueDescription '2' R/2 '3' R/3 'E' External Program 'R' Registered external program 'F' Shared memory pipe
 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. Valid local system types are: ValueDescription '2' R/2 '3' R/3 'E' External Program 'R' Registered external program 'F' Shared memory pipe
 java.lang.String getUser()
          Retrieves the user ID field from the connection attributes, the name of the user the connection is associated with.
 java.lang.String toString()
          Converts the attributes into a string list
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getDestination

public final java.lang.String getDestination()
Retrieves the dest field of the connection attributes
Returns:
the destination as a string

getHost

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

getPartnerHost

public final 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

public final java.lang.String getSystemID()
Retrieves the SAP system ID from the attributes
Returns:
SAP SAP system ID

getSystemNumber

public final java.lang.String getSystemNumber()
Retrieves the SAP system number from the attributes
Returns:
SAP system number

getClient

public final java.lang.String getClient()
Retrieves the SAP client field from the attributes
Returns:
the SAP client

getUser

public final 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

public final 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

public final 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

public final java.lang.String getOwnCodepage()
Retrieves the local codepage in SAP notation.
Returns:
the local SAP code page (e.g. 1100, 8400, etc.)

getOwnCharset

public final 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

public final 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. ISO8856-1)

getOwnBytesPerChar

public final 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

getPartnerCodepage

public final 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

public final 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

public final 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. ISO8856-1)

getPartnerBytesPerChar

public final 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

getRelease

public final java.lang.String getRelease()
Retrieves the release of the local SAP system or transport library
Returns:
Local SAP system release

getPartnerRelease

public final java.lang.String getPartnerRelease()
Retrieves the release of the remote SAP system
Returns:
Remote SAP system release

getKernelRelease

public final java.lang.String getKernelRelease()
Retrieves the release of the remote SAP system's kernel
Returns:
Remote system kernel release

getPartnerType

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

Valid partner types are:
ValueDescription
'2' R/2
'3' R/3
'E' External Program
'R' Registered external program
'F' Shared memory pipe

Returns:
Remote partner type

getTrace

public final boolean getTrace()
Retrieves the trace field of the attributes
Returns:
true if trace is enabled, false otherwise

getRfcRole

public final 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

public final 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

public final java.lang.String getCPICConversationID()
Retrieves the low-level CPIC conversion ID for a connection
Returns:
CPIC Conversion ID

getSSOTicket

public final java.lang.String getSSOTicket()
Retrieves the sso_ticket field
Returns:
the sso_ticket or null if not set

toString

public final java.lang.String toString()
Converts the attributes into a string list
Overrides:
toString in class java.lang.Object
Returns:
a printable string representation of the attributes