SAP ABAP Class CL_REST_MESSAGE_BUILDER (REST message builder)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-MID-RST (Application Component) REST-based Protocols
     ⤷ SREST_CORE (Package) REST Core

Properties

Class	CL_REST_MESSAGE_BUILDER
Short Description	REST message builder
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SREST_CORE	REST Core
Created	20111011	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	IF_REST_MESSAGE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_REST_MESSAGE_BUILDER has no interface implemented.

Friends

Class CL_REST_MESSAGE_BUILDER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_HTTP_VERSION_1_0	Constant	Public	☐	Type reference (TYPE)	HTTP_VERSION	'1.0'		20111011
2	GC_HTTP_VERSION_1_1	Constant	Public	☐	Type reference (TYPE)	HTTP_VERSION	'1.1'		20111011

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE_EMPTY_HTTP_REQUEST	Static method	Private	Method	Create empty http request	20120309
2	CREATE_EMPTY_HTTP_RESPONSE	Static method	Private	Method	Create empty http response	20120309
3	CREATE_HTTP_MESSAGE_ENTITY	Static method	Public	Method	Create entity by http entity	20120309
4	CREATE_HTTP_REQUEST	Static method	Public	Method	Create request by http request	20111011
5	CREATE_HTTP_RESPONSE	Static method	Public	Method	Create response by http response	20111011
6	CREATE_MESSAGE_ENTITY	Static method	Public	Method	Create message entity	20120309
7	CREATE_REQUEST	Static method	Public	Method	Create request	20111011
8	CREATE_RESPONSE	Static method	Public	Method	Create response	20111011
9	SET_HTTP_RESPONSE_VERSION	Static method	Private	Method	Set http response version	20111011

Events

Class CL_REST_MESSAGE_BUILDER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	HTTP_VERSION	Public	See coding			20111011	http_version TYPE p LENGTH 2 DECIMALS 1

Method Signatures

Method CREATE_EMPTY_HTTP_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HTTP_VERSION	Call by reference	☐	Type reference (TYPE)	HTTP_VERSION	GC_HTTP_VERSION_1_1	Version	20120309
2	Returning	RO_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Request	20120309

Method CREATE_EMPTY_HTTP_REQUEST on class CL_REST_MESSAGE_BUILDER has no exception.

Method CREATE_EMPTY_HTTP_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_HTTP_VERSION	Call by reference	☐	Type reference (TYPE)	HTTP_VERSION	GC_HTTP_VERSION_1_1	Version	20120309
2	Returning	RO_RESPONSE	Value transfer	☐	Object reference (TYPE REF TO)	IF_HTTP_RESPONSE		HTTP Response	20120309

Method CREATE_EMPTY_HTTP_RESPONSE on class CL_REST_MESSAGE_BUILDER has no exception.

Method CREATE_HTTP_MESSAGE_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HTTP_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_ENTITY		HTTP entity	20120309
2	Returning	RO_ENTITY	Value transfer	☐	Object reference (TYPE REF TO)	IF_REST_ENTITY		REST entity	20120309

Method CREATE_HTTP_MESSAGE_ENTITY on class CL_REST_MESSAGE_BUILDER has no exception.

Method CREATE_HTTP_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HTTP_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Request	20111011
2	Importing	IV_ALLOW_METHOD_OVERRIDE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_UNDEFINED	Allow method override	20120308
3	Returning	RO_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	IF_REST_REQUEST		REST Request	20111011

Method CREATE_HTTP_REQUEST on class CL_REST_MESSAGE_BUILDER has no exception.

Method CREATE_HTTP_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HTTP_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_RESPONSE		HTTP Response	20111011
2	Returning	RO_RESPONSE	Value transfer	☐	Object reference (TYPE REF TO)	IF_REST_RESPONSE		REST Response	20111011

Method CREATE_HTTP_RESPONSE on class CL_REST_MESSAGE_BUILDER has no exception.

Method CREATE_MESSAGE_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_HEADER_FIELD	Call by reference	☑	Type reference (TYPE)	TIHTTPNVP		Header fields	20120309
2	Importing	IV_MESSAGE_KIND	Call by reference	☐	Type reference (TYPE)	IF_REST_MESSAGE=>MESSAGE_KIND	IF_REST_MESSAGE=>GC_MESSAGE_KIND_NONE	Message Kind	20120309
3	Returning	RO_ENTITY	Value transfer	☐	Object reference (TYPE REF TO)	IF_REST_ENTITY		REST Entity	20120309

Method CREATE_MESSAGE_ENTITY on class CL_REST_MESSAGE_BUILDER has no exception.

Method CREATE_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_HEADER_FIELD	Call by reference	☑	Type reference (TYPE)	TIHTTPNVP		Header fields	20111011
2	Importing	IV_HTTP_VERSION	Call by reference	☐	Type reference (TYPE)	HTTP_VERSION	GC_HTTP_VERSION_1_1	Version	20111011
3	Importing	IV_METHOD	Call by reference	☐	Type reference (TYPE)	STRING		Method	20111011
4	Importing	IV_SCRIPT_NAME	Call by reference	☑	Type reference (TYPE)	STRING		Script name	20120209
5	Importing	IV_URI	Call by reference	☐	Type reference (TYPE)	STRING		URI	20111011
6	Returning	RO_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	IF_REST_REQUEST		REST Request	20111011

Method CREATE_REQUEST on class CL_REST_MESSAGE_BUILDER has no exception.

Method CREATE_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_HEADER_FIELD	Call by reference	☑	Type reference (TYPE)	TIHTTPNVP		Header fields	20111011
2	Importing	IV_HTTP_VERSION	Call by reference	☐	Type reference (TYPE)	HTTP_VERSION	GC_HTTP_VERSION_1_1	Protocol version	20111011
3	Importing	IV_REASON_PHRASE	Call by reference	☑	Type reference (TYPE)	STRING		Reason phrase	20111011
4	Importing	IV_STATUS_CODE	Call by reference	☐	Type reference (TYPE)	I	CL_REST_STATUS_CODE=>GC_SUCCESS_OK	Status code	20111011
5	Returning	RO_RESPONSE	Value transfer	☐	Object reference (TYPE REF TO)	IF_REST_RESPONSE		Response	20111011

Method CREATE_RESPONSE on class CL_REST_MESSAGE_BUILDER has no exception.

Method SET_HTTP_RESPONSE_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HTTP_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_RESPONSE		HTTP Response	20111011
2	Importing	IV_PROTOCOL_VERSION	Call by reference	☐	Type reference (TYPE)	I		HTTP protocol version	20111011

Method SET_HTTP_RESPONSE_VERSION on class CL_REST_MESSAGE_BUILDER has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	803