FileHandler (Ibis AdapterFramework parent 7.9-20230330.214747 API)

java.lang.Object
- nl.nn.adapterframework.util.FileHandler

All Implemented Interfaces:

IScopeProvider

Direct Known Subclasses:

FileSender
```
public class FileHandler
extends Object
implements IScopeProvider
```
FileHandler, available to the Ibis developer as FileSender and FilePipe, allows to write to or read from a file.
Actions take place on the file specified by the fileName attribute (or when not available the fileNameSessionKey, when fileNameSessionKey is empty too the input of the pipe is used as file name). When a directory is not specified, the fileName is expected to include the directory.

When a file needs to be created and both the fileName and the directory are not specified a temporary file is created as specified by the java.io.File.createTempFile method using the string "ibis" as a prefix and a suffix as specified bij the writeSuffix attribute. If only the directory is specified, the temporary file is created the same way except that the temporary file is created in the specified directory.

The pipe also support base64 en- and decoding.

Parameters:
writeSuffix

name type remarks

String When a parameter with name writeSuffix is present, it is used instead of the writeSuffix specified by the attribute

Author:

J. Dekker, Jaco de Groot (***@dynasol.nl)

name	type	remarks
	String	When a parameter with name writeSuffix is present, it is used instead of the writeSuffix specified by the attribute

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static interface`	`FileHandler.TransformerAction` The pipe supports several actions.
`protected static interface`	`FileHandler.TransformerActionWithInputTypeStream`
`protected static interface`	`FileHandler.TransformerActionWithOutputTypeStream`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`actions`
`protected static byte[]`	`BOM_UTF_8`
`protected String`	`charset`
`protected boolean`	`createDirectory`
`protected boolean`	`deleteEmptyDirectory`
`protected String`	`directory`
`protected byte[]`	`eolArray`
`protected String`	`filename`
`protected String`	`filenameSessionKey`
`protected String`	`fileSource`
`protected org.apache.logging.log4j.Logger`	`log`
`protected String`	`outputType`
`protected boolean`	`skipBOM`
`protected boolean`	`streamResultToServlet`
`protected boolean`	`testCanWrite`
`protected boolean`	`testExists`
`protected List`	`transformers`
`protected boolean`	`writeLineSeparator`
`protected String`	`writeSuffix`

Constructor Summary

Constructors
Constructor and Description

FileHandler()

Constructors
Constructor and Description
`FileHandler()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`configure()`
`String`	`getActions()`
`String`	`getDirectory()`
`String`	`getFilename()`
`String`	`getFilenameSessionKey()`
`protected String`	`getLogPrefix(PipeLineSession session)`
`String`	`getWriteSuffix()`
`Object`	`handle(Message input, PipeLineSession session, ParameterList paramList)`
`boolean`	`isCreateDirectory()`
`boolean`	`isDeleteEmptyDirectory()`
`boolean`	`isSkipBOM()`
`boolean`	`isStreamResultToServlet()`
`boolean`	`isTestCanWrite()`
`boolean`	`isTestExists()`
`boolean`	`isWriteLineSeparator()`
`void`	`setActions(String actions)` Sets actions the pipe has to perform.
`void`	`setCharset(String charset)` the charset to be used when transforming a string to a byte array and/or the other way around
`void`	`setCreateDirectory(boolean b)` when set to `true`, the directory to read from or write to is created if it does not exist
`void`	`setDeleteEmptyDirectory(boolean b)` (only used when actions=delete) when set to `true`, the directory from which a file is deleted is also deleted when it contains no other files
`void`	`setDirectory(String directory)` Sets the directory in which the file resides or has to be created
`void`	`setFilename(String filename)` Sets filename of the file that is written
`void`	`setFileName(String filename)` Deprecated.
`void`	`setFilenameSessionKey(String filenameSessionKey)` Sets filenameSessionKey the session key that contains the name of the file to be created (only used if filename is not set)
`void`	`setFileNameSessionKey(String filenameSessionKey)` Deprecated.
`void`	`setFileSource(String fileSource)` either `filesystem` or `classpath` (classpath will only work for actions 'read' and 'info' and for 'info' only when resources are available as a file (i.e.
`void`	`setOutputType(String outputType)` either `string`, `bytes`, `stream` or `base64`
`void`	`setSkipBOM(boolean b)` when set to `true`, a possible bytes order mark (bom) at the start of the file is skipped (only used for the action read and encoding uft-8)
`void`	`setStreamResultToServlet(boolean b)` (only used when outputtype=stream) if set, the result is streamed to the httpservletresponse object
`void`	`setTestCanWrite(boolean b)` when set to `true`, a test is performed to find out if a temporary file can be created and deleted in the specified directory (only used if directory is set and combined with the action write, write_append or create)
`void`	`setTestExists(boolean testExists)` test if the specified directory exists at configure()
`void`	`setWriteLineSeparator(boolean b)` when set to `true`, a line separator is written after the content is written
`void`	`setWriteSuffix(String suffix)` Sets suffix of the file that is written (only used if filename and filenamesession are not set)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider
getConfigurationClassLoader

- Field Detail
  - log
```
protected org.apache.logging.log4j.Logger log
```
  - BOM_UTF_8
```
protected static final byte[] BOM_UTF_8
```
  - charset
```
protected String charset
```
  - outputType
```
protected String outputType
```
  - fileSource
```
protected String fileSource
```
  - actions
```
protected String actions
```
  - directory
```
protected String directory
```
  - writeSuffix
```
protected String writeSuffix
```
  - filename
```
protected String filename
```
  - filenameSessionKey
```
protected String filenameSessionKey
```
  - createDirectory
```
protected boolean createDirectory
```
  - writeLineSeparator
```
protected boolean writeLineSeparator
```
  - testExists
```
protected boolean testExists
```
  - testCanWrite
```
protected boolean testCanWrite
```
  - skipBOM
```
protected boolean skipBOM
```
  - deleteEmptyDirectory
```
protected boolean deleteEmptyDirectory
```
  - streamResultToServlet
```
protected boolean streamResultToServlet
```
  - transformers
```
protected List transformers
```
  - eolArray
```
protected byte[] eolArray
```
- Constructor Detail
  - FileHandler
```
public FileHandler()
```
- Method Detail
  - configure
```
public void configure()
               throws ConfigurationException
```
    Throws:
    
    ConfigurationException
    
    See Also:
    
    IPipe.configure()
  - handle
```
public Object handle(Message input,
                     PipeLineSession session,
                     ParameterList paramList)
              throws Exception
```
    Throws:
    
    Exception
  - getLogPrefix
```
protected String getLogPrefix(PipeLineSession session)
```
  - setCharset
```
public void setCharset(String charset)
```
    the charset to be used when transforming a string to a byte array and/or the other way around
    
    Default value
    
    the value of the system property file.encoding
  - setOutputType
```
public void setOutputType(String outputType)
```
    either string, bytes, stream or base64
    
    Default value
    
    string
  - setFileSource
```
public void setFileSource(String fileSource)
```
    either filesystem or classpath (classpath will only work for actions 'read' and 'info' and for 'info' only when resources are available as a file (i.e. doesn't work for resources in jar files and war files which are deployed without being extracted by the application server))
    
    Default value
    
    filesystem
  - setActions
```
public void setActions(String actions)
```
    Sets actions the pipe has to perform. Possible action values:
    - write: create a new file and write input to it
    - write_append: create a new file if it does not exist, otherwise append to existing file; then write input to it
    - create: create a new file, but do not write anything to it
    - read: read from file
    - delete: delete the file
    - read_delete: read the contents, then delete (when outputType is stream the file is deleted after the stream is read)
    - encode: encode base64
    - decode: decode base64
    - list: returns the files and directories in the directory that satisfy the specified filter (see Dir2Xml). If a directory is not specified, the fileName is expected to include the directory
    - info: returns information about the file
  - getActions
```
public String getActions()
```
  - setDirectory
```
public void setDirectory(String directory)
```
    Sets the directory in which the file resides or has to be created
  - getDirectory
```
public String getDirectory()
```
  - setWriteSuffix
```
public void setWriteSuffix(String suffix)
```
    Sets suffix of the file that is written (only used if filename and filenamesession are not set)
  - getWriteSuffix
```
public String getWriteSuffix()
```
  - setFileName
```
@Deprecated
 @ConfigurationWarning(value="attribute \'fileName\' is replaced with \'filename\'")
public void setFileName(String filename)
```
    Deprecated.
  - setFilename
```
public void setFilename(String filename)
```
    Sets filename of the file that is written
  - getFilename
```
public String getFilename()
```
  - setFileNameSessionKey
```
@Deprecated
 @ConfigurationWarning(value="attribute \'fileNameSessionKey\' is replaced with \'filenameSessionKey\'")
public void setFileNameSessionKey(String filenameSessionKey)
```
    Deprecated.
  - setFilenameSessionKey
```
public void setFilenameSessionKey(String filenameSessionKey)
```
    Sets filenameSessionKey the session key that contains the name of the file to be created (only used if filename is not set)
  - getFilenameSessionKey
```
public String getFilenameSessionKey()
```
  - setTestExists
```
public void setTestExists(boolean testExists)
```
    test if the specified directory exists at configure()
    
    Default value
    
    true
  - isTestExists
```
public boolean isTestExists()
```
  - setCreateDirectory
```
public void setCreateDirectory(boolean b)
```
    when set to true, the directory to read from or write to is created if it does not exist
    
    Default value
    
    false
  - isCreateDirectory
```
public boolean isCreateDirectory()
```
  - setWriteLineSeparator
```
public void setWriteLineSeparator(boolean b)
```
    when set to true, a line separator is written after the content is written
    
    Default value
    
    false
  - isWriteLineSeparator
```
public boolean isWriteLineSeparator()
```
  - setTestCanWrite
```
public void setTestCanWrite(boolean b)
```
    when set to true, a test is performed to find out if a temporary file can be created and deleted in the specified directory (only used if directory is set and combined with the action write, write_append or create)
    
    Default value
    
    true
  - isTestCanWrite
```
public boolean isTestCanWrite()
```
  - setSkipBOM
```
public void setSkipBOM(boolean b)
```
    when set to true, a possible bytes order mark (bom) at the start of the file is skipped (only used for the action read and encoding uft-8)
    
    Default value
    
    false
  - isSkipBOM
```
public boolean isSkipBOM()
```
  - setDeleteEmptyDirectory
```
public void setDeleteEmptyDirectory(boolean b)
```
    (only used when actions=delete) when set to true, the directory from which a file is deleted is also deleted when it contains no other files
    
    Default value
    
    false
  - isDeleteEmptyDirectory
```
public boolean isDeleteEmptyDirectory()
```
  - setStreamResultToServlet
```
public void setStreamResultToServlet(boolean b)
```
    (only used when outputtype=stream) if set, the result is streamed to the httpservletresponse object
    
    Default value
    
    false
  - isStreamResultToServlet
```
public boolean isStreamResultToServlet()
```

Class FileHandler

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

Field Detail

log

BOM_UTF_8

charset

outputType

fileSource

actions

directory

writeSuffix

filename

filenameSessionKey

createDirectory

writeLineSeparator

testExists

testCanWrite

skipBOM

deleteEmptyDirectory

streamResultToServlet

transformers

eolArray

Constructor Detail

FileHandler

Method Detail

configure

handle

getLogPrefix

setCharset

setOutputType

setFileSource

setActions

getActions

setDirectory

getDirectory

setWriteSuffix

getWriteSuffix

setFileName

setFilename

getFilename

setFileNameSessionKey

setFilenameSessionKey

getFilenameSessionKey

setTestExists

isTestExists

setCreateDirectory

isCreateDirectory

setWriteLineSeparator

isWriteLineSeparator

setTestCanWrite

isTestCanWrite

setSkipBOM

isSkipBOM

setDeleteEmptyDirectory

isDeleteEmptyDirectory

setStreamResultToServlet

isStreamResultToServlet