com.cerner.ccl.j4ccl.impl.util

Class FileAssistant

java.lang.Object

com.cerner.ccl.j4ccl.impl.util.FileAssistant

public final class FileAssistant
extends Object

A utility class to assist in using of files.

Author:

Joshua Hyde

Method Summary

Modifier and Type	Method and Description
static URI	createRemotePath(File localFile) Determine the location a file should reside on on the remote environment.
static URI	createRemotePath(File localFile, Environment environment) Determine the location on the remote server to which a file is to be uploaded.

Methods inherited from class java.lang.Object

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

Method Detail

createRemotePath

public static URI createRemotePath(File localFile)

Determine the location a file should reside on on the remote environment.
This requires an Environment.getEnvironment() to be in scope.

Parameters:

localFile - A File reference to a local file whose location on the remote environment is to be determined.

Returns:

A URI object representing the location on the remote server to which the given local file would be uploaded. All files placed in CCLSOURCE will be automatically converted to lower-case; everything else will retain its given casing.

Throws:

IllegalArgumentException - If the given file is not actually a file.

NullPointerException - If the given file is null.

See Also:

createRemotePath(File, Environment)

createRemotePath

public static URI createRemotePath(File localFile,
                                   Environment environment)

Determine the location on the remote server to which a file is to be uploaded.

Parameters:

localFile - A File object representing the local file to be uploaded.

environment - A Environment object describing the remote environment to which the file will eventually be uploaded.

Returns:

A URI object representing the location on the remote server to which the given local file would be uploaded. All files placed in CCLSOURCE will be automatically converted to lower-case; everything else will retain its given casing.

Throws:

IllegalArgumentException - If the given file is not actually a file.

NullPointerException - If the given file or environment is null.