SAP ABAP Class CL_SPML_CLIENT (SPML Client Class)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SEC-USR-ADM (Application Component) User and Authorization Management
     ⤷ SUSR_SPML (Package) SPML Client

Properties

Class	CL_SPML_CLIENT
Short Description	SPML Client Class
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SUSR_SPML	SPML Client
Created	20081013	SAP
Last change	20090618	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_SPML_CLIENT has no forward declaration.

Interfaces

Class CL_SPML_CLIENT has no interface implemented.

Friends

Class CL_SPML_CLIENT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_ADD	Constant	Private	☐	Type reference (TYPE)	STRING	'add'		20090122
2	CO_ADD_REQUEST	Constant	Public	☐	Type reference (TYPE)	STRING	'SPMLADD'		20090122
3	CO_DATE	Constant	Public	☐	Type reference (TYPE)	STRING	'000000Z'		20090122
4	CO_DELETE	Constant	Private	☐	Type reference (TYPE)	STRING	'delete'		20090122
5	CO_DEL_REQUEST	Constant	Public	☐	Type reference (TYPE)	STRING	'SPMLDEL'		20090122
6	CO_DSML_PRESENT	Constant	Private	☐	Type reference (TYPE)	STRING	'dsml:present'		20090122
7	CO_FILTER_GROUPS	Constant	Private	☐	Type reference (TYPE)	STRING	'GRUP.SUPER_GROUPS_DATASOURCE.'		20090122
8	CO_LOGONNAME	Constant	Public	☐	Type reference (TYPE)	STRING	'logonname'		20090122
9	CO_MEMBER	Constant	Private	☐	Type reference (TYPE)	STRING	'member'		20090122
10	CO_MODIFICATION	Constant	Private	☐	Type reference (TYPE)	STRING	'modification'		20090122
11	CO_MOD_REQUEST	Constant	Public	☐	Type reference (TYPE)	STRING	'SPMLMOD'		20090122
12	CO_NS_SEPARATOR	Constant	Private	☐	Type reference (TYPE)	C	'#'		20090122
13	CO_OPERATION	Constant	Private	☐	Type reference (TYPE)	STRING	'operation'		20090122
14	CO_REQUEST	Constant	Public	☐	Type reference (TYPE)	STRING	'SPMLREQ'		20090122
15	CO_RESPONSE	Constant	Public	☐	Type reference (TYPE)	STRING	'SPMLRSP'		20090122
16	CO_RESP_ERROR	Constant	Private	☐	Type reference (TYPE)	STRING	'error'		20090122
17	CO_RESP_ERROR_CODE	Constant	Private	☐	Type reference (TYPE)	STRING	'errorCode'		20090122
18	CO_RESP_ERROR_MSG	Constant	Private	☐	Type reference (TYPE)	STRING	'errorMessage'		20090122
19	CO_RESP_RESULT	Constant	Private	☐	Type reference (TYPE)	STRING	'result'		20090122
20	CO_RESULT_FAILURE	Constant	Public	☐	Type reference (TYPE)	STRING	'failure'		20090122
21	CO_RESULT_SUCCESS	Constant	Public	☐	Type reference (TYPE)	STRING	'success'		20090122
22	CO_SAPGROUP	Constant	Private	☐	Type reference (TYPE)	STRING	'sapgroup'		20090122
23	CO_SAPROLE	Constant	Private	☐	Type reference (TYPE)	STRING	'saprole'		20090122
24	CO_SAPUSER	Constant	Private	☐	Type reference (TYPE)	STRING	'sapuser'		20090122
25	CO_SCHEMA_REQUEST	Constant	Public	☐	Type reference (TYPE)	STRING	'SPMLSREQ'		20090122
26	CO_SOAP_BDY	Constant	Private	☐	Type reference (TYPE)	STRING	'Body'		20090122
27	CO_SOAP_ENV	Constant	Private	☐	Type reference (TYPE)	STRING	'Envelope'		20090122
28	CO_SOAP_ENV_NS	Constant	Private	☐	Type reference (TYPE)	STRING	'http://schemas.xmlsoap.org/soap/envelope/'		20090122
29	CO_SOAP_ENV_PREFIX	Constant	Private	☐	Type reference (TYPE)	STRING	'soapenv'		20090122
30	CO_SUCCESS	Constant	Private	☐	Type reference (TYPE)	STRING	'success'		20090122
31	CO_UNIQUENAME	Constant	Private	☐	Type reference (TYPE)	STRING	'uniquename'		20090122
32	MS_IDM_INTEG_CUST	Instance attribute	Private	☐	Type reference (TYPE)	SPML_ST_IDM_INTEG_CUST		Structure Type: IDM Configuration	20090127

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Generates SPML client object	20090122
2	CREATE_MESSAGE	Static method	Public	Method	Create instance of SPML message object	20090122
3	CREATE_SOAP_ENVELOPE	Instance method	Public	Method		20090122
4	GET_SPML_STATUS	Static method	Public	Method	Read operation status from response message	20090122
5	OPEN_SOAP_ENVELOPE	Static method	Public	Method		20090122
6	SEND_SPML_REQUEST	Instance method	Public	Method	Send SPML request to the SPML service	20090122

Events

Class CL_SPML_CLIENT has no event.

Types

Class CL_SPML_CLIENT has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_IDM_INTEG_CUST	Call by reference	☐	Type reference (TYPE)	SPML_ST_IDM_INTEG_CUST			20090127

Method CONSTRUCTOR on class CL_SPML_CLIENT has no exception.

Method CREATE_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SPML_MESSAGE_DOM	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20090122
2	Importing	IV_MESSAGE_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20090122
3	Importing	IV_SPML_MESSAGE_STR	Call by reference	☑	Type reference (TYPE)	STRING			20090122
4	Importing	IV_SPML_MESSAGE_XSTR	Call by reference	☑	Type reference (TYPE)	XSTRING			20090122
5	Returning	RO_SPML_MESSAGE	Value transfer	☐	Object reference (TYPE REF TO)	IF_SPML_MESSAGE		SPML Message	20090122

#	Exception	Resumable	Description	Created on
1	CX_SPML_EXCEPTION	☐	Ausnahmeklasse für Message	20090122

Method CREATE_SOAP_ENVELOPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SPML_MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	IF_SPML_MESSAGE			20090122
2	Returning	RV_SOAP_MESSAGE	Value transfer	☐	Type reference (TYPE)	XSTRING			20090122

#	Exception	Resumable	Description	Created on
1	CX_SPML_EXCEPTION	☐		20090122

Method GET_SPML_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ERROR_MSG	Call by reference	☐	Type reference (TYPE)	SPML_TT_STRING		Error(s) message in case of failure	20090122
2	Exporting	EV_ERROR_CODE	Call by reference	☐	Type reference (TYPE)	STRING		Error code in case of failure	20090122
3	Exporting	EV_RESULT	Call by reference	☐	Type reference (TYPE)	STRING		Result of request execution	20090122
4	Importing	IO_SPML_MSG	Call by reference	☐	Object reference (TYPE REF TO)	IF_SPML_MESSAGE		SPML message interface	20090122

#	Exception	Resumable	Description	Created on
1	CX_SPML_EXCEPTION	☐	Ausnahmeklasse für Message	20090122

Method OPEN_SOAP_ENVELOPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SOAP_MESSAGE	Call by reference	☐	Type reference (TYPE)	XSTRING			20090122
2	Returning	RO_SPML_MESSAGE	Value transfer	☐	Object reference (TYPE REF TO)	IF_SPML_MESSAGE			20090122

#	Exception	Resumable	Description	Created on
1	CX_SPML_EXCEPTION	☐		20090122

Method SEND_SPML_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRET2_T			20090209
2	Exporting	EV_RESPONSE	Call by reference	☐	Type reference (TYPE)	XSTRING			20090209
3	Importing	IV_REQUEST	Call by reference	☐	Type reference (TYPE)	XSTRING		Request in SOAP envelope	20090122
4	Importing	IV_REQUEST_IDENTIFIER	Call by reference	☑	Type reference (TYPE)	STRING			20090209

#	Exception	Resumable	Description	Created on
1	CX_SPML_EXCEPTION	☐	Ausnahmeklasse für Message	20090122

History

Last changed by/on	SAP	20090618
SAP Release Created in	740