com.basecmp.core.util
Class FileUtils

java.lang.Object
  com.basecmp.core.util.FileUtils

public class FileUtils

extends java.lang.Object

Author:

Michael Meissner TODO: mmeissner - Klasse dokumentieren

Field Summary

static long

DEFAULT_VALUE_UPLOAD_TIMEOUT Timeout, nach dem alte Upload-Files gelöscht werden (1000ms * 60 * 30 = 30 Minuten).

Constructor Summary

FileUtils()

Method Summary

static boolean	copy(java.lang.String source, java.lang.String target) Kopiert die unter source angegebene Datei nach target und liefert bei Erfolg true, sonst false.
static boolean	createNewFile(java.io.File file) Erzeugt das übergebene, abstrakte File-Object (existiert noch nicht physikalisch) mittels file.createNewFile() als konkretes File-Object.
static java.io.File	createNewFile(java.io.File file, boolean createNumberedAlternativeName) Erzeugt das übergebene, abstrakte File-Object (existiert noch nicht physikalisch) mittels file.createNewFile() als konkretes File-Object.
static boolean	deleteDirectory(java.lang.String dirPath)
static boolean	deleteFile(java.lang.String filePath) Löscht die angegebene Datei, soweit vorhanden (Name inkl Pfad) und liefert bei Erfolg true, sonst false.
static boolean	deleteOldUploadFiles() Löscht in dem Upload-Verzeichnis alle Dateien, die älter sind als der in DEFAULT_VALUE_UPLOAD_TIMEOUT definierte Timeout.
static java.lang.String	getConfigPath(java.lang.String pathPropertyName) Liefert den physikalischen, absoluten Pfad zu einer definierten Pfad-Konfig-Variablen.
static java.util.Map	getDirectorynameMap(java.io.File directory) Liefert ein Map-Objekt (Entries identisch mit Keys) mit allen Verzeichnisnamen des angegebeben Verzeichnisses.
static java.util.Map	getFilenameMap(java.io.File directory) Liefert ein Map-Objekt (Entries identisch mit Keys) mit allen Dateinamen des angegebeben Verzeichnisses.
static java.lang.String	getFileNameWithoutSuffix(java.io.File file) Liefert den Dateiname ohne die Dateiendung (ohne den nachfolgenden Punkt) für ein File-Object.
static java.lang.String	getFileSuffix(java.io.File file) Liefert die Dateiendung (ohne den Punkt davor) für ein File-Object.
static java.lang.String	getLiveConfigPath(java.lang.String pathPropertyName) Liefert den physikalischen, absoluten Pfad zu einer definierten Pfad-Konfig-Variablen auf dem Live-Server.
static java.util.Collection	listDirectories(java.io.File directory) Liefert eine Collection von allen Verzeichnissen unterhalb des angegebenen Verzeichnisses.
static java.lang.String	parseASCIIFileName(java.io.File file) Liefert für ein File-Object einen Filenamen (ohne Pfad), der keine Sonderzeichen oder Leerzeichen enthält.
static java.lang.String	parseASCIIFileName(java.lang.String filename) Konvertiert einen String-Filenamen (ohne Pfad) in einen Name, der keine Sonderzeichen oder Leerzeichen enthält.
static boolean	rename(java.lang.String path, java.lang.String oldFilename, java.lang.String newFilename) Benennt eine Datei (oldFilename) mit dem angegebenen, gemeinsamen Pfad in den neuen Namen (newFilename) um und liefert bei Erfolg true, sonst false.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_VALUE_UPLOAD_TIMEOUT

public static final long DEFAULT_VALUE_UPLOAD_TIMEOUT

Timeout, nach dem alte Upload-Files gelöscht werden (1000ms * 60 * 30 = 30 Minuten).

See Also:

Constant Field Values

Constructor Detail

FileUtils

public FileUtils()

Method Detail

copy

public static boolean copy(java.lang.String source,
                           java.lang.String target)

Kopiert die unter source angegebene Datei nach target und liefert bei Erfolg true, sonst false. Ist unter target ein anderer Dateiname angegeben, wird die Datei faktisch gleichzeitig umbenannt.

Parameters:

source -

target -

Returns:

createNewFile

public static boolean createNewFile(java.io.File file)

Erzeugt das übergebene, abstrakte File-Object (existiert noch nicht physikalisch) mittels file.createNewFile() als konkretes File-Object. Diese Hilfsfunktion fängt lediglich die IOException von File.createNewFile() ab und legt ggf den Pfad an, falls dieser nicht existiert.

Returns:

Liefert true, wenn das File-Object erzeugt werden konnte, sonst false.

createNewFile

public static java.io.File createNewFile(java.io.File file,
                                         boolean createNumberedAlternativeName)

Erzeugt das übergebene, abstrakte File-Object (existiert noch nicht physikalisch) mittels file.createNewFile() als konkretes File-Object. Wenn createNumberedAlternativeName=true gesetzt ist, wird im Falle eines Namenkonflikts versucht einen durchnummerierten Dateinamen mit dem Basisnamen als prefix zu finden. Legt ggf den Pfad an, falls dieser nicht existiert.

Returns:

Liefert erzeugte File-Object , sonst null

deleteDirectory

public static boolean deleteDirectory(java.lang.String dirPath)

deleteFile

public static boolean deleteFile(java.lang.String filePath)

Löscht die angegebene Datei, soweit vorhanden (Name inkl Pfad) und liefert bei Erfolg true, sonst false. Liefert ebenfalls true, wenn die Datei nicht existiert!

deleteOldUploadFiles

public static boolean deleteOldUploadFiles()
                                    throws java.lang.Exception

Löscht in dem Upload-Verzeichnis alle Dateien, die älter sind als der in DEFAULT_VALUE_UPLOAD_TIMEOUT definierte Timeout.

Returns:

liefert true, wenn alle Dateien gelöscht werden konnten, die älter als der Timeout sind, sont false.

Throws:

java.lang.Exception

getConfigPath

public static java.lang.String getConfigPath(java.lang.String pathPropertyName)

Liefert den physikalischen, absoluten Pfad zu einer definierten Pfad-Konfig-Variablen. Erkennt, ob es sich um einen relativen Pfad handelt und stellt in diesem Fall den Pfad unter der Konfig-Variablen "server.path.physical.webapp" dem angeforderten Wert voran. /ws

getDirectorynameMap

public static java.util.Map getDirectorynameMap(java.io.File directory)

Liefert ein Map-Objekt (Entries identisch mit Keys) mit allen Verzeichnisnamen des angegebeben Verzeichnisses. Liefert eine leere Map, wenn das Verzeichnis leer ist oder es sich um kein Verzeichnis handelt.

getFilenameMap

public static java.util.Map getFilenameMap(java.io.File directory)

Liefert ein Map-Objekt (Entries identisch mit Keys) mit allen Dateinamen des angegebeben Verzeichnisses. Liefert eine leere Map, wenn das Verzeichnis leer ist oder es sich um kein Verzeichnis handelt.

getFileNameWithoutSuffix

public static java.lang.String getFileNameWithoutSuffix(java.io.File file)

Liefert den Dateiname ohne die Dateiendung (ohne den nachfolgenden Punkt) für ein File-Object. Wenn der Dateiname keine Dateiendung hat, wird der Dateiname selbst zurückgegeben. Wirft eine NullPointerException, wenn das übergebene File-Object null ist.

getFileSuffix

public static java.lang.String getFileSuffix(java.io.File file)

Liefert die Dateiendung (ohne den Punkt davor) für ein File-Object. Wenn der Dateiname keine Dateiendung hat, wird ein leerer String zurückgegeben. Wirft eine NullPointerException, wenn das übergebene File-Object null ist.

getLiveConfigPath

public static java.lang.String getLiveConfigPath(java.lang.String pathPropertyName)

Liefert den physikalischen, absoluten Pfad zu einer definierten Pfad-Konfig-Variablen auf dem Live-Server. Erkennt, ob es sich um einen relativen Pfad handelt und stellt in diesem Fall den Pfad unter der Konfig-Variablen "cda.server.path.physical.webapp" dem angeforderten Wert voran. /ws

listDirectories

public static java.util.Collection listDirectories(java.io.File directory)

Liefert eine Collection von allen Verzeichnissen unterhalb des angegebenen Verzeichnisses. Sind keine vorhanden wird eine leere Collection zurückgegeben.

parseASCIIFileName

public static java.lang.String parseASCIIFileName(java.io.File file)

Liefert für ein File-Object einen Filenamen (ohne Pfad), der keine Sonderzeichen oder Leerzeichen enthält. Ersetzt alle im Ursprungsnamen enthaltenen Leerzeichen gegen '_' (Unterstrich) und alle nationalen Sonderzeichen gegen ASCII-Pendant (@link{StringUtils#convertNativeChars2ASII}). Löscht alle verbliebenen Zeichen, die dem Posix-Ausdruck p{Alnum} nicht entsprechen, aus dem Ursprungsnamen. Wirft eine NullPointerException, wenn das übergebene File-Object null ist.

parseASCIIFileName

public static java.lang.String parseASCIIFileName(java.lang.String filename)

Konvertiert einen String-Filenamen (ohne Pfad) in einen Name, der keine Sonderzeichen oder Leerzeichen enthält. Ersetzt alle im Ursprungsnamen enthaltenen Leerzeichen gegen '_' (Unterstrich) und alle nationalen Sonderzeichen gegen ASCII-Pendant (@link{StringUtils#convertNativeChars2ASII}). Löscht alle verbliebenen Zeichen, die dem Posix-Ausdruck p{Alnum} nicht entsprechen, aus dem Ursprungsnamen.

rename

public static boolean rename(java.lang.String path,
                             java.lang.String oldFilename,
                             java.lang.String newFilename)

Benennt eine Datei (oldFilename) mit dem angegebenen, gemeinsamen Pfad in den neuen Namen (newFilename) um und liefert bei Erfolg true, sonst false.