SAP ABAP Interface IF_SOAP_SECURITY_HELPER (Security Handling for Serialization/Deserialization)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-ESI-WS-ABA-RT (Application Component) WebServices ABAP Runtime
⤷
SOAP_CORE (Package) SOAP Runtime: Core SOAP Functionality
⤷
⤷
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_WS_SECURITY_PROTOCOL | Web Services Security Log Implementation | 20060119 |
Properties
| Interface | IF_SOAP_SECURITY_HELPER | |
| Short Description | Security Handling for Serialization/Deserialization |
General Data
| Package | SOAP_CORE | SOAP Runtime: Core SOAP Functionality |
| Created | 20060118 | SAP |
| Last changed | 20140121 | SAP |
| Unicode checks active |
Forward declarations
Interface IF_SOAP_SECURITY_HELPER has no forward declaration.
Interfaces
Interface IF_SOAP_SECURITY_HELPER has no interface.
Friends
Interface IF_SOAP_SECURITY_HELPER has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CO_ELEMENT_CHECKED | Constant | Public | Type reference (TYPE) | TY_CHECK_ELEMENT_RESULT | 'O' | Element can be parsed | 20060118 | |
| 2 | CO_ELEMENT_CONSUMED | Constant | Public | Type reference (TYPE) | TY_CHECK_ELEMENT_RESULT | 'C' | Element parsed | 20060118 | |
| 3 | CO_ELEMENT_ENCRYPTED_HEADER | Constant | Public | Type reference (TYPE) | TY_CHECK_ELEMENT_RESULT | 'E' | Header was encrypted | 20080214 | |
| 4 | CO_ELEMENT_POSTPONED | Constant | Public | Type reference (TYPE) | TY_CHECK_ELEMENT_RESULT | 'P' | Reset element until security header parsed | 20060118 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Security Checks After Parsing of SOAP Header/Body | 20060118 | |
| 2 | Instance method | Public | Method | Security Checks for SOAP Header | 20060118 | |
| 3 | Instance method | Public | Method | Set sequence ID for reliable messaging | 20080208 | |
| 4 | Instance method | Public | Method | 20080307 | ||
| 5 | Instance method | Public | Method | Handle errors in XML decrypt | 20111206 | |
| 6 | Instance method | Public | Method | Determine whether sig/enc is configured | 20081208 | |
| 7 | Instance method | Public | Method | Determine whether security processing is required | 20060118 | |
| 8 | Instance method | Public | Method | Security Handling of Message Before Serialization | 20060118 | |
| 9 | Instance method | Public | Method | Set sequence ID for reliable messaging | 20080208 | |
| 10 | Instance method | Public | Method | Deactivate Security Functions for XML Reader | 20060120 | |
| 11 | Instance method | Public | Method | Deactivate Security Functions for XML Writer | 20060120 | |
| 12 | Instance method | Public | Method | Activate Security Functions for XML Reader | 20060120 | |
| 13 | Instance method | Public | Method | Activate Security Functions for XML Writer | 20060120 |
Events
Interface IF_SOAP_SECURITY_HELPER has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_CHECK_ELEMENT_RESULT | Public | Type reference (TYPE) | CHAR1 | 20060118 | |
Method Signatures
Method CHECK_AFTER_DESERIALIZATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_BODY | Call by reference | Object reference (TYPE REF TO) | IF_SXMLP_PART | XML Part for SOAP Body | 20130327 | |||
| 2 | IM_BODY_ELEMENT | Call by reference | Object reference (TYPE REF TO) | IF_SXML_OPEN_ELEMENT | SXML Element-Start | 20060323 |
Method CHECK_AFTER_DESERIALIZATION on Interface IF_SOAP_SECURITY_HELPER has no exception.
Method CHECK_ELEMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_READER | Call by reference | Object reference (TYPE REF TO) | IF_SXML_READER | SXML Reader Interface | 20060119 | |||
| 2 | RE_RESULT | Value transfer | Type reference (TYPE) | TY_CHECK_ELEMENT_RESULT | Ergebnis der Prüfung (siehe Konstanten) | 20060118 |
Method CHECK_ELEMENT on Interface IF_SOAP_SECURITY_HELPER has no exception.
Method GET_RM_SEQUENCEID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_SEQUENCEID | Value transfer | Type reference (TYPE) | SYSUUID_C32 | 16 byte UUID in 32 chars (hexadecimal encoded) | 20080208 |
Method GET_RM_SEQUENCEID on Interface IF_SOAP_SECURITY_HELPER has no exception.
Method GET_SCT_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_SCT_ID | Value transfer | Type reference (TYPE) | STRING | 20080307 |
Method GET_SCT_ID on Interface IF_SOAP_SECURITY_HELPER has no exception.
Method HANDLE_DECRYPT_ERROR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_EXCEPTION | Call by reference | Object reference (TYPE REF TO) | CX_ROOT | Abstract Superclass for All Global Exceptions | 20111206 |
Method HANDLE_DECRYPT_ERROR on Interface IF_SOAP_SECURITY_HELPER has no exception.
Method IS_MESSAGE_PROTECTION_ENABLED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EF_HAS_ENC | Call by reference | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20081208 | |||
| 2 | EF_HAS_SIG | Call by reference | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20081208 |
Method IS_MESSAGE_PROTECTION_ENABLED on Interface IF_SOAP_SECURITY_HELPER has no exception.
Method IS_SECURITY_ENABLED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_RESULT | Value transfer | Type reference (TYPE) | BOOLEAN | boolsche Variable (X=true, -=false, space=unknown) | 20060118 |
Method IS_SECURITY_ENABLED on Interface IF_SOAP_SECURITY_HELPER has no exception.
Method SECURE_BEFORE_SERIALIZATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EX_MOD_BODY | Call by reference | Object reference (TYPE REF TO) | IF_SXMLP_PART | 20101102 | ||||
| 2 | IM_BODY | Call by reference | Object reference (TYPE REF TO) | IF_SXMLP_PART | SOAP Body Element | 20060118 | |||
| 3 | IM_BODY_CHILDREN | Call by reference | Object reference (TYPE REF TO) | IF_SXMLP_PART_COLLECTION | Direkte Kind-Elemente vom SOAP Body Element | 20060118 | |||
| 4 | IM_HEADER | Call by reference | Object reference (TYPE REF TO) | IF_SXMLP_PART | SOAP Header Element | 20060118 | |||
| 5 | IM_HEADER_CHILDREN | Call by reference | Object reference (TYPE REF TO) | IF_SXMLP_PART_COLLECTION | Direkte Kind-Elemente vom SOAP Header Element | 20060118 | |||
| 6 | RE_SECURITY_HEADER | Value transfer | Object reference (TYPE REF TO) | IF_SXMLP_PART | Security Header | 20060125 |
Method SECURE_BEFORE_SERIALIZATION on Interface IF_SOAP_SECURITY_HELPER has no exception.
Method SET_RM_SEQUENCEID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_SEQUENCEID | Call by reference | Type reference (TYPE) | SYSUUID_C32 | 16 byte UUID in 32 chars (hexadecimal encoded) | 20080208 |
Method SET_RM_SEQUENCEID on Interface IF_SOAP_SECURITY_HELPER has no exception.
Method SWITCH_TO_NON_SECURE_READER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_READER | Call by reference | Object reference (TYPE REF TO) | IF_SXML_READER | SXML Reader Interface | 20060120 |
Method SWITCH_TO_NON_SECURE_READER on Interface IF_SOAP_SECURITY_HELPER has no exception.
Method SWITCH_TO_NON_SECURE_WRITER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_WRITER | Call by reference | Object reference (TYPE REF TO) | IF_SXML_WRITER | SXML Writer Interface | 20060120 |
Method SWITCH_TO_NON_SECURE_WRITER on Interface IF_SOAP_SECURITY_HELPER has no exception.
Method SWITCH_TO_SECURE_READER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IF_POSTPONED | Call by reference | Type reference (TYPE) | BOOLEAN | X=postponed, space= not postponed | 20080227 | |||
| 2 | IM_READER | Call by reference | Object reference (TYPE REF TO) | IF_SXML_READER | SXML Reader Interface | 20060120 |
Method SWITCH_TO_SECURE_READER on Interface IF_SOAP_SECURITY_HELPER has no exception.
Method SWITCH_TO_SECURE_WRITER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_WRITER | Call by reference | Object reference (TYPE REF TO) | IF_SXML_WRITER | SXML Writer Interface | 20060120 |
Method SWITCH_TO_SECURE_WRITER on Interface IF_SOAP_SECURITY_HELPER has no exception.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 710 |