Package org.apache.camel.component.file

Class GenericFile<T>

  • All Implemented Interfaces:
    GenericFileResumable<T>, org.apache.camel.Resumable<T,​Long>, org.apache.camel.WrappedFile<T>
    public class GenericFile<T>
extends Object
implements org.apache.camel.WrappedFile<T>, GenericFileResumable<T>
    Generic File. Specific implementations of a file based endpoint need to provide a File for transfer.

    • Constructor Detail

      • GenericFile

        public GenericFile()

      • GenericFile

        public GenericFile​(boolean probeContentType)

    • Method Detail

      • getFileSeparator

        public char getFileSeparator()

      • copyFrom

        @Deprecated
public void copyFrom​(GenericFile source,
                     GenericFile result)
        Deprecated.
        Creates a copy based on the source
        Parameters:
        source - the source
        result - the result

      • copyFromPopulateAdditional

        public void copyFromPopulateAdditional​(GenericFile<T> source,
                                       GenericFile<T> result)
        Copies additional information from the source to the result.

        Inherited classes can override this method and copy their specific data.

        Parameters:
        source - the source
        result - the result

      • bindToExchange

        public void bindToExchange​(org.apache.camel.Exchange exchange)
        Bind this GenericFile to an Exchange

      • bindToExchange

        public void bindToExchange​(org.apache.camel.Exchange exchange,
                           boolean isProbeContentTypeFromEndpoint)
        Bind this GenericFile to an Exchange

      • populateHeaders

        public void populateHeaders​(GenericFileMessage<T> message,
                            boolean isProbeContentTypeFromEndpoint)
        Populates the GenericFileMessage relevant headers
        Parameters:
        message - the message to populate with headers

      • isAbsolute

        protected boolean isAbsolute​(String name)

      • normalizePath

        protected String normalizePath​(String name)

      • changeFileName

        public void changeFileName​(String newName)
        Changes the name of this remote file. This method alters the absolute and relative names as well.
        Parameters:
        newName - the new name

      • getRelativeFilePath

        public String getRelativeFilePath()

      • setRelativeFilePath

        public void setRelativeFilePath​(String relativeFilePath)

      • getFileName

        public String getFileName()

      • setFileName

        public void setFileName​(String fileName)

      • getFileLength

        public long getFileLength()

      • setFileLength

        public void setFileLength​(long fileLength)

      • getLastModified

        public long getLastModified()

      • setLastModified

        public void setLastModified​(long lastModified)

      • getCharset

        public String getCharset()

      • setCharset

        public void setCharset​(String charset)

      • getExtendedAttributes

        public Map<String,​Object> getExtendedAttributes()

      • setExtendedAttributes

        public void setExtendedAttributes​(Map<String,​Object> extendedAttributes)

      • getFile

        public T getFile()
        Specified by:
        getFile in interface org.apache.camel.WrappedFile<T>

      • setFile

        public void setFile​(T file)

      • getBody

        public Object getBody()
        Specified by:
        getBody in interface org.apache.camel.WrappedFile<T>

      • setBody

        public void setBody​(Object os)

      • getParent

        public String getParent()

      • setAbsoluteFilePath

        public void setAbsoluteFilePath​(String absoluteFilePath)

      • getAbsoluteFilePath

        public String getAbsoluteFilePath()

      • isAbsolute

        public boolean isAbsolute()

      • setAbsolute

        public void setAbsolute​(boolean absolute)

      • getEndpointPath

        public String getEndpointPath()

      • setEndpointPath

        public void setEndpointPath​(String endpointPath)

      • getFileNameOnly

        public String getFileNameOnly()

      • setFileNameOnly

        public void setFileNameOnly​(String fileNameOnly)

      • isDirectory

        public boolean isDirectory()

      • setDirectory

        public void setDirectory​(boolean directory)

      • getCopyFromAbsoluteFilePath

        public String getCopyFromAbsoluteFilePath()

      • setCopyFromAbsoluteFilePath

        public void setCopyFromAbsoluteFilePath​(String copyFromAbsoluteFilePath)

      • updateLastOffset

        public void updateLastOffset​(Long offset)
        Specified by:
        updateLastOffset in interface org.apache.camel.Resumable<T,​Long>

      • getLastOffset

        public org.apache.camel.Offset<Long> getLastOffset()
        Specified by:
        getLastOffset in interface org.apache.camel.Resumable<T,​Long>

      • getAddressable

        public T getAddressable()
        Specified by:
        getAddressable in interface org.apache.camel.Resumable<T,​Long>

      • normalizePathToProtocol

        protected String normalizePathToProtocol​(String path)
        Fixes the path separator to be according to the protocol