SAP ABAP Class CL_XMS_MSG_TRANSFER_HANDLER (Responsible for Actual Data Transport)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-XI-IS-IEN (Application Component) Integration Engine
⤷
SXMSUPGRADE (Package) XI: Upgrade
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-XI-IS-IEN (Application Component) Integration Engine⤷
SXMSUPGRADE (Package) XI: UpgradeProperties
| Class | CL_XMS_MSG_TRANSFER_HANDLER | |
| Short Description | Responsible for Actual Data Transport | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SXMSUPGRADE | XI: Upgrade |
| Created | 20041112 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_XMS_MSG_TRANSFER_HANDLER has no forward declaration.
Interfaces
Class CL_XMS_MSG_TRANSFER_HANDLER has no interface implemented.
Friends
Class CL_XMS_MSG_TRANSFER_HANDLER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CO_FIX_SIZE_IN_BYTES |
Constant | Private | Type reference (TYPE) | INT4 | '1024' | Natural Number | 20041201 | |
| 2 | ERR_MSG_LIST |
Instance attribute | Public | Type reference (TYPE) | SXMSMSG_STATE_T | Status Information of Messages | 20041125 | ||
| 3 | LOCATION |
Instance attribute | Private | Type reference (TYPE) | CHAR10 | Character Field Length = 10 | 20041118 | ||
| 4 | MSG_CONTENT_LIST |
Instance attribute | Private | Type reference (TYPE) | SXMSMSG_MAST_T | Table: Master, Version, and Resource Info for a Message | 20041119 | ||
| 5 | MSG_LIST |
Instance attribute | Public | Type reference (TYPE) | SXMSMSG_LIST_T | Table of Logical Persisted Messages | 20041123 | ||
| 6 | PMAST |
Instance attribute | Private | Type reference (TYPE) | SXMSPMAST | Integration Engine: Message Queue (Master) | 20041112 | ||
| 7 | PVERS |
Instance attribute | Private | Type reference (TYPE) | SXMSPVERS | Integration Engine: Message Version | 20041112 | ||
| 8 | RFC_DEST |
Static Attribute | Private | Type reference (TYPE) | RFCDEST | Logical Destination (Specified in Function Call) | 20050110 | ||
| 9 | R_GROUP_TYPE_CLASS |
Instance attribute | Public | Object reference (TYPE REF TO) | OBJECT | Class from Configuration Table | 20050131 | ||
| 10 | TNS |
Instance attribute | Private | Type reference (TYPE) | SXMSTNS | Namespace Context | 20041112 | ||
| 11 | TPROP |
Instance attribute | Private | Type reference (TYPE) | SXMSTPROP | Message Properties | 20041112 | ||
| 12 | TRES |
Instance attribute | Private | Type reference (TYPE) | SXMSTRES | Message Resources | 20041112 | ||
| 13 | TXRES |
Instance attribute | Private | Type reference (TYPE) | SXMSTXRES | Message X Resources | 20041112 | ||
| 14 | WA_MSG_CONTENT_LIST |
Instance attribute | Private | Type reference (TYPE) | SXMSMSG_MAST_S | Master, Version, and Resource Information of a Message | 20041201 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CALCULATE_MESSAGE_SIZE |
Instance method | Public | Method | Calculation of Message Size in Megabytes | 20041116 |
| 2 | CONSTRUCTOR |
Instance method | Public | Constructor | CONSTRUCTOR | 20041112 |
| 3 | DETERMINE_RFC_DEST |
Instance method | Private | Method | Determine RFC Destination | 20041217 |
| 4 | FILL_MESSAGE_ATTRIBUTES |
Instance method | Public | Method | Sets the message attributes of the class | 20041117 |
| 5 | GET_LOCATION |
Instance method | Public | Method | Returns the location (old or new system) of object | 20041118 |
| 6 | GET_MAX_MESSAGE_TRANSFER_SIZE |
Instance method | Public | Method | Read Maximum Message Package Size for Transfer | 20041117 |
| 7 | GET_MESSAGES_FROM_SOURCE |
Instance method | Public | Method | Read Message Payloads from Source System | 20041112 |
| 8 | PREPARE_MSG_LIST |
Instance method | Public | Method | Set Attribute: MSG_LIST | 20050114 |
| 9 | WRITE_DATA_TO_DB |
Instance method | Public | Method | Save Message Payloads in Database | 20041112 |
Events
Class CL_XMS_MSG_TRANSFER_HANDLER has no event.
Types
Class CL_XMS_MSG_TRANSFER_HANDLER has no local type.
Method Signatures
Method CALCULATE_MESSAGE_SIZE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
RE_SIZE_IN_BYTES | Value transfer | Type reference (TYPE) | FLOAT | Natürliche Zahl | 20041116 |
Method CALCULATE_MESSAGE_SIZE on class CL_XMS_MSG_TRANSFER_HANDLER has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IM_LOCATION | Call by reference | Type reference (TYPE) | CHAR10 | Characterfeld der Länge 10 | 20041118 |
Method CONSTRUCTOR on class CL_XMS_MSG_TRANSFER_HANDLER has no exception.
Method DETERMINE_RFC_DEST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
IS_RFC_DEST | Value transfer | Type reference (TYPE) | SXMSVALUE | Wert | 20041217 |
Method DETERMINE_RFC_DEST on class CL_XMS_MSG_TRANSFER_HANDLER has no exception.
Method FILL_MESSAGE_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_PMAST | Call by reference | Type reference (TYPE) | SXMSPMAST | XML Message Broker: Message-Queue (Master) | 20041117 | ||
| 2 | Importing |
IM_PVERS | Call by reference | Type reference (TYPE) | SXMSPVERS | XML Message Broker: Message-Version | 20041117 | ||
| 3 | Importing |
IM_TNS | Call by reference | Type reference (TYPE) | SXMSTNS | Namespace Context | 20041117 | ||
| 4 | Importing |
IM_TPROP | Call by reference | Type reference (TYPE) | SXMSTPROP | Message Properties | 20041117 | ||
| 5 | Importing |
IM_TRES | Call by reference | Type reference (TYPE) | SXMSTRES | Message Ressourcen | 20041117 | ||
| 6 | Importing |
IM_TXRES | Call by reference | Type reference (TYPE) | SXMSTXRES | Message X-Ressourcen | 20041117 |
Method FILL_MESSAGE_ATTRIBUTES on class CL_XMS_MSG_TRANSFER_HANDLER has no exception.
Method GET_LOCATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RE_LOCATION | Value transfer | Type reference (TYPE) | CHAR10 | Characterfeld der Länge 10 | 20041118 |
Method GET_LOCATION on class CL_XMS_MSG_TRANSFER_HANDLER has no exception.
Method GET_MAX_MESSAGE_TRANSFER_SIZE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RE_MAX_MSG_TRANSFER_SIZE | Value transfer | Type reference (TYPE) | INT4 | Natürliche Zahl | 20041117 |
Method GET_MAX_MESSAGE_TRANSFER_SIZE on class CL_XMS_MSG_TRANSFER_HANDLER has no exception.
Method GET_MESSAGES_FROM_SOURCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_GROUP_GUID | Call by reference | Type reference (TYPE) | SXMSGROUP_GUID | generierte Group Guid für Message Transfer | 20050105 | ||
| 2 | Importing |
IM_MSG_LIST | Call by reference | Type reference (TYPE) | SXMSMSG_LIST_T | XI: Message-Id | 20041118 | ||
| 3 | Returning |
RE_ERROR_OCCURED | Value transfer | Type reference (TYPE) | SXMSFLAG | XMS: Flag (true/false) | 20041115 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_XMS_MSG_TRANSFER |
Ausnahmeklasse für Message Transfer | 20050105 |
Method PREPARE_MSG_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_GROUP_GUID | Call by reference | Type reference (TYPE) | SXMSGROUP_GUID | generierte Group Guid für Message Transfer | 20050114 |
Method PREPARE_MSG_LIST on class CL_XMS_MSG_TRANSFER_HANDLER has no exception.
Method WRITE_DATA_TO_DB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_GROUP_GUID | Call by reference | Type reference (TYPE) | SXMSGROUP_GUID | generierte Group Guid für Message Transfer | 20050104 | ||
| 2 | Importing |
IM_GROUP_ID | Call by reference | Type reference (TYPE) | SXMSGROUP_ID | Group ID für Message Transfer | 20050121 | ||
| 3 | Importing |
IM_GROUP_TYPE | Call by reference | Type reference (TYPE) | SXMSGROUP_TYPE | generierte Group Guid für Message Transfer | 20050121 | ||
| 4 | Returning |
RE_ERROR_MESSAGES | Value transfer | Type reference (TYPE) | SXMSFLAG | XMS: Flag (true/false) | 20050114 |
Method WRITE_DATA_TO_DB on class CL_XMS_MSG_TRANSFER_HANDLER has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 700 |
