SAP ABAP Class CL_REST_URI_TPL (Utility for expanding URI Templates (RFC 6570))

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-MID-RST (Application Component) REST-based Protocols
     ⤷ SREST_UTIL (Package) REST Utility Functions

Properties

Class	CL_REST_URI_TPL
Short Description	Utility for expanding URI Templates (RFC 6570)
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SREST_UTIL	REST Utility Functions
Created	20120926	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_REST_URI_TPL has no forward declaration.

Interfaces

Class CL_REST_URI_TPL has no interface implemented.

Friends

Class CL_REST_URI_TPL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MV_TEMPLATE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		URI template string	20121025

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Creates a new URI template object from input template string	20121025
2	EXPAND	Instance method	Public	Method	Expands the whole URI template	20121025
3	EXPLODE_VARIABLE	Instance method	Private	Method	Expands a single expression	20121025
4	IS_VARIABLE_SYNTAX_CORRECT	Instance method	Private	Method	Checks if an expression is correctly formatted	20121025

Events

Class CL_REST_URI_TPL has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	VARIABLE_S	Public	See coding		Describes a single template variable	20121026	begin of variable_s, name type string, values type variable_value_t, end of variable_s
2	VARIABLE_T	Public	See coding		A list of template variables	20121026	variable_t type table of variable_s with key name
3	VARIABLE_VALUE_S	Public	See coding		Key and value	20121026	begin of variable_value_s, key type string, "optional value type string, end of variable_value_s
4	VARIABLE_VALUE_T	Public	See coding		A list of key/value pairs for a template variable	20121026	variable_value_t type standard table of variable_value_s with default key

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TEMPLATE	Call by reference	☐	Type reference (TYPE)	STRING		URI template string	20121025

Method CONSTRUCTOR on class CL_REST_URI_TPL has no exception.

Method EXPAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_VARIABLE	Call by reference	☐	Type reference (TYPE)	VARIABLE_T		List of template variables and thier values	20121026
2	Returning	RV_URI	Value transfer	☐	Type reference (TYPE)	STRING		Constructed URI	20121026

#	Exception	Resumable	Description	Created on
1	CX_REST_URI_TPL_ERROR	☐		20121025

Method EXPLODE_VARIABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_VARIABLES	Call by reference	☐	Type reference (TYPE)	VARIABLE_T			20121025
2	Importing	IV_OPERATOR	Call by reference	☐	Type reference (TYPE)	CHAR1		Operator ( see RFC6470 chapter 2.2. Expressions)	20121025
3	Importing	IV_VARIABLE	Call by reference	☐	Type reference (TYPE)	STRING			20121025
4	Returning	R_RESULT	Value transfer	☐	Type reference (TYPE)	STRING			20121025

#	Exception	Resumable	Description	Created on
1	CX_REST_URI_TPL_ERROR	☐		20121026

Method IS_VARIABLE_SYNTAX_CORRECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VARIABLE	Call by reference	☐	Type reference (TYPE)	STRING			20121025
2	Returning	R_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20121025

Method IS_VARIABLE_SYNTAX_CORRECT on class CL_REST_URI_TPL has no exception.

History

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