com.aspc.file

Class DBFileUtil

java.lang.Object

com.aspc.file.DBFileUtil

public final class DBFileUtil
extends java.lang.Object

DBFile Utilities
THREAD MODE: MULTI-THREADED utilities

Since:

3 January 2001, 09:13

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalKey	EXPORT_FOLDER_GKEY the export folder
static java.lang.String	FEATURE_SSL string to verify if SSL has been enabled
static GlobalKey	LOST_AND_FOUND_FOLDER_GKEY the lost and found folder
static java.lang.String	PARAMETER_ENCODE
static GlobalKey	ROOT_FOLDER_GKEY the root folder

Method Summary

Modifier and Type	Method and Description
static DBFolder	copyDirectory(MutableDataSource mds, DBFolder dbFolder, java.lang.String destPath, boolean replace) copy the entire directory
static DBFile	copyFile(MutableDataSource mds, DBFile dbFileToCopy, java.lang.String destPath) Copy file from source location to destination location.
static DBFolder	createDateFolder(MutableDataSource mds, java.lang.String prefix)
static DBFolder	createDateFolder(MutableDataSource mds, java.lang.String prefix, java.lang.String suffix)
static DBFolder	createDateFolder(MutableDataSource mds, java.lang.String prefix, java.lang.String suffix, java.lang.String dateFormat, java.util.Date date) Automatically create folders based on a date.
static DBFile	createFile(DBFolder folder, java.lang.String name)
static DBFile	fetchFile(DataSource ds, java.lang.String decodedPath) get the file
static DBFolder	fetchFolder(DataSource ds, java.lang.String path) get the folder
static DBFileRemote	fetchRemoteFile(DataSource ds, java.lang.String path) get the file
static java.lang.String	getExternalFileURL(DBFile file, DataSource ds) Get Full URL
static java.lang.String	getMagicNumberURL(java.lang.String magicNumber, DataSource ds) Get Magic Number URL
static DBFile	getVersion(DBFile file, java.lang.String version) Gets the file for the specified version.
static DBFolder	makeFolder(MutableDataSource mds, java.lang.String path) create a folder
static DBFile	obsoleteCopyFile(MutableDataSource mds, DBFile dbFileToCopy, java.lang.String encodedDestPath) Deprecated.
static DBFolder	obsoleteCreateFolder(MutableDataSource mds, java.lang.String theEncodedURL) Deprecated.
static DBFile	obsoleteGetFile(DataSource ds, java.lang.String theEncodedURL) Deprecated.
static DBFolder	obsoleteGetFolder(DataSource ds, java.lang.String theEncodedURL) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_ENCODE

public static final java.lang.String PARAMETER_ENCODE

See Also:

Constant Field Values

ROOT_FOLDER_GKEY

public static final GlobalKey ROOT_FOLDER_GKEY

the root folder

LOST_AND_FOUND_FOLDER_GKEY

public static final GlobalKey LOST_AND_FOUND_FOLDER_GKEY

the lost and found folder

EXPORT_FOLDER_GKEY

public static final GlobalKey EXPORT_FOLDER_GKEY

the export folder

FEATURE_SSL

public static final java.lang.String FEATURE_SSL

string to verify if SSL has been enabled

See Also:

Constant Field Values

Method Detail

obsoleteCopyFile

@Deprecated
 @Nonnull
public static DBFile obsoleteCopyFile(MutableDataSource mds,
                                                            DBFile dbFileToCopy,
                                                            @Nonnull
                                                            java.lang.String encodedDestPath)
                                                     throws java.lang.Exception

Deprecated.

Copy file from source location to destination location.

Parameters:

mds - the data source to use

dbFileToCopy - DbFile

encodedDestPath - - destination path

Returns:

return the copied file.

Throws:

java.lang.Exception - a serious problem.

copyFile

@Nonnull
public static DBFile copyFile(@Nonnull
                                       MutableDataSource mds,
                                       @Nonnull
                                       DBFile dbFileToCopy,
                                       @Nonnull
                                       java.lang.String destPath)
                                throws java.lang.Exception

Copy file from source location to destination location.

Parameters:

mds - the data source to use

dbFileToCopy - DbFile

destPath - - destination path

Returns:

return the copied file.

Throws:

java.lang.Exception - a serious problem.

createFile

@CheckReturnValue
 @Nonnull
public static DBFile createFile(@Nonnull
                                                            DBFolder folder,
                                                            @Nonnull
                                                            java.lang.String name)
                                                     throws java.lang.Exception

Parameters:

folder - the folder to create the file in

name - the file name

Returns:

the new file.

Throws:

java.lang.Exception - a serious problem.

copyDirectory

@Nonnull
public static DBFolder copyDirectory(@Nonnull
                                              MutableDataSource mds,
                                              @Nonnull
                                              DBFolder dbFolder,
                                              @Nonnull
                                              java.lang.String destPath,
                                              boolean replace)
                                       throws java.lang.Exception

copy the entire directory

Parameters:

mds - the data source to use

dbFolder -

destPath -

replace -

Returns:

the value

Throws:

java.lang.Exception - a exception

fetchFile

@Nullable
 @CheckReturnValue
public static DBFile fetchFile(@Nonnull
                                                            DataSource ds,
                                                            @Nonnull
                                                            java.lang.String decodedPath)
                                                     throws java.lang.Exception

get the file

Parameters:

ds - the data source

decodedPath - file decoded path

Returns:

the file

Throws:

java.lang.Exception - a serious problem

fetchRemoteFile

@CheckReturnValue
 @Nullable
public static DBFileRemote fetchRemoteFile(@Nonnull
                                                                        DataSource ds,
                                                                        @Nonnull
                                                                        java.lang.String path)
                                                                 throws java.lang.Exception

get the file

Parameters:

ds - the data source

path - file path

Returns:

the file

Throws:

java.lang.Exception - a serious problem

obsoleteGetFile

@Deprecated
 @CheckReturnValue
 @Nullable
public static DBFile obsoleteGetFile(@Nonnull
                                                                               DataSource ds,
                                                                               @Nonnull
                                                                               java.lang.String theEncodedURL)
                                                                        throws java.lang.Exception

Deprecated.

get the file

Parameters:

ds - the data source

theEncodedURL - each level of folder name and file name must be encoded with StringUtilities.encode() method all '/' will be treated as path separator

Returns:

the file

Throws:

java.lang.Exception - a serious problem

getExternalFileURL

@CheckReturnValue
 @Nonnull
public static java.lang.String getExternalFileURL(@Nonnull
                                                                              DBFile file,
                                                                              @Nonnull
                                                                              DataSource ds)
                                                                       throws java.lang.Exception

Get Full URL

Parameters:

file - file

ds - ds

Returns:

Full URL to file

Throws:

java.lang.Exception - a serious problem.

getVersion

@CheckReturnValue
 @Nullable
public static DBFile getVersion(@Nullable
                                                             DBFile file,
                                                             @Nullable
                                                             java.lang.String version)
                                                      throws java.lang.Exception

Gets the file for the specified version.

Parameters:

file - The file

version - The version

Returns:

file

Throws:

java.lang.Exception - A serious problem

createDateFolder

@CheckReturnValue
 @Nonnull
public static DBFolder createDateFolder(@Nonnull
                                                                    MutableDataSource mds,
                                                                    @Nonnull
                                                                    java.lang.String prefix,
                                                                    @Nullable
                                                                    java.lang.String suffix,
                                                                    @Nonnull
                                                                    java.lang.String dateFormat,
                                                                    @Nonnull
                                                                    java.util.Date date)
                                                             throws java.lang.Exception

Automatically create folders based on a date.

Parameters:

mds -

prefix -

suffix -

dateFormat -

date -

Returns:

Throws:

java.lang.Exception

createDateFolder

@CheckReturnValue
 @Nonnull
public static DBFolder createDateFolder(@Nonnull
                                                                    MutableDataSource mds,
                                                                    @Nonnull
                                                                    java.lang.String prefix,
                                                                    @Nullable
                                                                    java.lang.String suffix)
                                                             throws java.lang.Exception

Throws:

java.lang.Exception

createDateFolder

@CheckReturnValue
 @Nonnull
public static DBFolder createDateFolder(@Nonnull
                                                                    MutableDataSource mds,
                                                                    @Nonnull
                                                                    java.lang.String prefix)
                                                             throws java.lang.Exception

Throws:

java.lang.Exception

makeFolder

@CheckReturnValue
 @Nonnull
public static DBFolder makeFolder(@Nonnull
                                                              MutableDataSource mds,
                                                              @Nonnull
                                                              java.lang.String path)
                                                       throws java.lang.Exception

create a folder

Parameters:

mds - the datasource to clone

path - folder path

Returns:

the folder

Throws:

java.lang.Exception - a serious problem

obsoleteCreateFolder

@Deprecated
 @CheckReturnValue
 @Nonnull
public static DBFolder obsoleteCreateFolder(@Nonnull
                                                                                     MutableDataSource mds,
                                                                                     @Nonnull
                                                                                     java.lang.String theEncodedURL)
                                                                              throws java.lang.Exception

Deprecated.

create a folder

Parameters:

mds - the datasource to clone

theEncodedURL - each level of folder name and file name must be encoded with StringUtilities.encode() method all '/' will be treated as path separator

Returns:

the folder

Throws:

java.lang.Exception - a serious problem

fetchFolder

@CheckReturnValue
 @Nullable
public static DBFolder fetchFolder(@Nonnull
                                                                DataSource ds,
                                                                @Nonnull
                                                                java.lang.String path)
                                                         throws java.lang.Exception

get the folder

Parameters:

ds - the datasource

path - folder path

Returns:

the folder

Throws:

java.lang.Exception - a serious problem

obsoleteGetFolder

@Deprecated
 @CheckReturnValue
 @Nullable
public static DBFolder obsoleteGetFolder(@Nonnull
                                                                                   DataSource ds,
                                                                                   @Nonnull
                                                                                   java.lang.String theEncodedURL)
                                                                            throws java.lang.Exception

Deprecated.

get the folder

Parameters:

ds - the datasource

theEncodedURL - each level of folder name must be encoded with StringUtilities.encode() method all '/' will be treated as path separator

Returns:

the folder

Throws:

java.lang.Exception - a serious problem

getMagicNumberURL

@CheckReturnValue
 @Nonnull
public static java.lang.String getMagicNumberURL(@Nonnull
                                                                             java.lang.String magicNumber,
                                                                             @Nonnull
                                                                             DataSource ds)
                                                                      throws java.lang.Exception

Get Magic Number URL

Parameters:

magicNumber - magicNumber

ds - ds

Returns:

the value

Throws:

java.lang.Exception - Exception