Class FileEndpointBuilderFactory.FileHeaderNameBuilder
- java.lang.Object
-
- org.apache.camel.builder.endpoint.dsl.FileEndpointBuilderFactory.FileHeaderNameBuilder
-
- Enclosing interface:
- FileEndpointBuilderFactory
public static class FileEndpointBuilderFactory.FileHeaderNameBuilder extends Object
The builder of headers' name for the File component.
-
-
Constructor Summary
Constructors Constructor Description FileHeaderNameBuilder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
fileAbsolute()
A boolean option specifying whether the consumed file denotes an absolute path or not.String
fileAbsolutePath()
The absolute path to the file.String
fileContentType()
The content type of the file.String
fileExtendedAttributes()
The extended attributes of the file.String
fileInitialOffset()
A long value containing the initial offset.String
fileLastModified()
A Long value containing the last modified timestamp of the file.String
fileLength()
A long value containing the file size.String
fileLocalWorkPath()
The local work path.String
fileName()
(producer) Specifies the name of the file to write (relative to the endpoint directory).String
fileNameConsumed()
The name of the file that has been consumed.String
fileNameOnly()
Only the file name (the name with no leading paths).String
fileNameProduced()
The actual absolute filepath (path name) for the output file that was written.String
fileParent()
The parent path.String
filePath()
The file path.String
fileRelativePath()
The relative path.String
overruleFileName()
Is used for overruling CamelFileName header and use the value instead (but only once, as the producer will remove this header after writing the file).
-
-
-
Method Detail
-
fileLength
public String fileLength()
A long value containing the file size. The option is a:long
type. Group: consumer- Returns:
- the name of the header
FileLength
.
-
fileLastModified
public String fileLastModified()
A Long value containing the last modified timestamp of the file. The option is a:long
type. Group: consumer- Returns:
- the name of the header
FileLastModified
.
-
fileLocalWorkPath
public String fileLocalWorkPath()
The local work path. The option is a:File
type. Group: producer- Returns:
- the name of the header
FileLocalWorkPath
.
-
fileNameOnly
public String fileNameOnly()
Only the file name (the name with no leading paths). The option is a:String
type. Group: common- Returns:
- the name of the header
FileNameOnly
.
-
fileName
public String fileName()
(producer) Specifies the name of the file to write (relative to the endpoint directory). This name can be a String; a String with a xref:languages:file-language.adocFile Language or xref:languages:simple-language.adocSimple expression; or an Expression object. If it's null then Camel will auto-generate a filename based on the message unique ID. (consumer) Name of the consumed file as a relative file path with offset from the starting directory configured on the endpoint. The option is a:String
type. Group: common- Returns:
- the name of the header
FileName
.
-
fileNameConsumed
public String fileNameConsumed()
The name of the file that has been consumed. The option is a:String
type. Group: consumer- Returns:
- the name of the header
FileNameConsumed
.
-
fileAbsolute
public String fileAbsolute()
A boolean option specifying whether the consumed file denotes an absolute path or not. Should normally be false for relative paths. Absolute paths should normally not be used but we added to the move option to allow moving files to absolute paths. But can be used elsewhere as well. The option is a:Boolean
type. Group: consumer- Returns:
- the name of the header
FileAbsolute
.
-
fileAbsolutePath
public String fileAbsolutePath()
The absolute path to the file. For relative files this path holds the relative path instead. The option is a:String
type. Group: consumer- Returns:
- the name of the header
FileAbsolutePath
.
-
fileExtendedAttributes
public String fileExtendedAttributes()
The extended attributes of the file. The option is a:Map<String, Object>
type. Group: consumer- Returns:
- the name of the header
FileExtendedAttributes
.
-
fileContentType
public String fileContentType()
The content type of the file. The option is a:String
type. Group: consumer- Returns:
- the name of the header
FileContentType
.
-
filePath
public String filePath()
The file path. For relative files this is the starting directory the relative filename. For absolute files this is the absolute path. The option is a:String
type. Group: consumer- Returns:
- the name of the header
FilePath
.
-
fileRelativePath
public String fileRelativePath()
The relative path. The option is a:String
type. Group: consumer- Returns:
- the name of the header
FileRelativePath
.
-
fileParent
public String fileParent()
The parent path. The option is a:String
type. Group: common- Returns:
- the name of the header
FileParent
.
-
fileNameProduced
public String fileNameProduced()
The actual absolute filepath (path name) for the output file that was written. This header is set by Camel and its purpose is providing end-users with the name of the file that was written. The option is a:String
type. Group: producer- Returns:
- the name of the header
FileNameProduced
.
-
overruleFileName
public String overruleFileName()
Is used for overruling CamelFileName header and use the value instead (but only once, as the producer will remove this header after writing the file). The value can be only be a String. Notice that if the option fileName has been configured, then this is still being evaluated. The option is a:Object
type. Group: producer- Returns:
- the name of the header
OverruleFileName
.
-
fileInitialOffset
public String fileInitialOffset()
A long value containing the initial offset. The option is a:long
type. Group: consumer- Returns:
- the name of the header
FileInitialOffset
.
-
-