SAP ABAP Class CL_GRPC_DOCU_DOWNLOAD_CTRL (Controller Class for FOPC_DOCU_DOWNL)
Hierarchy
☛
GRCFND_A (Software Component) GRC Foundation ABAP
⤷ GRC-SPC (Application Component) Process Controls
⤷ GRPC_DOCUMENTS (Package) Documents
⤷ GRC-SPC (Application Component) Process Controls
⤷ GRPC_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 | 20070611 |
Properties
Class | CL_GRPC_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 | GRPCD | |
Program status | ||
Category | 0 | |
Package | GRPC_DOCUMENTS | Documents |
Created | 20070611 | SAP |
Last change | 20141106 | |
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 | GRPCD | 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_GRPC_DOCU_DOWNLOAD_CTRL has no interface implemented.
Friends
Class CL_GRPC_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 | 20070611 | |
2 | C_APPL_OBJ_OBJTYPE_PARAM_NAME | Constant | Public | Type reference (TYPE) | STRING | 'object-type' | Parameter Name | 20070611 | |
3 | C_APPL_OBJ_TASKID_PARAM_NAME | Constant | Public | Type reference (TYPE) | STRING | 'task-id' | Parameter Name | 20070611 | |
4 | C_COMPRESSION_DEFAULT_LEVEL | Constant | Public | Type reference (TYPE) | I | 6 | Default Own Compression Level, Basis < 640 | 20070611 | |
5 | C_COMPRESSION_MINIMAL_RATIO | Constant | Public | Type reference (TYPE) | I | 80 | Minimal Required Ratio (in %) for Own Compression | 20070611 | |
6 | C_CONT_DISP_ATTACH_PARAM_NAME | Constant | Public | Type reference (TYPE) | STRING | 'attachment-disposition' | Parameter Name | 20070611 | |
7 | C_DOC_CLASS_PARAM_NAME | Constant | Public | Type reference (TYPE) | STRING | 'docClass' | Parameter Name | 20070611 | |
8 | C_DOC_COMPONENT_PARAM_NAME | Constant | Public | Type reference (TYPE) | STRING | 'compId' | Parameter Name | 20070611 | |
9 | C_DOC_GUID_PARAM_NAME | Constant | Public | Type reference (TYPE) | STRING | 'docId' | Parameter Name | 20070611 | |
10 | C_DOC_TICKET_PARAM_NAME | Constant | Public | Type reference (TYPE) | STRING | 'auth-ticket' | Parameter Name | 20070611 | |
11 | C_FEXTENSION_VARIABLE_NAME | Constant | Public | Type reference (TYPE) | STRING | ':&ext' | Variable Name for File Extension | 20070611 | |
12 | C_FNAME_VARIABLE_NAME | Constant | Public | Type reference (TYPE) | STRING | ':&name' | Variable Name for File Name | 20070611 | |
13 | C_MAX_TIMESTAMP | Constant | Public | Type reference (TYPE) | TIMESTAMP | '99991231235959' | Maximum Timestamp | 20070611 | |
14 | C_MIN_TIMESTAMP | Constant | Public | Type reference (TYPE) | TIMESTAMP | '00000101000000' | Minimum Timestamp | 20070611 | |
15 | C_TICKET_ANY_USER | Constant | Public | Type reference (TYPE) | SY-UNAME | '*' | Value Representing Any User | 20070611 | |
16 | C_TICKET_DEFAULT_VALIDITY | Constant | Public | Type reference (TYPE) | INT4 | 7200 | Default Validity of Ticket in Seconds | 20070611 | |
17 | C_TICKET_RETRIES | Constant | Public | Type reference (TYPE) | INT4 | 10 | # of Retries to Get Ticket | 20070611 | |
18 | C_TICKET_REUSE_UPDATE_STEP | Constant | Public | Type reference (TYPE) | INT4 | 600 | DB Update Rate of Reused Tickets in Seconds | 20070611 | |
19 | C_TICKET_WAIT_TIME | Constant | Public | Type reference (TYPE) | INT4 | 10 | Wait Time If Ticket Is Currently Locked | 20070611 | |
20 | DOWNLOAD_TICKET_LOCKED | Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | 20070611 | |||
21 | _COMPRESSION_OWN | Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Use Own Compression Instead of Automat. Response Compression | 20070611 |
Methods
Events
Class CL_GRPC_DOCU_DOWNLOAD_CTRL has no event.
Types
Class CL_GRPC_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) | GRPC_DOC_TICKETS | Permission to Download the Document | 20070611 | ||
2 | Exporting | ES_KPRO_DOCUMENT | Value transfer | Type reference (TYPE) | SKWF_IO | Indicator (X or Blank) | 20070611 | ||
3 | Importing | IS_APPL_OBJ_KEY | Call by reference | Type reference (TYPE) | GRPCD_APPLICATION_OBJECT_KEY | 20070611 | |||
4 | Importing | I_TICKET_GUID | Call by reference | Type reference (TYPE) | GRPC_DOC_TICKETS-TICKET_GUID | Permission to Download the Document | 20070611 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_GRPC_DOCUMENTS | 20070611 |
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) | GRPC_DOC_TICKETS | Permission to Download the Document | 20070611 | ||
2 | Importing | IS_PHIO | Call by reference | Type reference (TYPE) | SKWF_IO | KW Framework: Object Key | 20070611 | ||
3 | Importing | I_GENERATE_DEFAULTS | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Fill not specified properties with default values | 20070611 | |
4 | Importing | I_PREFER_VALIDITY_THEN_COUNTER | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20070611 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_GRPC_DOCUMENTS | 20070611 |
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 | 20070611 | ||
2 | Importing | I_TICKET_GUID | Call by reference | Type reference (TYPE) | GRPC_DOC_TICKETS-TICKET_GUID | GUID in 'CHAR' Format in Upper Case | 20070611 |
Method DEQUEUE_TICKET on class CL_GRPC_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 | 20070611 | ||
2 | Importing | I_TICKET_GUID | Call by reference | Type reference (TYPE) | GRPC_DOC_TICKETS-TICKET_GUID | GUID in 'CHAR' Format in Upper Case | 20070611 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_GRPC_DOCUMENTS | 20070611 |
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) | GRPCD_APPLICATION_OBJECT_KEY | MIC Application Object Key | 20070611 | ||
2 | Importing | IS_PHIO_KEY | Call by reference | Type reference (TYPE) | SKWF_IO | KW Framework: Object Key | 20070611 | ||
3 | Importing | I_COMPONENT_ID | Call by reference | Type reference (TYPE) | SDOK_FILNM | Relative Storage Location of Physical Document | 20070611 | ||
4 | Importing | I_CONT_DISP_AS_ATTACHMENT | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Use 'Attachment' Instead of 'Inline' in Content Disposition | 20070611 | |
5 | Importing | I_USE_RELATIVE_URL | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20070611 | |||
6 | Importing | I_WITH_CLIENT | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20070611 | ||
7 | Importing | I_WITH_LANGUAGE | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20070611 | ||
8 | Returning | R_URL | Value transfer | Type reference (TYPE) | STRING | 20070611 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_GRPC_DOCUMENTS | 20070611 |
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 of BSP Application | 20070611 | ||
2 | Importing | I_PAGEKEY | Call by reference | Type reference (TYPE) | O2PAGKEY-PAGEKEY | Internal Name (Key) of BSP Page | 20070611 | ||
3 | Importing | I_WITH_CLIENT | Value transfer | Type reference (TYPE) | SEU_BOOL | ABAP_TRUE | Boolean | 20070611 | |
4 | Returning | R_URL | Value transfer | Type reference (TYPE) | STRING | 20070611 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_GRPC_DOCUMENTS | 20070611 |
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 | 20070611 | |
2 | Importing | I_PHIO_CLASS | Call by reference | Type reference (TYPE) | SKWF_IO-CLASS | Document Class | 20070611 | ||
3 | Returning | RS_DOWNLOAD_CFG | Value transfer | Type reference (TYPE) | GRPCDOCDOWNLCFG | Alternate MIC Downloader Configuration | 20070611 |
Method GET_DOWNLOADER_CONFIGURATION on class CL_GRPC_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 | 20070611 | |||
2 | Returning | R_VALUE | Value transfer | Type reference (TYPE) | STRING | 20070611 |
Method GET_REQUEST_PARAMETER on class CL_GRPC_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 | 20070611 | |||
2 | Importing | I_ORIGINAL_FILE_NAME | Call by reference | Type reference (TYPE) | STRING | 20070611 | |||
3 | Returning | R_NEW_FILENAME | Value transfer | Type reference (TYPE) | STRING | 20070611 |
Method MIX_ASTERIKS_FILENAME on class CL_GRPC_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 | 20070611 | ||
2 | Importing | I_TICKET_GUID | Call by reference | Type reference (TYPE) | GRPC_DOC_TICKETS-TICKET_GUID | Permission to Download the Document | 20070611 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_GRPC_DOCUMENTS | 20070611 |
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_GRPC_DOCUMENTS | Document Subsystem Exception | 20070611 | ||
2 | Importing | IS_RESPONSE_DATA | Call by reference | Type reference (TYPE) | YS_RESPONSE_DATA | 20070611 |
Method WRITE_ERROR_TO_APPL_LOG on class CL_GRPC_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) | GRPC_DOC_TICKETS | Permission to Download the Document | 20070611 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_GRPC_DOCUMENTS | 20070611 |
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) | GRPCD_T_KPRO_PHIO_CONTENT | 20070611 | |||
2 | Exporting | ET_PROPERTIES | Call by reference | Type reference (TYPE) | SDOKPROPTYS | SDOK: List of Pairs of Name and Value | 20070611 | ||
3 | Importing | IS_RESPONSE_DATA | Call by reference | Type reference (TYPE) | YS_RESPONSE_DATA | 20070611 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_GRPC_DOCUMENTS | 20070611 |
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) | GRPCD_S_KPRO_PHIO_CONTENT | 20070611 | |||
2 | Importing | IT_PROPERTIES | Call by reference | Type reference (TYPE) | SDOKPROPTYS | SDOK: List of Pairs of Name and Value | 20070611 | ||
3 | Returning | RS_HTTP_X_FIELDS | Value transfer | Type reference (TYPE) | YS_HTTP_HEADER_X_FIELDS | 20070611 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_GRPC_DOCUMENTS | 20070611 |
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 | 20070611 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_GRPC_DOCUMENTS | 20070611 |
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 | 20070611 | |||
2 | Importing | IT_CONTENT | Call by reference | Type reference (TYPE) | GRPCD_T_KPRO_PHIO_CONTENT | 20070611 | |||
3 | Importing | IT_PROPERTIES | Call by reference | Type reference (TYPE) | SDOKPROPTYS | SDOK: List of Pairs of Name and Value | 20070611 | ||
4 | Importing | I_SEND_X_FIELDS | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20070611 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_GRPC_DOCUMENTS | 20070611 |
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 | 20070611 | |||
2 | Importing | I_MSG_STR_LONG | Call by reference | Type reference (TYPE) | STRING | 20070611 |
Method _WRITE_ERROR_HTML on class CL_GRPC_DOCU_DOWNLOAD_CTRL has no exception.
History
Last changed by/on | SAP | 20141106 |
SAP Release Created in | 250 |