Package org.craftercms.commons.file.stores

Interface RemoteFile

All Known Implementing Classes:
ResourceBasedRemoteFile
public interface RemoteFile
Represents a file stored remotely.
Author:
avasquez

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getContentLength()
    Returns the content length of the file.
    InputStream
    getInputStream()
    Returns an input stream to the content of the file.
    RemotePath
    getPath()
    Returns information about the path of the file in the remote store.
    org.springframework.core.io.Resource
    toResource()
    Returns the remote file as a Spring Resource.

  • Method Details

    • getPath

      RemotePath getPath()
      Returns information about the path of the file in the remote store.

    • getInputStream

      InputStream getInputStream() throws IOException
      Returns an input stream to the content of the file.
      Throws:
      IOException - if an error occurs while trying to access the file content

    • getContentLength

      long getContentLength() throws IOException
      Returns the content length of the file.
      Throws:
      IOException - if an error occurs while trying to access the file

    • toResource

      org.springframework.core.io.Resource toResource() throws IOException
      Returns the remote file as a Spring Resource.
      Throws:
      IOException - if the file can't be resolved successfully as a resource