Package com.atlassian.confluence.core

Class UploadedResource

java.lang.Object
com.atlassian.confluence.core.UploadedResource
All Implemented Interfaces:
AttachmentResource, org.springframework.core.io.InputStreamSource, org.springframework.core.io.Resource
public class UploadedResource extends Object implements AttachmentResource
Resource wrapper for uploaded files. This will become extra handy once we get a better multipart file handling e.g. Attachments handled entirely in memory

  • Constructor Details

    • UploadedResource

      @Deprecated public UploadedResource(com.atlassian.xwork.FileUploadUtils.UploadedFile uploadedFile)
      Deprecated.
      since 9.1, use UploadedResource(UploadedFile, String) instead.

    • UploadedResource

      @Deprecated public UploadedResource(com.atlassian.xwork.FileUploadUtils.UploadedFile uploadedFile, String comment)
      Deprecated.
      since 9.1, use UploadedResource(UploadedFile, String) instead.

    • UploadedResource

      public UploadedResource(com.atlassian.struts.multipart.UploadedFile uploadedFile, String comment)
      Since:
      9.1

    • UploadedResource

      public UploadedResource(File file, String filename, String contentType, String comment)

    • UploadedResource

      @Deprecated public UploadedResource(com.atlassian.xwork.FileUploadUtils.UploadedFile uploadedFile, String comment, boolean minorEdit)
      Deprecated.
      since 9.1, use UploadedResource(File, String, String, String, boolean, boolean) instead.

    • UploadedResource

      public UploadedResource(File file, String filename, String contentType, String comment, boolean minorEdit, boolean hidden)
      Creates an upload resource.
      Parameters:
      file - the file to be uploaded, cannot be null
      comment - a comment for the upload. Can be null
      minorEdit - boolean indicating whether this upload is a minor edit or not. Minor edit set to true means that this upload should not generate any notifications, but it will be added to the activity stream.
      hidden - boolean indicating whether we want this upload to be hidden or not. Hidden set to true means that this upload should not generate any notifications, or be added to the activity stream.

  • Method Details

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface org.springframework.core.io.Resource

    • getFile

      public File getFile()
      Specified by:
      getFile in interface org.springframework.core.io.Resource

    • getFilename

      public String getFilename() throws IllegalStateException
      Specified by:
      getFilename in interface org.springframework.core.io.Resource
      Throws:
      IllegalStateException

    • getComment

      public String getComment()
      Specified by:
      getComment in interface AttachmentResource
      Returns:
      the comment associated with the attachment or null if there is no comment

    • getInputStream

      public InputStream getInputStream() throws IOException
      Specified by:
      getInputStream in interface org.springframework.core.io.InputStreamSource
      Throws:
      IOException

    • getContentType

      public String getContentType()
      Specified by:
      getContentType in interface AttachmentResource
      Returns:
      the content/mime type of the attachment

    • getContentLength

      public long getContentLength()
      Specified by:
      getContentLength in interface AttachmentResource
      Returns:
      the content length (size of the attachment)

    • contentLength

      public long contentLength()
      Specified by:
      contentLength in interface org.springframework.core.io.Resource

    • isMinorEdit

      public boolean isMinorEdit()
      Specified by:
      isMinorEdit in interface AttachmentResource
      Returns:
      true if the attachment is a minor edit (see Attachment.isMinorEdit())

    • isHidden

      public boolean isHidden()
      Specified by:
      isHidden in interface AttachmentResource
      Returns:
      true if the attachment is hidden (see Attachment.isHidden())

    • exists

      public boolean exists()
      Specified by:
      exists in interface org.springframework.core.io.Resource

    • isOpen

      public boolean isOpen()
      Specified by:
      isOpen in interface org.springframework.core.io.Resource

    • getURL

      public URL getURL() throws IOException
      Specified by:
      getURL in interface org.springframework.core.io.Resource
      Throws:
      IOException

    • createRelative

      public org.springframework.core.io.Resource createRelative(String relativePath) throws IOException
      Specified by:
      createRelative in interface org.springframework.core.io.Resource
      Throws:
      IOException

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • isReadable

      public boolean isReadable()
      Specified by:
      isReadable in interface org.springframework.core.io.Resource

    • getURI

      public URI getURI() throws IOException
      Specified by:
      getURI in interface org.springframework.core.io.Resource
      Throws:
      IOException

    • lastModified

      public long lastModified() throws IOException
      Specified by:
      lastModified in interface org.springframework.core.io.Resource
      Throws:
      IOException