SAP ABAP Class CL_XMS_MESSAGE_SECURITY (XI: Message Security)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-XI-IS-IEN (Application Component) Integration Engine
     SXMSF (Package) XI: Integration Engine Runtime
Properties
Class CL_XMS_MESSAGE_SECURITY  
Short Description XI: Message Security    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SXMSF   XI: Integration Engine Runtime 
Created 20031219   SAP 
Last change 20130531   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
2 SXMSS Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Class CL_XMS_MESSAGE_SECURITY has no interface implemented.
Friends
Class CL_XMS_MESSAGE_SECURITY has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 CO_ARCHIVE_VERSION Constant Public Type reference (TYPE) STRING '2.0' Current Archive Version 20040604
2 CO_ENCODING_UTF8 Constant Public Type reference (TYPE) ABAP_ENCODING 'UTF-8' Character Format UTF-8 20040115
3 CO_POLICYTYPE_APPLY Constant Public Type reference (TYPE) STRING 'applySignatureHeaderAndManifestWithSameKey' Policy Type Apply 20040518
4 CO_POLICYTYPE_APPLY_ENCRYPT Constant Public Type reference (TYPE) STRING 'applySignatureHeaderAndManifestWithSameKey_EncryptionPayloadsWithSameCertificate' Policy Type Apply+Encryption 20040924
5 CO_POLICYTYPE_DECRYPT Constant Public Type reference (TYPE) STRING 'verifyEncryptionPayloadsWithSameKey' Policy Type Decryption 20040924
6 CO_POLICYTYPE_ENCRYPT Constant Public Type reference (TYPE) STRING 'applyEncryptionPayloadsWithSameCertificate' Policy Type Encryption 20040924
7 CO_POLICYTYPE_VERIFY Constant Public Type reference (TYPE) STRING 'verifySignatureHeaderAndManifestWithSameCertificate' Policy Type Verify 20040518
8 CO_POLICYTYPE_VERIFY_DECRYPT Constant Public Type reference (TYPE) STRING 'verifySignatureHeaderAndManifestWithSameCertificate_EncryptionPayloadsWithSameKey' Policy Type Verify+Decryption 20040924
9 CO_WSSEC_VERSION Constant Public Type reference (TYPE) STRING 'WS Security SAP NW 04 Stack 02' Current WS Security Version 20040924
10 GV_LAST_POLICY_TYPE Static Attribute Protected Type reference (TYPE) STRING Last-Used Policy Type 20041006
Methods
# Method Level Visibility Method type Description Created on
1 ADD_ARCHIVE_TO_MESSAGE Static method Private Method Append XML Data for Archiving to Message as Attachment 20040521
2 ADD_SEC_ATTACHMENTS Static method Public Method Append Security Attachments to Message 20040607
3 ALLOW_PROCESSING Static method Private Method Lock Entire Function (For Test Purposes Only) 20040119
4 APPLY_PROFILE Static method Public Method Message Outbound: Apply Security Profile 20031219
5 CREATE_POLICY Static method Public Method Generate Policy for Security Action Verify/Apply 20031222
6 DEL_SEC_ATTACHMENTS Static method Public Method Delete Security Attachments to Message 20040607
7 GET_ARCHIVE_XML Static method Private Method Gets XML Attachment for Security Archiving 20040607
8 GET_MSG_SOAP_PART Static method Public Method Extract and Serialize Message SOAP Header 20040109
9 GET_MSG_WSS_ATTACHMENTS Static method Public Method Extract Message Attachments for Web Service Security 20040109
10 GET_SECURITY_HEADER_SAMPLE Static method Private Method Read Security Header from INDX (For Test Purposes Only) 20031219
11 PARSE_POLICY_APPLY Static method Public Method Parse Policy for Security Action Apply (with ST) 20040514
12 PARSE_POLICY_APPLY_ENCR Static method Public Method Parse Policy for Security Action Apply and Encrypt 20040928
13 PARSE_POLICY_DECRYPT Static method Public Method Parse Policy for Security Action Decryption (with ST) 20040927
14 PARSE_POLICY_ENCRYPT Static method Public Method Parse Policy for Security Action Encryption (with ST) 20040927
15 PARSE_POLICY_VERIFY Static method Public Method Parse Policy for Security Action Verify (with ST) 20040514
16 PARSE_POLICY_VERIFY_DECR Static method Public Method Parse Policy for Security Action Verify and Decrypt 20040928
17 PARSE_ST Static method Private Method Parse XML with Simple Transformation 20040519
18 RENDER_ARCHIVE_APPLY Static method Public Method Generate XML Data for Archiving in Security Action Apply 20040518
19 RENDER_ARCHIVE_VERIFY Static method Public Method Generate XML Data for Archiving in Security Action Verify 20040518
20 RENDER_POLICY_APPLY Static method Public Method Generate Policy for Security Action Apply (with ST) 20040514
21 RENDER_POLICY_APPLY_ENCR Static method Public Method Generate Policy for Security Action Apply and Encrypt 20040928
22 RENDER_POLICY_DECRYPT Static method Public Method Generate Policy for Security Action Decryption (with ST) 20040928
23 RENDER_POLICY_ENCRYPT Static method Public Method Generate Policy for Security Action Encryption (with ST) 20040928
24 RENDER_POLICY_VERIFY Static method Public Method Generate Policy for Security Action Verify (with ST) 20040514
25 RENDER_POLICY_VERIFY_DECR Static method Public Method Generate Policy for Security Action Verify and Decrypt 20040928
26 RENDER_ST Static method Private Method Generate XML with Simple Transformation 20040519
27 SET_MSG_WSS_ATTACHMENTS Static method Public Method Replace Message Attachments After Security Handling 20041005
28 VERIFY_PROFILE Static method Public Method Message Inbound: Verify Security Profile 20031219
Events
Class CL_XMS_MESSAGE_SECURITY has no event.
Types
Class CL_XMS_MESSAGE_SECURITY has no local type.
Method Signatures

Method ADD_ARCHIVE_TO_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_ARCHIVE_VALUES Call by reference Type reference (TYPE) SXMS_SECURITY_ARCHIVE_GLOBAL Globale Security Archivierungsdaten einer XI-Message 20040521
2 Importing IM_MESSAGE_INT Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE XI: internal message interface 20040521
3 Importing IM_MESSAGE_XSTRING Call by reference Type reference (TYPE) XSTRING Xstring of XI message 20040524
4 Importing IM_POLICY_REF Call by reference Object reference (TYPE REF TO) DATA XI Message Security: Policy Werte 20041004
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040521

Method ADD_SEC_ATTACHMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_ATT_BIN Call by reference Type reference (TYPE) XSTRING Binary Attachment 20040607
2 Importing IM_ATT_XML Call by reference Type reference (TYPE) STRING XML Attachment 20040607
3 Importing IM_MESSAGE Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE_XMB XI: internal message interface 20040607
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040607

Method ALLOW_PROCESSING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning ALLOW Value transfer Type reference (TYPE) SXMSFLAG XMS: Flag ('1'=true/'0'=false) 20040119

Method ALLOW_PROCESSING on class CL_XMS_MESSAGE_SECURITY has no exception.

Method APPLY_PROFILE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_SEC_ARCHIVE_BIN Call by reference Type reference (TYPE) XSTRING Binary SOAP Message Security Archive 20040607
2 Exporting EX_SEC_ARCHIVE_XML Call by reference Type reference (TYPE) STRING XML Security Archive 20040607
3 Exporting EX_STATUS Value transfer Type reference (TYPE) SXMSFLAG XI: Flag (true/false) 20040607
4 Importing IM_MESSAGE Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE_XMB XI-Message 20031219
5 Importing IM_PIPELINE Call by reference Type reference (TYPE) SXMSPIDEXT aktuelle Pipeline 20040524
# Exception Resumable Description Created on
1 CX_XMS_SYSERR_SECURITY XI: Systemfehler der Security-Behandlung 20031219
2 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040107

Method CREATE_POLICY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_POLICY Call by reference Type reference (TYPE) STRING Policy im XML-Format als String 20031222
2 Importing IM_POLICY_TYPE Call by reference Type reference (TYPE) STRING Security Aktion 20041004
3 Importing IM_POLICY_VALUES Call by reference Type reference (TYPE) ANY XI Message Security: Policy Werte 20031223
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040517

Method DEL_SEC_ATTACHMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_MESSAGE Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE_XMB XI: internal message interface 20040607
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040607

Method GET_ARCHIVE_XML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EX_SEC_ARCHIVE_XML Value transfer Type reference (TYPE) STRING XML String zur Security Archivierung 20040607
2 Importing IM_ARCHIVE_VALUES Call by reference Type reference (TYPE) SXMS_SECURITY_ARCHIVE_GLOBAL Globale Security Archivierungsdaten einer XI-Message 20040607
3 Importing IM_MESSAGE_INT Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE XI: internal message interface 20040607
4 Importing IM_POLICY_REF Call by reference Object reference (TYPE REF TO) DATA XI Message Security: Referenz Policy Werte 20040929
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040607

Method GET_MSG_SOAP_PART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_MESSAGE Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE XI-Message 20040109
2 Returning RE_SOAP_PART Value transfer Type reference (TYPE) XSTRING Serialisierter SOAP-Part der Message 20040109
# Exception Resumable Description Created on
1 CX_XMS_EXCEPTION Ausnahmen der XMS Messaging APIs 20040109
2 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040109

Method GET_MSG_WSS_ATTACHMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_MESSAGE Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE XI-Message 20040109
2 Returning RE_ATTACHMENTS Value transfer Type reference (TYPE) WSS_ATTACHMENT_TAB Attachments der SOAP Message 20040109
# Exception Resumable Description Created on
1 CX_XMS_EXCEPTION Ausnahmen der XMS Messaging APIs 20040109
2 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040109

Method GET_SECURITY_HEADER_SAMPLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_SECURITY_HEADER Value transfer Type reference (TYPE) SXMS_MSGHDR30_SECURITY_T XI: Message Security SOAP Header 20031219

Method GET_SECURITY_HEADER_SAMPLE on class CL_XMS_MESSAGE_SECURITY has no exception.

Method PARSE_POLICY_APPLY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EX_POLICY_VALUES Value transfer Type reference (TYPE) SXMSS_MSGSEC_POLICY_APPLY XI Message Security: Policy Werte 20040514
2 Importing IM_POLICY Call by reference Type reference (TYPE) STRING Policy im XML-Format als String 20040514
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040514

Method PARSE_POLICY_APPLY_ENCR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EX_POLICY_VALUES Value transfer Type reference (TYPE) SXMSS_MSGSEC_POLICY_APPLY_ENCR XI Message Security: Policy Werte 20040928
2 Importing IM_POLICY Call by reference Type reference (TYPE) STRING Policy im XML-Format als String 20040928
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040928

Method PARSE_POLICY_DECRYPT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EX_POLICY_VALUES Value transfer Type reference (TYPE) SXMSS_MSGSEC_POLICY_DECRYPT XI Message Security: Policy Werte 20040927
2 Importing IM_POLICY Call by reference Type reference (TYPE) STRING Policy im XML-Format als String 20040927
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040927

Method PARSE_POLICY_ENCRYPT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EX_POLICY_VALUES Value transfer Type reference (TYPE) SXMSS_MSGSEC_POLICY_ENCRYPT XI Message Security: Policy Werte 20040927
2 Importing IM_POLICY Call by reference Type reference (TYPE) STRING Policy im XML-Format als String 20040927
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040927

Method PARSE_POLICY_VERIFY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EX_POLICY_VALUES Value transfer Type reference (TYPE) SXMSS_MSGSEC_POLICY_VERIFY XI Message Security: Policy Werte 20040514
2 Importing IM_POLICY Call by reference Type reference (TYPE) STRING Policy im XML-Format als String 20040514
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040514

Method PARSE_POLICY_VERIFY_DECR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EX_POLICY_VALUES Value transfer Type reference (TYPE) SXMSS_MSGSEC_POLICY_VERIFY_DEC XI Message Security: Policy Werte 20040928
2 Importing IM_POLICY Call by reference Type reference (TYPE) STRING Policy im XML-Format als String 20040928
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040928

Method PARSE_ST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_ABAP_DEST Call by reference Object reference (TYPE REF TO) DATA ABAP Output Daten 20040519
2 Importing IM_TRANSFORMATION Call by reference Type reference (TYPE) STRING Name einer Transformation 20040519
3 Importing IM_XML_SOURCE Call by reference Type reference (TYPE) STRING Input XML Dokument 20040519
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040519

Method RENDER_ARCHIVE_APPLY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EX_ARCHIVE Value transfer Type reference (TYPE) STRING Daten für Archivierung im XML-Format als String 20040518
2 Importing IM_ARCHIVE_VALUES Call by reference Type reference (TYPE) SXMS_SECURITY_ARCHIVE_GLOBAL Globale Security Archivierungsdaten einer XI-Message 20040518
3 Importing IM_EXTERNAL Call by reference Type reference (TYPE) SXMSFLAG '0' XMS: Flag (true/false) 20040518
4 Importing IM_POLICY_REF Call by reference Object reference (TYPE REF TO) DATA XI Message Security: Policy Werte 20041004
5 Importing IM_SECURITY_VALUES Call by reference Type reference (TYPE) SXMS_MSGHDR30_SECURITY_T XI: Message Security SOAP Header 20040518
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040518

Method RENDER_ARCHIVE_VERIFY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EX_ARCHIVE Value transfer Type reference (TYPE) STRING Daten für Archivierung im XML-Format als String 20040518
2 Importing IM_ARCHIVE_VALUES Call by reference Type reference (TYPE) SXMS_SECURITY_ARCHIVE_GLOBAL Globale Security Archivierungsdaten einer XI-Message 20040518
3 Importing IM_EXTERNAL Call by reference Type reference (TYPE) SXMSFLAG '0' XMS: Flag (true/false) 20040518
4 Importing IM_POLICY_REF Call by reference Object reference (TYPE REF TO) DATA XI Message Security: Policy Werte 20040929
5 Importing IM_SECURITY_VALUES Call by reference Type reference (TYPE) SXMS_MSGHDR30_SECURITY_T XI: Message Security SOAP Header 20040518
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040518

Method RENDER_POLICY_APPLY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EX_POLICY Value transfer Type reference (TYPE) STRING Policy im XML-Format als String 20040514
2 Importing IM_POLICY_VALUES Call by reference Type reference (TYPE) SXMSS_MSGSEC_POLICY_APPLY XI Message Security: Policy Werte 20040514
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040514

Method RENDER_POLICY_APPLY_ENCR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EX_POLICY Value transfer Type reference (TYPE) STRING Policy im XML-Format als String 20040928
2 Importing IM_POLICY_VALUES Call by reference Type reference (TYPE) SXMSS_MSGSEC_POLICY_APPLY_ENCR XI Message Security: Policy Werte 20040928
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040928

Method RENDER_POLICY_DECRYPT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EX_POLICY Value transfer Type reference (TYPE) STRING Policy im XML-Format als String 20040928
2 Importing IM_POLICY_VALUES Call by reference Type reference (TYPE) SXMSS_MSGSEC_POLICY_DECRYPT XI Message Security: Policy Werte 20040928
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040928

Method RENDER_POLICY_ENCRYPT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EX_POLICY Value transfer Type reference (TYPE) STRING Policy im XML-Format als String 20040928
2 Importing IM_POLICY_VALUES Call by reference Type reference (TYPE) SXMSS_MSGSEC_POLICY_ENCRYPT XI Message Security: Policy Werte 20040928
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040928

Method RENDER_POLICY_VERIFY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EX_POLICY Value transfer Type reference (TYPE) STRING Policy im XML-Format als String 20040514
2 Importing IM_POLICY_VALUES Call by reference Type reference (TYPE) SXMSS_MSGSEC_POLICY_VERIFY XI Message Security: Policy Werte 20040514
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040514

Method RENDER_POLICY_VERIFY_DECR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EX_POLICY Value transfer Type reference (TYPE) STRING Policy im XML-Format als String 20040928
2 Importing IM_POLICY_VALUES Call by reference Type reference (TYPE) SXMSS_MSGSEC_POLICY_VERIFY_DEC XI Message Security: Policy Werte 20040928
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040928

Method RENDER_ST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_ABAP_SOURCE Call by reference Object reference (TYPE REF TO) DATA ABAP Input Daten 20040519
2 Importing IM_EXTERNAL Call by reference Type reference (TYPE) SXMSFLAG '0' XMS: Flag (true/false) 20040519
3 Importing IM_TRANSFORMATION Call by reference Type reference (TYPE) STRING Name einer Transformation 20040519
4 Returning RE_XML_DEST Value transfer Type reference (TYPE) STRING Output XML Dokument 20040519
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040519

Method SET_MSG_WSS_ATTACHMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_ATTACHMENTS Call by reference Type reference (TYPE) WSS_ATTACHMENT_TAB SOAP Message Attachments 20041005
2 Importing IM_MESSAGE Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE XI-Message 20041005
# Exception Resumable Description Created on
1 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20041005

Method VERIFY_PROFILE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_MESSAGE Call by reference Object reference (TYPE REF TO) IF_XMS_MESSAGE_XMB XI: XI-Message 20031219
2 Importing IM_MESSAGE_EXT Call by reference Object reference (TYPE REF TO) IF_XMS_PART XI: XI-Message extern 20040218
3 Returning RE_STATUS Value transfer Type reference (TYPE) SXMSFLAG XI: Flag (true/false) 20031219
# Exception Resumable Description Created on
1 CX_XMS_EXCEPTION Ausnahmen der XMS Messaging APIs 20040114
2 CX_XMS_SYSERR_SECURITY XI: Systemfehler der Security-Behandlung 20031219
3 CX_XMS_SYSTEM_ERROR XI: Systemfehler 20040114
History
Last changed by/on SAP  20130531 
SAP Release Created in 640