SAP ABAP Class CL_FOPC_DOCU_DOWNLOAD_CTRL (Controller Class for FOPC_DOCU_DOWNL)

Hierarchy

☛ FINBASIS (Software Component) Fin. Basis
   ⤷ FIN-CGV-MIC (Application Component) Management of Internal Controls
     ⤷ FOPC_DOCUMENTS (Package) Documents

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BSP_CONTROLLER2	BSP Component	20040310

Properties

Class	CL_FOPC_DOCU_DOWNLOAD_CTRL
Short Description	Controller Class for FOPC_DOCU_DOWNL
Super Class	CL_BSP_CONTROLLER2	BSP Component
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class	FOPCD
Program status
Category	0
Package	FOPC_DOCUMENTS	Documents
Created	20040310	SAP
Last change	20050428	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	FOPCD	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	SKWFC	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_FOPC_DOCU_DOWNLOAD_CTRL has no interface implemented.

Friends

Class CL_FOPC_DOCU_DOWNLOAD_CTRL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_APPL_OBJ_OBJID_PARAM_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'object-id'	Parameter Name	20040310
2	C_APPL_OBJ_OBJTYPE_PARAM_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'object-type'	Parameter Name	20040310
3	C_APPL_OBJ_TASKID_PARAM_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'task-id'	Parameter Name	20040310
4	C_COMPRESSION_DEFAULT_LEVEL	Constant	Public	☐	Type reference (TYPE)	I	6	Default Own Compression Level, Basis < 640	20050414
5	C_COMPRESSION_MINIMAL_RATIO	Constant	Public	☐	Type reference (TYPE)	I	80	Minimal Required Ratio (in %) for Own Compression	20050414
6	C_CONT_DISP_ATTACH_PARAM_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'attachment-disposition'	Parameter Name	20050401
7	C_DOC_CLASS_PARAM_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'docClass'	Parameter Name	20040310
8	C_DOC_COMPONENT_PARAM_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'compId'	Parameter Name	20050401
9	C_DOC_GUID_PARAM_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'docId'	Parameter Name	20040310
10	C_DOC_TICKET_PARAM_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'auth-ticket'	Parameter Name	20040310
11	C_FEXTENSION_VARIABLE_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	':&ext'	Variable Name for File Extension	20050407
12	C_FNAME_VARIABLE_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	':&name'	Variable Name for File Name	20050407
13	C_MAX_TIMESTAMP	Constant	Public	☐	Type reference (TYPE)	TIMESTAMP	'99991231235959'	Maximum Timestamp	20050412
14	C_MIN_TIMESTAMP	Constant	Public	☐	Type reference (TYPE)	TIMESTAMP	'00000101000000'	Minimum Timestamp	20050412
15	C_TICKET_ANY_USER	Constant	Public	☐	Type reference (TYPE)	SY-UNAME	'*'	Value Representing Any User	20050407
16	C_TICKET_DEFAULT_VALIDITY	Constant	Public	☐	Type reference (TYPE)	INT4	7200	Default Validity of Ticket in Seconds	20050407
17	C_TICKET_RETRIES	Constant	Public	☐	Type reference (TYPE)	INT4	10	# of Retries to Get Ticket	20050407
18	C_TICKET_REUSE_UPDATE_STEP	Constant	Public	☐	Type reference (TYPE)	INT4	600	DB Update Rate of Reused Tickets in Seconds	20050412
19	C_TICKET_WAIT_TIME	Constant	Public	☐	Type reference (TYPE)	INT4	10	Wait Time If Ticket Is Currently Locked	20050407
20	DOWNLOAD_TICKET_LOCKED	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20050407
21	_COMPRESSION_OWN	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Use Own Compression Instead of Automat. Response Compression	20050414

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_DOWNLOAD_TICKET	Instance method	Private	Method	Checks validity download ticket	20040310
2	CREATE_DOWNLOAD_TICKET	Static method	Public	Method	Stores download ticket for document to ticket table	20040310
3	DEQUEUE_TICKET	Static method	Public	Method		20050407
4	ENQUEUE_TICKET	Static method	Public	Method		20050407
5	GENERATE_DOCUMENT_DOWNLOAD_URL	Static method	Public	Method	Generates URL for downloadinmg specified document	20040310
6	GET_BSP_PAGE_URL	Static method	Public	Method		20050404
7	GET_DOWNLOADER_CONFIGURATION	Static method	Public	Method	Returns Customized Configuration for Given Document Class	20050401
8	GET_REQUEST_PARAMETER	Instance method	Private	Method	Retrieves paramater value from current request	20040310
9	MIX_ASTERIKS_FILENAME	Static method	Public	Method		20050407
10	RELEASE_DOWNLOAD_TICKET	Instance method	Private	Method	Checks validity download ticket	20050407
11	WRITE_ERROR_TO_APPL_LOG	Static method	Private	Method		20050407
12	_FIND_EXISTING_TICKET	Static method	Private	Method	Stores download ticket for document to ticket table	20050412
13	_GET_DOCUMENT_CONTENT	Instance method	Private	Method		20050407
14	_GET_X_FIELDS_VALUES	Instance method	Private	Method		20050407
15	_PARSE_REQUEST_PARAMS	Instance method	Private	Method		20050407
16	_SEND_RESPONSE	Instance method	Private	Method		20050407
17	_WRITE_ERROR_HTML	Instance method	Private	Method	Writes HTML Response Containing Error Message Specified	20040405

Events

Class CL_FOPC_DOCU_DOWNLOAD_CTRL has no event.

Types

Class CL_FOPC_DOCU_DOWNLOAD_CTRL has no local type.

Method Signatures

Method CHECK_DOWNLOAD_TICKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_DOCUMENT_TICKET	Value transfer	☐	Type reference (TYPE)	FOPC_DOC_TICKETS		Erlaubnis zum Herunterladen des Dokuments	20050407
2	Exporting	ES_KPRO_DOCUMENT	Value transfer	☐	Type reference (TYPE)	SKWF_IO		Flag (X oder Blank)	20050407
3	Importing	IS_APPL_OBJ_KEY	Call by reference	☐	Type reference (TYPE)	FOPCD_APPLICATION_OBJECT_KEY			20040310
4	Importing	I_TICKET_GUID	Call by reference	☐	Type reference (TYPE)	FOPC_DOC_TICKETS-TICKET_GUID		Erlaubnis zum Herunterladen des Dokuments	20040312

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20040310

Method CREATE_DOWNLOAD_TICKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_TICKET	Call by reference	☐	Type reference (TYPE)	FOPC_DOC_TICKETS		Erlaubnis zum Herunterladen des Dokuments	20040310
2	Importing	IS_PHIO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20040310
3	Importing	I_GENERATE_DEFAULTS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Fill not specified properties with default values	20040310
4	Importing	I_PREFER_VALIDITY_THEN_COUNTER	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20050407

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20040310

Method DEQUEUE_TICKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COLLECT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20050407
2	Importing	I_TICKET_GUID	Call by reference	☐	Type reference (TYPE)	FOPC_DOC_TICKETS-TICKET_GUID		GUID im 'CHAR' Format in Großschreibung	20050407

Method DEQUEUE_TICKET on class CL_FOPC_DOCU_DOWNLOAD_CTRL has no exception.

Method ENQUEUE_TICKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COLLECT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20050407
2	Importing	I_TICKET_GUID	Call by reference	☐	Type reference (TYPE)	FOPC_DOC_TICKETS-TICKET_GUID		GUID im 'CHAR' Format in Großschreibung	20050407

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20050407

Method GENERATE_DOCUMENT_DOWNLOAD_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_APPL_OBJ_KEY	Call by reference	☐	Type reference (TYPE)	FOPCD_APPLICATION_OBJECT_KEY		MIC Application Object Key	20040310
2	Importing	IS_PHIO_KEY	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20040310
3	Importing	I_COMPONENT_ID	Call by reference	☑	Type reference (TYPE)	SDOK_FILNM		Relativer Ablageort eines physischen Dokuments	20050401
4	Importing	I_CONT_DISP_AS_ATTACHMENT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Use 'attachment' instead of 'inline' in content-disposition	20050401
5	Importing	I_USE_RELATIVE_URL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20050404
6	Importing	I_WITH_CLIENT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20050406
7	Importing	I_WITH_LANGUAGE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20050406
8	Returning	R_URL	Value transfer	☐	Type reference (TYPE)	STRING			20040310

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20050404

Method GET_BSP_PAGE_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPLNAME	Call by reference	☐	Type reference (TYPE)	O2PAGKEY-APPLNAME		Name einer BSP-Applikation	20050404
2	Importing	I_PAGEKEY	Call by reference	☐	Type reference (TYPE)	O2PAGKEY-PAGEKEY		Interner Name (Schlüssel) einer BSP-Seite	20050404
3	Importing	I_WITH_CLIENT	Value transfer	☐	Type reference (TYPE)	SEU_BOOL	ABAP_TRUE	Boolean	20050404
4	Returning	R_URL	Value transfer	☐	Type reference (TYPE)	STRING			20050404

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20050404

Method GET_DOWNLOADER_CONFIGURATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ONLY_IF_ACTIVE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Ignore if configuration is disabled	20050401
2	Importing	I_PHIO_CLASS	Call by reference	☐	Type reference (TYPE)	SKWF_IO-CLASS		Dokumentenklasse	20050401
3	Returning	RS_DOWNLOAD_CFG	Value transfer	☐	Type reference (TYPE)	FOPCDOCDOWNLCFG		Alternate MIC downloader configuration	20050401

Method GET_DOWNLOADER_CONFIGURATION on class CL_FOPC_DOCU_DOWNLOAD_CTRL has no exception.

Method GET_REQUEST_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20040310
2	Returning	R_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20040310

Method GET_REQUEST_PARAMETER on class CL_FOPC_DOCU_DOWNLOAD_CTRL has no exception.

Method MIX_ASTERIKS_FILENAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ASTERIKS_PATTERN	Call by reference	☐	Type reference (TYPE)	STRING			20050407
2	Importing	I_ORIGINAL_FILE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20050407
3	Returning	R_NEW_FILENAME	Value transfer	☐	Type reference (TYPE)	STRING			20050407

Method MIX_ASTERIKS_FILENAME on class CL_FOPC_DOCU_DOWNLOAD_CTRL has no exception.

Method RELEASE_DOWNLOAD_TICKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COUNTER_INCREMENT	Value transfer	☐	Type reference (TYPE)	I	1		20050407
2	Importing	I_TICKET_GUID	Call by reference	☐	Type reference (TYPE)	FOPC_DOC_TICKETS-TICKET_GUID		Erlaubnis zum Herunterladen des Dokuments	20050407

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20050407

Method WRITE_ERROR_TO_APPL_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_DOC_EX	Call by reference	☐	Object reference (TYPE REF TO)	CX_FOPC_DOCUMENTS		Document Subsystem Exception	20050407
2	Importing	IS_RESPONSE_DATA	Call by reference	☐	Type reference (TYPE)	YS_RESPONSE_DATA			20050407

Method WRITE_ERROR_TO_APPL_LOG on class CL_FOPC_DOCU_DOWNLOAD_CTRL has no exception.

Method _FIND_EXISTING_TICKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_TICKET	Call by reference	☐	Type reference (TYPE)	FOPC_DOC_TICKETS		Erlaubnis zum Herunterladen des Dokuments	20050412

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20050412

Method _GET_DOCUMENT_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CONTENT	Call by reference	☐	Type reference (TYPE)	FOPCD_T_KPRO_PHIO_CONTENT			20050407
2	Exporting	ET_PROPERTIES	Call by reference	☐	Type reference (TYPE)	SDOKPROPTYS		SDOK: Liste von Name-Wert-Paaren	20050407
3	Importing	IS_RESPONSE_DATA	Call by reference	☐	Type reference (TYPE)	YS_RESPONSE_DATA			20050407

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20050407

Method _GET_X_FIELDS_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CONTENT	Call by reference	☐	Type reference (TYPE)	FOPCD_S_KPRO_PHIO_CONTENT			20050407
2	Importing	IT_PROPERTIES	Call by reference	☐	Type reference (TYPE)	SDOKPROPTYS		SDOK: Liste von Name-Wert-Paaren	20050407
3	Returning	RS_HTTP_X_FIELDS	Value transfer	☐	Type reference (TYPE)	YS_HTTP_HEADER_X_FIELDS			20050407

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20050407

Method _PARSE_REQUEST_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_RESPONSE_INFO	Value transfer	☐	Type reference (TYPE)	YS_RESPONSE_DATA			20050407

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20050407

Method _SEND_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_RESPONSE_DATA	Call by reference	☐	Type reference (TYPE)	YS_RESPONSE_DATA			20050407
2	Importing	IT_CONTENT	Call by reference	☐	Type reference (TYPE)	FOPCD_T_KPRO_PHIO_CONTENT			20050407
3	Importing	IT_PROPERTIES	Call by reference	☐	Type reference (TYPE)	SDOKPROPTYS		SDOK: Liste von Name-Wert-Paaren	20050407
4	Importing	I_SEND_X_FIELDS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20050407

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20050407

Method _WRITE_ERROR_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MSG_STR	Call by reference	☐	Type reference (TYPE)	STRING			20040405
2	Importing	I_MSG_STR_LONG	Call by reference	☑	Type reference (TYPE)	STRING			20050407

Method _WRITE_ERROR_HTML on class CL_FOPC_DOCU_DOWNLOAD_CTRL has no exception.

History

Last changed by/on	SAP	20050428
SAP Release Created in	100