SAP ABAP Class EDX_FILE_UTIL (EDX: File Manipulation)
Hierarchy
☛
SAP_FIN (Software Component) SAP_FIN
⤷
FIN-FSCM (Application Component) Financial Supply Chain Management
⤷
EDX (Package) EDX: Electronic Data Xchange
SAP_FIN (Software Component) SAP_FIN⤷
FIN-FSCM (Application Component) Financial Supply Chain Management⤷
EDX (Package) EDX: Electronic Data XchangeProperties
| Class | EDX_FILE_UTIL | |
| Short Description | EDX: File Manipulation | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | EDX | EDX: Electronic Data Xchange |
| Created | 20091019 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class EDX_FILE_UTIL has no forward declaration.
Interfaces
Class EDX_FILE_UTIL has no interface implemented.
Friends
Class EDX_FILE_UTIL has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_PATH_IN_PROCESS |
Constant | Public | Type reference (TYPE) | STRING | 'inProcess' | Subdirectory in Processing | 20100818 | |
| 2 | C_PATH_TO_PROCESS |
Constant | Public | Type reference (TYPE) | STRING | 'toProcess' | Subdirectory for Processing | 20100818 | |
| 3 | C_PATH_TO_SEND |
Constant | Public | Type reference (TYPE) | STRING | 'toSend' | Subdirectory to be Sent | 20100818 | |
| 4 | C_PATH_WITH_ERROR |
Constant | Public | Type reference (TYPE) | STRING | 'withError' | Subdirectory with Errors | 20100818 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_PATH_NAME |
Instance method | Public | Method | Check Path Name Writing | 20091019 |
| 2 | COPY |
Instance method | Public | Method | Copy File in File System | 20091019 |
| 3 | CREATE_DIRECTORY |
Instance method | Public | Method | Create a Directory and All its Subdirectories | 20091019 |
| 4 | DELETE |
Instance method | Public | Method | Delete File from File System | 20091019 |
| 5 | MOVE |
Instance method | Public | Method | Move File in File System | 20091019 |
| 6 | READ |
Instance method | Public | Method | Read an Xstream from a File | 20091019 |
| 7 | READ_FILENAMES_FROM_DIR |
Instance method | Public | Method | Read Files Names from a Directory | 20091019 |
| 8 | WRITE |
Instance method | Public | Method | Write an Xstream to a File | 20091019 |
Events
Class EDX_FILE_UTIL has no event.
Types
Class EDX_FILE_UTIL has no local type.
Method Signatures
Method CHECK_PATH_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
CH_PATH_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | EDX: Verzeichnisname | 20091019 |
Method CHECK_PATH_NAME on class EDX_FILE_UTIL has no exception.
Method COPY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
E_LENGTH | Call by reference | Type reference (TYPE) | I | File size | 20091019 | ||
| 2 |  Importing |
I_CREATE_DIRECTORY | Call by reference | Type reference (TYPE) | XFELD | Create directory if not exists | 20091022 | ||
| 3 | Importing |
I_DEST_FILE_NAME | Call by reference | Type reference (TYPE) | EDX_FILENAME | Destination file name | 20091019 | ||
| 4 | Importing |
I_DEST_ROOT_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | Main-Destination-Directory | 20091019 | ||
| 5 | Importing |
I_DEST_SUB_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | Sub-Destination-Directory under Main | 20091019 | ||
| 6 | Importing |
I_LOG_FILE_NAME | Call by reference | Type reference (TYPE) | STRING | Check: Directory Traversal | 20101102 | ||
| 7 | Importing |
I_SRC_FILE_NAME | Call by reference | Type reference (TYPE) | EDX_FILENAME | Source file name | 20091019 | ||
| 8 | Importing |
I_SRC_ROOT_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | Main-Source-Directory | 20091019 | ||
| 9 | Importing |
I_SRC_SUB_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | Sub-Source-Directory under Main | 20091019 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CANNOT_CREAT_DIRECTORY |
Kann Zielverzeichnis nicht erstellen | 20091019 | |
| 2 | CANNOT_OPEN_FOR_READING |
Kann die Datei nicht schreiben | 20091019 | |
| 3 | CANNOT_OPEN_FOR_WRITTING |
Kann die Datei nicht lesen | 20091019 | |
| 4 | FILE_ALREADY_BLOCKED |
Datei ist gesperrt | 20091019 | |
| 5 | NOT_ALLOWED_TO_READ |
Keine Berechtigung zum Lesen im Verzeichnis | 20101102 | |
| 6 | NOT_ALLOWED_TO_WRITE |
Keine Berechtigung zum Schreiben im Verzeichnis | 20101102 |
Method CREATE_DIRECTORY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_LOG_FILE_NAME | Call by reference | Type reference (TYPE) | STRING | Check: Directory Traversal | 20101102 | ||
| 2 | Importing |
I_ROOT_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | EDX: Verzeichnisname | 20091019 | ||
| 3 | Importing |
I_SUB_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | EDX: Verzeichnisname | 20091019 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CANNOT_CREATE_DIRECTORY |
Kann Verzeichnis nicht erstellen | 20091019 | |
| 2 | COMMAND_NOT_FOUND |
Kommando nicht gefunden | 20091019 | |
| 3 | ILLEGAL_COMMAND |
Illegales Kommando | 20091019 | |
| 4 | NOT_ALLOWED_TO_WRITE |
Keine Berechtigung zum Schreiben im Verzeichnis | 20101102 | |
| 5 | NO_PERMISSION |
Keine Erlaubnis zum Erstellen eines Verzeichnisses | 20091019 | |
| 6 | PARAMETERS_TOO_LONG |
Paramter sind zu lang | 20091019 | |
| 7 | PARAMETER_EXPECTED |
Parameter erwartet | 20091019 | |
| 8 | TOO_MANY_PARAMETERS |
Zu viele Parameter | 20091019 |
Method DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_FILE_NAME | Call by reference | Type reference (TYPE) | EDX_FILENAME | File name | 20091019 | ||
| 2 | Importing |
I_LOG_FILE_NAME | Call by reference | Type reference (TYPE) | STRING | Check: Directory Traversal | 20101102 | ||
| 3 | Importing |
I_ROOT_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | Main-Directory | 20091019 | ||
| 4 | Importing |
I_SUB_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | Sub-Directory under Main | 20091019 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CANNOT_DELETE_FILE |
Kann die Datei nicht löschen | 20091019 | |
| 2 | FILE_ALREADY_BLOCKED |
Datei ist gesperrt | 20091019 | |
| 3 | NOT_ALLOWED_TO_DELETE |
Keine Berechtigung zum Löschen im Verzeichnis | 20101102 |
Method MOVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
E_LENGTH | Call by reference | Type reference (TYPE) | I | File size | 20091019 | ||
| 2 | Exporting |
E_XSTREAM | Call by reference | Type reference (TYPE) | XSTRING | File content | 20091019 | ||
| 3 | Importing |
I_CREATE_DIRECTORY | Call by reference | Type reference (TYPE) | XFELD | Create directory if not exists | 20091022 | ||
| 4 | Importing |
I_DEST_FILE_NAME | Call by reference | Type reference (TYPE) | EDX_FILENAME | Destination file name | 20091019 | ||
| 5 | Importing |
I_DEST_ROOT_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | Main-Destination-Directory | 20091019 | ||
| 6 | Importing |
I_DEST_SUB_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | Sub-Destination-Directory under Main | 20091019 | ||
| 7 | Importing |
I_LOG_FILE_NAME | Call by reference | Type reference (TYPE) | STRING | Check: Directory Traversal | 20101102 | ||
| 8 | Importing |
I_SRC_FILE_NAME | Call by reference | Type reference (TYPE) | EDX_FILENAME | Source file name | 20091019 | ||
| 9 | Importing |
I_SRC_ROOT_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | Main-Source-Directory | 20091019 | ||
| 10 | Importing |
I_SRC_SUB_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | Sub-Source-Directory under Main | 20091019 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CANNOT_CREATE_DIRECTORY |
Kann Zielverzeichnis nicht erstellen | 20091019 | |
| 2 | CANNOT_DELETE_SOURCE_FILE |
Kann die Quelldatei nicht löschen | 20091019 | |
| 3 | CANNOT_OPEN_FOR_READING |
Kann Quelldatei zum Lesen nicht öffnen | 20091019 | |
| 4 | CANNOT_OPEN_FOR_WRITTING |
Kann Datei nicht verschieben | 20091019 | |
| 5 | FILE_ALREADY_BLOCKED |
Datei ist gesperrt | 20091019 | |
| 6 | NOT_ALLOWED_TO_READ |
Keine Berechtigung zum Lesen im Verzeichnis | 20101102 | |
| 7 | NOT_ALLOWED_TO_WRITE |
Keine Berechtigung zum Schreiben im Verzeichnis | 20101102 |
Method READ Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
E_LENGTH | Call by reference | Type reference (TYPE) | I | Length of E_XSTREAM | 20091019 | ||
| 2 | Exporting |
E_XSTREAM | Call by reference | Type reference (TYPE) | XSTRING | File content | 20091019 | ||
| 3 | Importing |
I_FILE_NAME | Call by reference | Type reference (TYPE) | EDX_FILENAME | File name | 20091019 | ||
| 4 | Importing |
I_LOG_FILE_NAME | Call by reference | Type reference (TYPE) | STRING | Check: Directory Traversal | 20101102 | ||
| 5 | Importing |
I_ROOT_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | Main-Directory | 20091019 | ||
| 6 | Importing |
I_SUB_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | Sub-Directory under Main | 20091019 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CANNOT_OPEN_FOR_READING |
Datei kann zum Lesen nicht geöffnet werden | 20091019 | |
| 2 | FILE_ALREADY_BLOCKED |
Datei ist gesperrt | 20091019 | |
| 3 | NOT_ALLOWED_TO_READ |
Keine Berechtigung zum Lesen im Verzeichnis | 20101102 |
Method READ_FILENAMES_FROM_DIR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
E_FILE_LIST | Call by reference | Type reference (TYPE) | ANY TABLE | 20091019 | |||
| 2 | Exporting |
E_NO_OF_FILES | Call by reference | Type reference (TYPE) | I | Anzahl gefundene Dateien | 20091019 | ||
| 3 | Importing |
I_CREATE_DIRECTORY | Call by reference | Type reference (TYPE) | XFLAG | Verzeichnis erzeugen? | 20101129 | ||
| 4 | Importing |
I_FILTER | Call by reference | Type reference (TYPE) | EDX_FILE_FILTER | EDX: Filter zur Dateisuche | 20091019 | ||
| 5 | Importing |
I_LOG_FILE_NAME | Call by reference | Type reference (TYPE) | STRING | Check: Directory Traversal | 20101102 | ||
| 6 | Importing |
I_ROOT_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | EDX: Verzeichnisname | 20091019 | ||
| 7 | Importing |
I_SUB_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | EDX: Verzeichnisname | 20091019 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CANNOT_CREATE_DIRECTORY |
Kann Verzeichnis nicht erstellen | 20101129 | |
| 2 | CANNOT_READ_DIRECTORY |
Kann Verzeichnis nicht auslesen | 20091019 | |
| 3 | COMMAND_NOT_FOUND |
Kommando nicht gefunden | 20091019 | |
| 4 | EXT_COMMAND_FAILED |
Externes Kommando mit Fehler beendet | 20091019 | |
| 5 | ILLEGAL_COMMAND |
Illegales Kommando | 20091019 | |
| 6 | NOT_ALLOWED_TO_READ |
Keine Berechtigung zum Lesen im Verzeichnis | 20101102 | |
| 7 | NO_PERMISSION |
Keine Erlaubnis zum Erstellen eines Verzeichnisses | 20091019 | |
| 8 | PARAMETERS_TOO_LONG |
Paramter sind zu lang | 20091019 | |
| 9 | PARAMETER_EXPECTED |
Parameter erwartet | 20091019 | |
| 10 | TOO_MANY_PARAMETERS |
Zu viele Parameter | 20091019 |
Method WRITE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_CREATE_DIRECTORY | Call by reference | Type reference (TYPE) | XFELD | Create directory if not exists | 20091022 | ||
| 2 | Importing |
I_FILE_NAME | Call by reference | Type reference (TYPE) | EDX_FILENAME | File name | 20091019 | ||
| 3 | Importing |
I_LOG_FILE_NAME | Call by reference | Type reference (TYPE) | STRING | Check: Directory Traversal | 20101102 | ||
| 4 | Importing |
I_ROOT_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | Main-Directory | 20091019 | ||
| 5 | Importing |
I_SUB_DIR_NAME | Call by reference | Type reference (TYPE) | EDX_DIRECTORY_NAME | Sub-Directory under Main | 20091019 | ||
| 6 | Importing |
I_XSTREAM | Call by reference | Type reference (TYPE) | XSTRING | File content | 20091019 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CANNOT_CREATE_DIRECTORY |
Kann Zielverzeichnis nicht erstellen | 20091019 | |
| 2 | CANNOT_OPEN_FILE_FOR_WRITING |
Kann Datei nicht ins Dateisystem schreiben | 20091019 | |
| 3 | FILE_ALREADY_BLOCKED |
Datei ist gesperrt | 20091019 | |
| 4 | NOT_ALLOWED_TO_WRITE |
Keine Berechtigung zum Schreiben im Verzeichnis | 20101102 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 605 |
