FileConstants (UltraESB - API 2.6.1 API)

java.lang.Object
- org.adroitlogic.ultraesb.api.transport.file.FileConstants

```
public class FileConstants
extends Object
```
Define the File transport constants

Author:

asankha

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FileConstants.ErrorCodes

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileConstants.ErrorCodes`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`APPEND_MODE_PARAM` The append mode parameter that is passed in the URL
`static String`	`APPEND_MODE_PROPERTY` Specifies whether data should be appended to the destination file, instead of an overwrite as an endpoint property
`static String`	`DISTRIBUTED_LOCKING_DISABLED` Disable the clustered distributed locking, valid only if clustering is enabled, falls back local file locking
`static String`	`FETCH_AFTER_MODIFICATION` Fetch the file after modification after the amount of seconds specified by this property
`static String`	`MOVE_AFTER_FAILURE`
`static String`	`MOVE_AFTER_PROCESS`
`static String`	`MOVE_TIMESTAMP_FORMAT`
`static String`	`NAME` The file name of the message being processed - is set as a transport header
`static String`	`NAME_PATTERN` A regex pattern for file names occuring in the location pointed by the URL
`static String`	`ORIGINAL_NAME`
`static String`	`PATH` The file path of the message being processed - is set as a transport header
`static String`	`PATH_PATTERN` A simple file path/name pattern as per the http://code.google.com/p/wildcard/ library
`static String`	`PRIVATE_KEY_FILE` SFTP url property specifying the private key file path to be used for authentication
`static String`	`PRIVATE_KEY_PASSWORD` SFTP url property specifying the private key password used - if any
`static String`	`REMOVE_ORIGINAL_FILE` Property name to configure whether to remove the original file after processing, which defaults to true
`static String`	`SCHEME` The file scheme of the message being processed - is set as a transport header
`static String`	`SESSION_TIMEOUT` session timeout (e.g.
`static String`	`SIZE` The file size of the message being processed - is set as a transport header
`static String`	`STRICT_HOST_KEY_CHECK` Fail if host key is not recognized
`static String`	`TIMESTAMP_FORMAT`

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

- Field Detail
  - PATH
```
public static final String PATH
```
    The file path of the message being processed - is set as a transport header
    
    See Also:
    Constant Field Values
  - NAME
```
public static final String NAME
```
    The file name of the message being processed - is set as a transport header
    
    See Also:
    Constant Field Values
  - SIZE
```
public static final String SIZE
```
    The file size of the message being processed - is set as a transport header
    
    See Also:
    Constant Field Values
  - SCHEME
```
public static final String SCHEME
```
    The file scheme of the message being processed - is set as a transport header
    
    See Also:
    Constant Field Values
  - NAME_PATTERN
```
public static final String NAME_PATTERN
```
    A regex pattern for file names occuring in the location pointed by the URL
    
    See Also:
    Constant Field Values
  - PATH_PATTERN
```
public static final String PATH_PATTERN
```
    A simple file path/name pattern as per the http://code.google.com/p/wildcard/ library
    
    See Also:
    Constant Field Values
  - REMOVE_ORIGINAL_FILE
```
public static final String REMOVE_ORIGINAL_FILE
```
    Property name to configure whether to remove the original file after processing, which defaults to true
    
    Since:
    
    2.3.2
    
    See Also:
    Constant Field Values
  - MOVE_AFTER_PROCESS
```
public static final String MOVE_AFTER_PROCESS
```
    See Also:
    Constant Field Values
  - MOVE_AFTER_FAILURE
```
public static final String MOVE_AFTER_FAILURE
```
    See Also:
    Constant Field Values
  - TIMESTAMP_FORMAT
```
public static final String TIMESTAMP_FORMAT
```
    See Also:
    Constant Field Values
  - MOVE_TIMESTAMP_FORMAT
```
public static final String MOVE_TIMESTAMP_FORMAT
```
    See Also:
    Constant Field Values
  - ORIGINAL_NAME
```
public static final String ORIGINAL_NAME
```
    See Also:
    Constant Field Values
  - FETCH_AFTER_MODIFICATION
```
public static final String FETCH_AFTER_MODIFICATION
```
    Fetch the file after modification after the amount of seconds specified by this property
    
    See Also:
    Constant Field Values
  - DISTRIBUTED_LOCKING_DISABLED
```
public static final String DISTRIBUTED_LOCKING_DISABLED
```
    Disable the clustered distributed locking, valid only if clustering is enabled, falls back local file locking
    
    See Also:
    Constant Field Values
  - PRIVATE_KEY_FILE
```
public static final String PRIVATE_KEY_FILE
```
    SFTP url property specifying the private key file path to be used for authentication
    
    See Also:
    Constant Field Values
  - PRIVATE_KEY_PASSWORD
```
public static final String PRIVATE_KEY_PASSWORD
```
    SFTP url property specifying the private key password used - if any
    
    See Also:
    Constant Field Values
  - STRICT_HOST_KEY_CHECK
```
public static final String STRICT_HOST_KEY_CHECK
```
    Fail if host key is not recognized
    
    See Also:
    Constant Field Values
  - SESSION_TIMEOUT
```
public static final String SESSION_TIMEOUT
```
    session timeout (e.g. for SFTP pooled connections)
    
    See Also:
    Constant Field Values
  - APPEND_MODE_PROPERTY
```
public static final String APPEND_MODE_PROPERTY
```
    Specifies whether data should be appended to the destination file, instead of an overwrite as an endpoint property
    
    See Also:
    Constant Field Values
  - APPEND_MODE_PARAM
```
public static final String APPEND_MODE_PARAM
```
    The append mode parameter that is passed in the URL
    
    See Also:
    Constant Field Values

Class FileConstants

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PATH

NAME

SIZE

SCHEME

NAME_PATTERN

PATH_PATTERN

REMOVE_ORIGINAL_FILE

MOVE_AFTER_PROCESS

MOVE_AFTER_FAILURE

TIMESTAMP_FORMAT

MOVE_TIMESTAMP_FORMAT

ORIGINAL_NAME

FETCH_AFTER_MODIFICATION

DISTRIBUTED_LOCKING_DISABLED

PRIVATE_KEY_FILE

PRIVATE_KEY_PASSWORD

STRICT_HOST_KEY_CHECK

SESSION_TIMEOUT

APPEND_MODE_PROPERTY

APPEND_MODE_PARAM