SAP ABAP Class CL_XMS_RETRY_HANDLER (Retry Handler)

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_RETRY_HANDLER
Short Description	Retry Handler
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	SXMSF	XI: Integration Engine Runtime
Created	20050321	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_XMS_RETRY_HANDLER has no forward declaration.

Interfaces

Class CL_XMS_RETRY_HANDLER has no interface implemented.

Friends

Class CL_XMS_RETRY_HANDLER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_SKIP_XML_INB	Constant	Public	☐	Type reference (TYPE)	SXMS_XMLVAL	2	Skip XML Validation in Inbound Channel	20060109
2	CO_SKIP_XML_OUT	Constant	Public	☐	Type reference (TYPE)	SXMS_XMLVAL	1	Skip XML Validation in Outbound Channel	20060109
3	EOIO_GUI_FLAG	Static Attribute	Private	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20131209
4	RETRY_LIMIT	Constant	Public	☐	Type reference (TYPE)	I	10		20050322
5	_INST	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_XMS_RETRY_HANDLER		Retry Handler	20050321
6	_QUEUE_SYSTEM	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_XMS_QUEUEING_SYSTEM		Queueing System API	20090421

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CANCEL_MESSAGE	Instance method	Public	Method		20060104
2	CHECK_BATCH	Instance method	Public	Method		20110310
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20050321
4	DELETE_BEFORE_REEXEC_VERSION	Instance method	Public	Method		20050323
5	DELETE_LAST_ERROR_VERSION	Instance method	Public	Method		20050321
6	DELETE_LAST_PRODUCTIVE_VERSION	Instance method	Public	Method		20050323
7	GET_ERROR_INFO	Instance method	Public	Method		20060207
8	GET_INSTANCE	Static method	Public	Method		20050321
9	GET_LAST_ERROR_VERSION	Instance method	Public	Method		20050323
10	GET_LAST_PRODUCTIVE_VERSION	Instance method	Public	Method		20050321
11	GET_LAST_PROD_VERSION	Instance method	Public	Method		20050408
12	GET_LAST_VERSION	Instance method	Public	Method		20050915
13	GET_LAST_VERSION_LOG	Instance method	Public	Method		20060512
14	GET_RETRY_LIMIT	Instance method	Public	Method		20050322
15	IS_ERROR	Instance method	Public	Method		20050321
16	IS_FINAL_ERROR	Instance method	Public	Method		20050414
17	IS_FINAL_STATE	Instance method	Public	Method		20051005
18	IS_PRODUCTIVE_VERSION_REEXEC	Instance method	Public	Method		20050323
19	RESTART_MESSAGE	Instance method	Public	Method		20051216

Events

Class CL_XMS_RETRY_HANDLER has no event.

Types

Class CL_XMS_RETRY_HANDLER has no local type.

Method Signatures

Method CANCEL_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EOIO_FORCE	Call by reference	☐	Type reference (TYPE)	CHAR1	'I'	Einstelliges Kennzeichen	20060104
2	Importing	MESSAGE_GUID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20060104
3	Importing	PIPELINE_ID	Call by reference	☐	Type reference (TYPE)	SXMSPIDEXT		Integration Engine: logische Pipeline-ID	20060104

#	Exception	Resumable	Description	Created on
1	ACTION_CANCELLED	☐	Quittieren wurde gecancelt	20060104
2	CANCEL_NO_BE	☐	Only asynchronous messages can be acknowledged	20060104
3	INTERNAL_SYSTEM_ERROR	☐	Internal Error	20060104
4	MESSAGE_ALREADY_SCHEDULED	☐	Message wartet auf Verarbeitung: Cancel nicht möglich	20060104
5	MESSAGE_LOCKED	☐	Message to be acknowledged is locked	20060104
6	NO_ERROR_STATE	☐	Message not in error status	20060104
7	PERSIST_ERROR	☐	Error accessing persistence layer	20060104
8	SCHEDULE_QRFC_ERROR	☐	Error scheduling message in qRFC	20060104

Method CHECK_BATCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MSGGUID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20110310
2	Importing	IM_PID	Call by reference	☐	Type reference (TYPE)	SXMSPIDEXT		Integration Engine: logische Pipeline-ID	20110310
3	Changing	STATUS	Call by reference	☐	Type reference (TYPE)	SXMSPMSTAT		Integration Engine: Status einer Message	20110310

Method CHECK_BATCH on class CL_XMS_RETRY_HANDLER has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_XMS_RETRY_HANDLER has no parameter.
Method CONSTRUCTOR on class CL_XMS_RETRY_HANDLER has no exception.

Method DELETE_BEFORE_REEXEC_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACT_VERS	Call by reference	☐	Type reference (TYPE)	SXMSLSQNBR		Fortlaufende Nummer für ID eines Message-Log	20050323
2	Importing	EXCEPTION_ATTR	Call by reference	☐	Type reference (TYPE)	SXMSSYSERR		XI: Attribute eines Systemfehlers	20050323
3	Importing	MSGID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20050323
4	Importing	PID	Call by reference	☐	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20050323
5	Importing	RO	Call by reference	☐	Object reference (TYPE REF TO)	CL_XMS_RUN_TIME_ENV		XMS: Laufzeitumgebung	20050323

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20050323

Method DELETE_LAST_ERROR_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXCEPTION_ATTR	Call by reference	☐	Type reference (TYPE)	SXMSSYSERR		XI: Attribute eines Systemfehlers	20050323
2	Importing	MSGID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20050321
3	Importing	PID	Call by reference	☐	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20050321
4	Importing	RO	Call by reference	☐	Object reference (TYPE REF TO)	CL_XMS_RUN_TIME_ENV		XMS: Laufzeitumgebung	20050321

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20050321

Method DELETE_LAST_PRODUCTIVE_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20050323
2	Importing	PID	Call by reference	☐	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20050323
3	Importing	RO	Call by reference	☐	Object reference (TYPE REF TO)	CL_XMS_RUN_TIME_ENV		XMS: Laufzeitumgebung	20050323

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20050323

Method GET_ERROR_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ERROR_INFO	Value transfer	☐	Type reference (TYPE)	SXMSPERROR		XML Message Broker: Message-Queue (fehlerhafte Einträge)	20060207
2	Importing	MSGID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20060207
3	Importing	PID	Call by reference	☐	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20060207
4	Importing	VERS	Call by reference	☐	Type reference (TYPE)	SXMSLSQNBR		Fortlaufende Nummer für ID eines Message-Log	20060207

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20060207

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	INST	Value transfer	☐	Object reference (TYPE REF TO)	CL_XMS_RETRY_HANDLER			20050321

Method GET_INSTANCE on class CL_XMS_RETRY_HANDLER has no exception.

Method GET_LAST_ERROR_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGID	Value transfer	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20050323
2	Importing	PID	Value transfer	☐	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20050323
3	Importing	START_VERS	Value transfer	☐	Type reference (TYPE)	SXMSLSQNBR		Fortlaufende Nummer für ID eines Message-Log	20050323
4	Returning	VERS	Value transfer	☐	Type reference (TYPE)	SXMSLSQNBR		Fortlaufende Nummer für ID eines Message-Log	20050323

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20050323

Method GET_LAST_PRODUCTIVE_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGID	Value transfer	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20050321
2	Importing	PID	Value transfer	☐	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20050321
3	Importing	START_VERS	Value transfer	☐	Type reference (TYPE)	SXMSLSQNBR		Fortlaufende Nummer für ID eines Message-Log	20050321
4	Returning	VERS	Value transfer	☐	Type reference (TYPE)	SXMSLSQNBR		Fortlaufende Nummer für ID eines Message-Log	20050321

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20050321

Method GET_LAST_PROD_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGID	Value transfer	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20050408
2	Importing	PID	Value transfer	☐	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20050408
3	Importing	START_VERS	Value transfer	☐	Type reference (TYPE)	SXMSLSQNBR		Fortlaufende Nummer für ID eines Message-Log	20050408
4	Returning	VERS	Value transfer	☐	Type reference (TYPE)	SXMSLSQNBR		Fortlaufende Nummer für ID eines Message-Log	20050408

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20050408

Method GET_LAST_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20050915
2	Importing	PID	Call by reference	☐	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20050915
3	Returning	VERS	Value transfer	☐	Type reference (TYPE)	SXMSLSQNBR		Fortlaufende Nummer für ID eines Message-Log	20050915

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20050915

Method GET_LAST_VERSION_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LAST_VERS	Value transfer	☐	Type reference (TYPE)	SXMSLSQNBR		Fortlaufende Nummer für ID eines Message-Log	20060512
2	Importing	MSGID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20060512
3	Importing	PID	Call by reference	☐	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20060512

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20060512

Method GET_RETRY_LIMIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	MAX_RETRIES	Value transfer	☐	Type reference (TYPE)	INT4		Natürliche Zahl	20050322
2	Importing	QUEUE	Call by reference	☐	Type reference (TYPE)	TRFCQNAM		Name einer tRFC-Queue	20050322

Method GET_RETRY_LIMIT on class CL_XMS_RETRY_HANDLER has no exception.

Method IS_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ERROR	Value transfer	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20050321
2	Importing	STATE	Call by reference	☐	Type reference (TYPE)	SXMSPMSTAT		Integration Engine: Status einer Message	20050321

Method IS_ERROR on class CL_XMS_RETRY_HANDLER has no exception.

Method IS_FINAL_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ERROR	Value transfer	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20050414
2	Importing	STATE	Call by reference	☐	Type reference (TYPE)	SXMSPMSTAT		Integration Engine: Status einer Message	20050414

Method IS_FINAL_ERROR on class CL_XMS_RETRY_HANDLER has no exception.

Method IS_FINAL_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RET	Value transfer	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20051005
2	Importing	STATE	Call by reference	☐	Type reference (TYPE)	SXMSPMSTAT		Integration Engine: Status einer Message	20051005

Method IS_FINAL_STATE on class CL_XMS_RETRY_HANDLER has no exception.

Method IS_PRODUCTIVE_VERSION_REEXEC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSGID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20050323
2	Importing	PID	Call by reference	☐	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20050323
3	Returning	RET	Value transfer	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20050323
4	Importing	START_VERS	Call by reference	☐	Type reference (TYPE)	SXMSLSQNBR		Einstelliges Kennzeichen	20050323

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20050323

Method RESTART_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DUMP	Call by reference	☑	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20091120
2	Importing	EOIO_FORCE	Call by reference	☐	Type reference (TYPE)	CHAR1	'I'	' '/I/F->no/popup/forced EOIO restart for missing qRFC entry	20051216
3	Importing	MANUAL_RESTART	Call by reference	☐	Type reference (TYPE)	CHAR1	'X'	'X' manual vers <990, otherwise vers <800	20051216
4	Importing	MAN_RESTART_TRACE	Call by reference	☑	Type reference (TYPE)	CHAR1		manual restart with hightest tracelevel	20051216
5	Importing	MESSAGE_GUID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		Integration Engine: Message ID	20051216
6	Importing	PIPELINE_ID	Call by reference	☐	Type reference (TYPE)	SXMSPIDEXT		XMS: External Logical Pipeline ID	20051216
7	Importing	SKIP_XML_VALID	Call by reference	☑	Type reference (TYPE)	SXMS_XMLVAL		restart message without xml validation	20051216
8	Importing	VERSION	Call by reference	☑	Type reference (TYPE)	SXMSLSQNBR		Sequence Number for a Message Log ID	20051216

#	Exception	Resumable	Description	Created on
1	INTERNAL_SYSTEM_ERROR	☐	Internal Error	20051216
2	MESSAGE_ALREADY_SCHEDULED	☐	Message bereits eingeplant	20051216
3	MESSAGE_LOCKED	☐	Message to be restarted is locked	20051216
4	NO_ERROR_STATE	☐	Message not in error status	20051216
5	PERSIST_ERROR	☐	Error accessing persistence layer	20051216
6	PP_ERROR	☐	Fehler beim User-Swirch	20060905
7	QRFC_ENTRY_MISSING_EOIO	☐	qRFC entry of EOIO message missing -> sequence problem	20051216
8	REACTIVATE_QUEUE_ERROR	☐	System error restarting queue &1	20051216
9	RESTART_NOT_POSSIBLE	☐	Restart no longer possible	20051216
10	RESTART_NO_ACTUAL_QUEUE	☐	Restart version does not have current error queue	20051216
11	RESTART_NO_BE	☐	Restart only permitted for asynchronous messages	20051216
12	SCHEDULE_QRFC_ERROR	☐	Error scheduling message in qRFC	20051216
13	TOO_MANY_VERSIONS	☐	es gibt zu viele Versionen (manuell >=990, sonst >= 800)	20051216

History

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