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 Object

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

Field Summary

protected String	client
protected String	CPIC_convid
protected String	dest
protected String	ISO_language
protected String	kernel_rel
protected String	language
protected byte	own_bytes_per_char
protected String	own_charset
protected String	own_codepage
protected String	own_encoding
protected String	own_host
protected String	own_rel
protected char	own_type
protected byte	partner_bytes_per_char
protected String	partner_charset
protected String	partner_codepage
protected String	partner_encoding
protected String	partner_host
protected String	partner_rel
protected int	partner_rel_number
protected char	partner_type
protected char	rfc_role
protected String	sso_ticket
protected String	sysid
protected String	systnr
protected char	trace
protected String	user

Constructor Summary

protected

JCO.Attributes() This class is never instantiated directly

Method Summary

String	getClient() Retrieves the SAP client field from the attributes
String	getCPICConversationID() Retrieves the low-level CPIC conversion ID for a connection
String	getDestination() Retrieves the dest field of the connection attributes
String	getHost() Retrieves host field of the attributes, i.e. the name of the local host
String	getISOLanguage() Retrieves the logon language field of the connection attributes and returns it as a two-byte character string.
String	getKernelRelease() Retrieves the release of the remote SAP system's kernel
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.
String	getOwnCharset() Retrieves the Java charset equivalent of the local SAP codepage.
String	getOwnCodepage() Retrieves the local codepage in SAP notation.
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.
String	getPartnerCharset() Retrieves the Java charset equivalent of the codepage used by the remote system.
String	getPartnerCodepage() Retrieves the codepage used by the remote system in SAP notation.
String	getPartnerEncoding() Retrieves the MIME encoding equivalent of the remote SAP codepage.
String	getPartnerHost() Retrieves the partner host field of the attributes, i.e. the name of the remote host.
String	getPartnerRelease() Retrieves the release of the remote SAP system
protected 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.
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.
String	getSSOTicket() Retrieves the sso_ticket field
String	getSystemID() Retrieves the SAP system ID from the attributes
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.
String	getUser() Retrieves the user ID field from the connection attributes, the name of the user the connection is associated with.
String	toString() Converts the attributes into a string list

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

dest

protected String dest

own_host

protected String own_host

partner_host

protected String partner_host

systnr

protected String systnr

sysid

protected String sysid

client

protected String client

user

protected String user

language

protected String language

ISO_language

protected String ISO_language

own_codepage

protected String own_codepage

partner_codepage

protected String partner_codepage

own_charset

protected String own_charset

partner_charset

protected String partner_charset

own_encoding

protected String own_encoding

partner_encoding

protected String partner_encoding

own_bytes_per_char

protected byte own_bytes_per_char

partner_bytes_per_char

protected byte partner_bytes_per_char

own_rel

protected String own_rel

partner_rel

protected String partner_rel

kernel_rel

protected String kernel_rel

partner_type

protected char partner_type

trace

protected char trace

rfc_role

protected char rfc_role

own_type

protected char own_type

CPIC_convid

protected String CPIC_convid

sso_ticket

protected String sso_ticket

partner_rel_number

protected int partner_rel_number

Constructor Detail

JCO.Attributes

protected JCO.Attributes()

This class is never instantiated directly

Method Detail

getDestination

public final String getDestination()

Retrieves the dest field of the connection attributes

Returns:

the destination as a string

getHost

public final String getHost()

Retrieves host field of the attributes, i.e. the name of the local host

Returns:

local host name

getPartnerHost

public final 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 String getSystemID()

Retrieves the SAP system ID from the attributes

Returns:

SAP SAP system ID

getSystemNumber

public final String getSystemNumber()

Retrieves the SAP system number from the attributes

Returns:

SAP system number

getClient

public final String getClient()

Retrieves the SAP client field from the attributes

Returns:

the SAP client

getUser

public final 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 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 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 String getOwnCodepage()

Retrieves the local codepage in SAP notation.

Returns:

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

getOwnCharset

public final 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 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 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 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 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 String getRelease()

Retrieves the release of the local SAP system or transport library

Returns:

Local SAP system release

getPartnerRelease

public final String getPartnerRelease()

Retrieves the release of the remote SAP system

Returns:

Remote SAP system release

getKernelRelease

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

Value	Description
'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:

Value	Description
'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:

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

Returns:

Local system type

getCPICConversationID

public final String getCPICConversationID()

Retrieves the low-level CPIC conversion ID for a connection

Returns:

CPIC Conversion ID

getSSOTicket

public final String getSSOTicket()

Retrieves the sso_ticket field

Returns:

the sso_ticket or null if not set

getPartnerReleaseNumber

protected final int getPartnerReleaseNumber()

Returns the release number of the partner as an integer, e.g.

Number	Description
0	unknown
200	R/2
317	R/3 3.1H
400	R/3 4.0A
401	R/3 4.0B
450	R/3 4.5A
451	R/3 4.5B
461	R/3 4.6B
462	R/3 4.6C
610	R/3 6.10
620	R/3 6.20

Returns:

the release number as an integer

toString

public final String toString()

Converts the attributes into a string list

Returns:

a printable string representation of the attributes