Package org.apache.camel.component.file
Class FileOperations
java.lang.Object
org.apache.camel.component.file.FileOperations
- All Implemented Interfaces:
GenericFileOperations<File>
File operations for
File
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
buildDirectory
(File dir, Set<PosixFilePermission> permissions, boolean absolute) boolean
buildDirectory
(String directory, boolean absolute) Builds the directory structure.void
changeCurrentDirectory
(String path) Change the current remote directoryvoid
Change the current remote directory to the parentboolean
deleteFile
(String name) Deletes the file name by name, relative to the current directoryboolean
existsFile
(String name) Determines whether the files exists or notGets the current remote directoryFile[]
List the files in the current directoryFile[]
List the files in the given remote directoryCreates a new instance ofGenericFile
void
releaseRetrievedFileResources
(org.apache.camel.Exchange exchange) Releases the resources consumed by a retrieved fileboolean
renameFile
(String from, String to) Renames the fileboolean
retrieveFile
(String name, org.apache.camel.Exchange exchange, long size) Retrieves the filevoid
setEndpoint
(GenericFileEndpoint<File> endpoint) Sets the endpoint as some implementations need access to the endpoint and how its configured.boolean
Stores the content as a new remote file (upload)
-
Constructor Details
-
FileOperations
public FileOperations() -
FileOperations
-
-
Method Details
-
newGenericFile
Description copied from interface:GenericFileOperations
Creates a new instance ofGenericFile
- Specified by:
newGenericFile
in interfaceGenericFileOperations<File>
-
setEndpoint
Description copied from interface:GenericFileOperations
Sets the endpoint as some implementations need access to the endpoint and how its configured.- Specified by:
setEndpoint
in interfaceGenericFileOperations<File>
- Parameters:
endpoint
- the endpoint
-
deleteFile
Description copied from interface:GenericFileOperations
Deletes the file name by name, relative to the current directory- Specified by:
deleteFile
in interfaceGenericFileOperations<File>
- Parameters:
name
- name of the file- Returns:
- true if deleted, false if not
- Throws:
GenericFileOperationFailedException
- can be thrown
-
renameFile
Description copied from interface:GenericFileOperations
Renames the file- Specified by:
renameFile
in interfaceGenericFileOperations<File>
- Parameters:
from
- original nameto
- the new name- Returns:
- true if renamed, false if not
- Throws:
GenericFileOperationFailedException
- can be thrown
-
existsFile
Description copied from interface:GenericFileOperations
Determines whether the files exists or not- Specified by:
existsFile
in interfaceGenericFileOperations<File>
- Parameters:
name
- name of the file- Returns:
- true if exists, false if not
- Throws:
GenericFileOperationFailedException
- can be thrown
-
buildDirectory
-
buildDirectory
public boolean buildDirectory(String directory, boolean absolute) throws GenericFileOperationFailedException Description copied from interface:GenericFileOperations
Builds the directory structure. Will test if the folder already exists.- Specified by:
buildDirectory
in interfaceGenericFileOperations<File>
- Parameters:
directory
- the directory path to build as a relative string nameabsolute
- whether the directory is an absolute or relative path- Returns:
- true if build or already exists, false if not possible (could be lack of permissions)
- Throws:
GenericFileOperationFailedException
- can be thrown
-
listFiles
Description copied from interface:GenericFileOperations
List the files in the current directory- Specified by:
listFiles
in interfaceGenericFileOperations<File>
- Returns:
- a list of backing objects representing the files
- Throws:
GenericFileOperationFailedException
- can be thrown
-
listFiles
Description copied from interface:GenericFileOperations
List the files in the given remote directory- Specified by:
listFiles
in interfaceGenericFileOperations<File>
- Parameters:
path
- the remote directory- Returns:
- a list of backing objects representing the files
- Throws:
GenericFileOperationFailedException
- can be thrown
-
changeCurrentDirectory
Description copied from interface:GenericFileOperations
Change the current remote directory- Specified by:
changeCurrentDirectory
in interfaceGenericFileOperations<File>
- Parameters:
path
- the path to change to- Throws:
GenericFileOperationFailedException
- can be thrown
-
changeToParentDirectory
Description copied from interface:GenericFileOperations
Change the current remote directory to the parent- Specified by:
changeToParentDirectory
in interfaceGenericFileOperations<File>
- Throws:
GenericFileOperationFailedException
- can be thrown
-
getCurrentDirectory
Description copied from interface:GenericFileOperations
Gets the current remote directory- Specified by:
getCurrentDirectory
in interfaceGenericFileOperations<File>
- Returns:
- the current directory path
- Throws:
GenericFileOperationFailedException
- can be thrown
-
retrieveFile
public boolean retrieveFile(String name, org.apache.camel.Exchange exchange, long size) throws GenericFileOperationFailedException Description copied from interface:GenericFileOperations
Retrieves the file- Specified by:
retrieveFile
in interfaceGenericFileOperations<File>
- Parameters:
name
- name of the fileexchange
- stream to write the content of the file intosize
- the total file size to retrieve, if possible to determine- Returns:
- true if file has been retrieved, false if not
- Throws:
GenericFileOperationFailedException
- can be thrown
-
releaseRetrievedFileResources
public void releaseRetrievedFileResources(org.apache.camel.Exchange exchange) throws GenericFileOperationFailedException Description copied from interface:GenericFileOperations
Releases the resources consumed by a retrieved file- Specified by:
releaseRetrievedFileResources
in interfaceGenericFileOperations<File>
- Parameters:
exchange
- exchange with the content of the file- Throws:
GenericFileOperationFailedException
- can be thrown
-
storeFile
public boolean storeFile(String fileName, org.apache.camel.Exchange exchange, long size) throws GenericFileOperationFailedException Description copied from interface:GenericFileOperations
Stores the content as a new remote file (upload)- Specified by:
storeFile
in interfaceGenericFileOperations<File>
- Parameters:
fileName
- name of new fileexchange
- with the content content of the filesize
- the total file size to store, if possible to determine- Returns:
- true if the file was stored, false if not
- Throws:
GenericFileOperationFailedException
- can be thrown
-