public interface FileHandlerInterface
extends com.deltek.enterprise.system.sysutils.integration.invocation.IntResource
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_FILE_TYPE
Specifies default content type (text/plain).
|
static int |
FILE_SeekBegin
Specifies FILE_SeekBegin constant.
|
static int |
FILE_SeekCurrent
Specifies FILE_SeekCurrent constant.
|
static int |
FILE_SeekEnd
Specifies FILE_SeekEnd constant.
|
static java.lang.String |
MEMORY_FILE_LOCATION
Specifies virtual location to create file on the fly in memory.
|
static int |
OF_Append
Specifies File Append constant.
|
static int |
OF_Create
Specifies File Create constant.
|
static int |
OF_Delete
Specifies File Delete constant.
|
static int |
OF_Exist
Specifies File Exist constant.
|
static int |
OF_Read
Specifies File Read constant.
|
Modifier and Type | Method and Description |
---|---|
boolean |
deleteFile(java.lang.String fileName)
Deletes file.
|
boolean |
deleteFile(java.lang.String fileName,
java.lang.String altLocation)
Deletes file.
|
boolean |
deleteFile(java.lang.String fileName,
java.lang.String altLocation,
java.lang.String subFolder)
Deletes file.
|
void |
fileClose()
Closes a file.
|
boolean |
fileCopy(java.lang.String fileNameFrom,
java.lang.String fileNameTo,
boolean bOverWrite)
Copies the content of one file to another.
|
boolean |
fileCopy(java.lang.String locFrom,
java.lang.String fileNameFrom,
java.lang.String locTo,
java.lang.String fileNameTo,
boolean bOverWrite)
Copies the content of one file to another.
|
boolean |
fileExists(java.lang.String fileName)
Checks whether a file exists in the database.
|
boolean |
fileExists(java.lang.String fileName,
java.lang.String altLocation)
Checks whether a file exists in the alternative file location.
|
java.lang.String |
fileGetStr()
Reads next line as String from an opened file.
|
boolean |
fileOpen(java.lang.String fileName,
int nStyle)
Opens, creates or deletes a file.
|
boolean |
fileOpen(java.lang.String fileName,
int nStyle,
java.lang.String altLocation)
Opens, creates or deletes a file.
|
boolean |
fileOpen(java.lang.String fileName,
int nStyle,
java.lang.String desc,
java.lang.String contentType,
java.util.Calendar expDate)
Opens, creates or deletes a file.
|
boolean |
fileOpen(java.lang.String fileName,
int nStyle,
java.lang.String desc,
java.lang.String contentType,
java.util.Calendar expDate,
java.lang.String altLocation)
Opens, creates or deletes a file.
|
boolean |
filePutChar(int c)
Adds a character to a file.
|
boolean |
filePutStr(java.lang.String line)
Adds a line to a file.
|
java.lang.String |
fileRead(int len)
Reads a buffer of characters from a file to a string starting from the current position and moves the current position.
|
boolean |
fileRename(java.lang.String fileName,
java.lang.String newFileName)
Renames file.
|
boolean |
fileRename(java.lang.String fileName,
java.lang.String newFileName,
java.lang.String altLocation)
Renames file.
|
boolean |
fileSeek(int posToSeek,
int startPos)
Sets current position in an open file (use in conjunction with fileRead(), fileWrite()).
|
boolean |
fileWrite(java.lang.String s)
Writes a string to an open file.
|
byte[] |
getBinaryFile(java.lang.String fileName,
java.lang.String fileAltLocation) |
java.lang.String |
getContentType()
Returns content type.
|
java.lang.String |
getDesc()
Returns description.
|
java.util.Calendar |
getExpDate()
Returns file exp date.
|
java.util.Calendar |
getFileDateTime()
Returns last modified date/time.
|
java.util.Calendar |
getFileDateTime(java.lang.String fileName)
Returns last modified date/time.
|
java.util.Calendar |
getFileDateTime(java.lang.String fileName,
java.lang.String altLocation)
Returns last modified date/time.
|
java.util.Calendar |
getFileDateTime(java.lang.String fileName,
java.lang.String altLocation,
java.lang.String subFolder)
Returns last modified date/time.
|
java.io.InputStream |
getFileInputStream()
Returns file content as input stream.
|
java.io.InputStream |
getFileInputStream(java.lang.String charsetName)
Returns file content as input stream.
|
long |
getFileLength(java.lang.String fileName,
java.lang.String altLocation)
Returns file length.
|
long |
getFileLength(java.lang.String fileName,
java.lang.String altLocation,
java.lang.String subFolder)
Returns file size.
|
int |
getFilePointer()
Returns the current offset in the open file.
|
java.lang.String |
getMD5CheckSum(java.lang.String fileName,
java.lang.String altFileLocation)
Use method to generate MD5 check sum for any file in CP
|
java.io.File |
getResourceFile(java.lang.String res)
Returns reference to application resource file (pdf, xml.
|
java.lang.String |
getSHA256CheckSum(java.lang.String fileName,
java.lang.String altFileLocation)
Use method to generate SHA-256 check sum for any file in CP
|
int |
length()
Returns length of an opened file.
|
java.lang.String[] |
listFiles(java.lang.String altLocation)
Returns list of file names in given Alt file location.
|
java.lang.String[] |
listFiles(java.lang.String altLocation,
java.lang.String subFolder)
Returns list of file names in given Alt file location and subfolder
If location does not exist or contains no files, then null is returned.
|
java.lang.String[] |
listFiles(java.lang.String altLocation,
java.lang.String[] ext)
Returns list of file names in given Alt file location.
|
java.lang.String[] |
listFiles(java.lang.String altLocation,
java.lang.String subFolder,
java.lang.String[] ext)
Returns list of file names in given Alt file location and subfolder
If location does not exist or contains no files, then null is returned.
|
boolean |
locationCanWrite(java.lang.String altLocation)
Checks whether the process can write to alternative file location.
|
boolean |
locationCanWrite(java.lang.String altLocation,
boolean isOSPath)
Checks whether the process can write to alternative file location.
|
boolean |
locationExists(java.lang.String altLocation)
Checks whether alternative file location exists and whether a user has rights to access it.
|
boolean |
locationExists(java.lang.String altLocation,
boolean isOSPath)
Checks whether alternative file location exists and whether a user has rights to access it.
|
void |
saveBinaryFile(java.lang.String fileName,
java.lang.String fileDesc,
java.lang.String fileContentType,
java.util.Calendar fileExpDt,
java.lang.String fileAltLocation,
byte[] fileContent) |
static final int OF_Create
static final int OF_Append
static final int OF_Exist
static final int OF_Delete
static final int OF_Read
static final int FILE_SeekBegin
static final int FILE_SeekCurrent
static final int FILE_SeekEnd
static final java.lang.String DEFAULT_FILE_TYPE
static final java.lang.String MEMORY_FILE_LOCATION
boolean fileOpen(java.lang.String fileName, int nStyle)
fileName
- the file name.nStyle
- a constant that specifies the style in which to open a file.boolean fileOpen(java.lang.String fileName, int nStyle, java.lang.String altLocation)
fileName
- the file name.nStyle
- a constant that specifies the style in which to open a file.altLocation
- location in the file system.boolean fileOpen(java.lang.String fileName, int nStyle, java.lang.String desc, java.lang.String contentType, java.util.Calendar expDate)
fileName
- the file name.nStyle
- a constant that specifies the style in which to open a file.desc
- file description.contentType
- file content type.expDate
- file expiration date.boolean fileOpen(java.lang.String fileName, int nStyle, java.lang.String desc, java.lang.String contentType, java.util.Calendar expDate, java.lang.String altLocation)
fileName
- the file name.nStyle
- a constant that specifies the style in which to open a file.desc
- file description.contentType
- file content type.expDate
- file expiration date.altLocation
- location in the file system.void fileClose()
boolean fileExists(java.lang.String fileName)
fileName
- file name.boolean fileExists(java.lang.String fileName, java.lang.String altLocation)
fileName
- file name.altLocation
- location in the file system.boolean locationExists(java.lang.String altLocation)
altLocation
- location in the file system.boolean locationExists(java.lang.String altLocation, boolean isOSPath)
altLocation
- location in the file system.isOSPath
- if the process can write to alternative file location.boolean locationCanWrite(java.lang.String altLocation)
altLocation
- location in the file system.boolean locationCanWrite(java.lang.String altLocation, boolean isOSPath)
altLocation
- location in the file system.isOSPath
- true if OS path, false if Alt Location ID.java.lang.String[] listFiles(java.lang.String altLocation)
altLocation
- alt file location.java.lang.String[] listFiles(java.lang.String altLocation, java.lang.String[] ext)
altLocation
- alt file location.ext
- array of file extensions, e.g. [txt,csv,pdf] or [csv].java.lang.String[] listFiles(java.lang.String altLocation, java.lang.String subFolder)
altLocation
- alt file location.subFolder
- subfolder to alt file location.java.lang.String[] listFiles(java.lang.String altLocation, java.lang.String subFolder, java.lang.String[] ext)
altLocation
- alt file location.subFolder
- subfolder to alt file location.ext
- array of file extensions, e.g. [txt,csv,pdf] or [csv].java.lang.String fileGetStr()
boolean filePutChar(int c)
c
- char to add.boolean filePutStr(java.lang.String line)
line
- a line to add.java.lang.String fileRead(int len)
len
- length of buffer to read.boolean fileWrite(java.lang.String s)
s
- a string to write.boolean fileSeek(int posToSeek, int startPos)
posToSeek
- position to seek, relative from startPos
.startPos
- starting position to seek (use predifiend constants: FILE_SeekBegin, FILE_SeekCurrent, FILE_SeekEnd).int getFilePointer()
int length()
java.util.Calendar getFileDateTime()
java.util.Calendar getFileDateTime(java.lang.String fileName)
fileName
- file name.java.util.Calendar getFileDateTime(java.lang.String fileName, java.lang.String altLocation)
fileName
- file name.altLocation
- location in the file system.java.util.Calendar getFileDateTime(java.lang.String fileName, java.lang.String altLocation, java.lang.String subFolder)
fileName
- file name.altLocation
- location in the file system.subFolder
- subfolder to location.long getFileLength(java.lang.String fileName, java.lang.String altLocation)
fileName
- file name.altLocation
- location in the file system.long getFileLength(java.lang.String fileName, java.lang.String altLocation, java.lang.String subFolder)
fileName
- file name.altLocation
- location in the file system.subFolder
- subfolder to location.boolean deleteFile(java.lang.String fileName)
fileName
- file name.boolean deleteFile(java.lang.String fileName, java.lang.String altLocation)
fileName
- file name.altLocation
- location in the file system.boolean deleteFile(java.lang.String fileName, java.lang.String altLocation, java.lang.String subFolder)
fileName
- file name.altLocation
- location in the file system.subFolder
- subfolder to location.boolean fileCopy(java.lang.String fileNameFrom, java.lang.String fileNameTo, boolean bOverWrite)
fileNameFrom
- file name to copy content from.fileNameTo
- file name to copy content into.bOverWrite
- if true and the fileNameTo
exists, then the destination file will be overridden.boolean fileCopy(java.lang.String locFrom, java.lang.String fileNameFrom, java.lang.String locTo, java.lang.String fileNameTo, boolean bOverWrite)
locFrom
- from location in the file system.fileNameFrom
- file name to copy content from.locTo
- from location in the file system.fileNameTo
- file name to copy content into.bOverWrite
- if true and the fileNameTo
exists, then the destination file will be overridden.boolean fileRename(java.lang.String fileName, java.lang.String newFileName)
fileName
- file name to rename.newFileName
- new file name.boolean fileRename(java.lang.String fileName, java.lang.String newFileName, java.lang.String altLocation)
fileName
- file name to rename.newFileName
- new file name.altLocation
- location in the file system.java.util.Calendar getExpDate()
java.lang.String getDesc()
java.lang.String getContentType()
java.io.InputStream getFileInputStream()
java.io.InputStream getFileInputStream(java.lang.String charsetName)
charsetName
- name of a supported charset.byte[] getBinaryFile(java.lang.String fileName, java.lang.String fileAltLocation) throws DEException
fileName
- fileAltLocation
- DEException
void saveBinaryFile(java.lang.String fileName, java.lang.String fileDesc, java.lang.String fileContentType, java.util.Calendar fileExpDt, java.lang.String fileAltLocation, byte[] fileContent) throws DEException
fileName
- fileDesc
- fileContentType
- fileExpDt
- fileAltLocation
- fileContent
- DEException
java.lang.String getMD5CheckSum(java.lang.String fileName, java.lang.String altFileLocation) throws DEException
fileName
- altFileLocation
- DEException
java.lang.String getSHA256CheckSum(java.lang.String fileName, java.lang.String altFileLocation) throws DEException
fileName
- altFileLocation
- DEException
java.io.File getResourceFile(java.lang.String res) throws DEException
res
- resource file, e.g., "bl/blrmbil/test.pdf"DEException