Package org.apache.camel.component.file

Class FileConstants

java.lang.Object

org.apache.camel.component.file.FileConstants

public final class FileConstants
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILE_ABSOLUTE
static final String	FILE_ABSOLUTE_PATH
static final String	FILE_CONTENT_TYPE
static final String	FILE_EXTENDED_ATTRIBUTES
static final String	FILE_LAST_MODIFIED
static final String	FILE_LENGTH
static final String	FILE_LOCAL_WORK_PATH
static final String	FILE_NAME
static final String	FILE_NAME_CONSUMED
static final String	FILE_NAME_ONLY
static final String	FILE_NAME_PRODUCED
static final String	FILE_PARENT
static final String	FILE_PATH
static final String	FILE_RELATIVE_PATH
static final String	INITIAL_OFFSET
static final String	OVERRULE_FILE_NAME

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

FILE_LENGTH

@Metadata(label="consumer",
          description="A `long` value containing the file size.",
          javaType="long")
public static final String FILE_LENGTH

See Also:

• Constant Field Values

FILE_LAST_MODIFIED

@Metadata(label="consumer",
          description="A `Long` value containing the last modified timestamp of the file.",
          javaType="long")
public static final String FILE_LAST_MODIFIED

See Also:

• Constant Field Values

FILE_LOCAL_WORK_PATH

@Metadata(label="producer",
          description="The local work path",
          javaType="File")
public static final String FILE_LOCAL_WORK_PATH

See Also:

• Constant Field Values

FILE_NAME_ONLY

@Metadata(description="Only the file name (the name with no leading paths).",
          javaType="String")
public static final String FILE_NAME_ONLY

See Also:

• Constant Field Values

FILE_NAME

@Metadata(description="(producer) Specifies the name of the file to write (relative to the endpoint\ndirectory). This name can be a `String`; a `String` with a\nxref:languages:file-language.adoc[File Language] or xref:languages:simple-language.adoc[Simple]\nexpression; or an Expression object. If it\'s\n`null` then Camel will auto-generate a filename based on the message\nunique ID. (consumer) Name of the consumed file as a relative file path with offset from the\nstarting directory configured on the endpoint.",
          javaType="String")
public static final String FILE_NAME

See Also:

• Constant Field Values

FILE_NAME_CONSUMED

@Metadata(label="consumer",
          description="The name of the file that has been consumed",
          javaType="String")
public static final String FILE_NAME_CONSUMED

See Also:

• Constant Field Values

FILE_ABSOLUTE

@Metadata(label="consumer",
          description="A `boolean` option specifying whether the consumed file denotes an\nabsolute path or not. Should normally be `false` for relative paths.\nAbsolute paths should normally not be used but we added to the move\noption to allow moving files to absolute paths. But can be used\nelsewhere as well.",
          javaType="Boolean")
public static final String FILE_ABSOLUTE

See Also:

• Constant Field Values

FILE_ABSOLUTE_PATH

@Metadata(label="consumer",
          description="The absolute path to the file. For relative files this path holds the\nrelative path instead.",
          javaType="String")
public static final String FILE_ABSOLUTE_PATH

See Also:

• Constant Field Values

FILE_EXTENDED_ATTRIBUTES

@Metadata(label="consumer",
          description="The extended attributes of the file",
          javaType="Map<String, Object>")
public static final String FILE_EXTENDED_ATTRIBUTES

See Also:

• Constant Field Values

FILE_CONTENT_TYPE

@Metadata(label="consumer",
          description="The content type of the file",
          javaType="String")
public static final String FILE_CONTENT_TYPE

See Also:

• Constant Field Values

FILE_PATH

@Metadata(label="consumer",
          description="The file path. For relative files this is the starting directory + the\nrelative filename. For absolute files this is the absolute path.",
          javaType="String")
public static final String FILE_PATH

See Also:

• Constant Field Values

FILE_RELATIVE_PATH

@Metadata(label="consumer",
          description="The relative path.",
          javaType="String")
public static final String FILE_RELATIVE_PATH

See Also:

• Constant Field Values

FILE_PARENT

@Metadata(description="The parent path.",
          javaType="String")
public static final String FILE_PARENT

See Also:

• Constant Field Values

FILE_NAME_PRODUCED

@Metadata(label="producer",
          description="The actual absolute filepath (path + name) for the output file that was\nwritten. This header is set by Camel and its purpose is providing\nend-users with the name of the file that was written.",
          javaType="String")
public static final String FILE_NAME_PRODUCED

See Also:

• Constant Field Values

OVERRULE_FILE_NAME

@Metadata(label="producer",
          description="Is used for overruling `CamelFileName` header and use the\nvalue instead (but only once, as the producer will remove this header\nafter writing the file). The value can be only be a String. Notice that\nif the option `fileName` has been configured, then this is still being\nevaluated.",
          javaType="Object")
public static final String OVERRULE_FILE_NAME

See Also:

• Constant Field Values

INITIAL_OFFSET

@Metadata(label="consumer",
          description="A `long` value containing the initial offset.",
          javaType="long")
public static final String INITIAL_OFFSET

See Also:

• Constant Field Values