Class ContentStream

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.devents.ContentStream
All Implemented Interfaces:
Serializable

public class ContentStream extends ValueClass
This class contains information about a document related stream. Such a stream might be a document version, attachment, preview content, fulltext content or signature.
Since:
12.02.002.002
See Also:
  • Field Details

    • stream

      protected InputStream stream
      Document related stream.
    • headers

      protected Map<String,List<String>> headers
      Optional HTTP headers. This headers can provide additional information for streams being downloaded. E.g. supply byte range headers for parts of video files.
    • contentType

      protected String contentType
      Content type (or MIME type). Either set content type or fileExtension to describe the stream content.
    • fileExtension

      protected String fileExtension
      File extension without dot. Either set file extension or contentType to describe the stream content.
    • contentLength

      protected long contentLength
      Stream content length. This member is set to the number of bytes in the stream. If the length is unknown set ContentStreamC.CONTENT_LENGTH_UNKNOWN. A wrong content length can client applications cause to hang.
    • responseCode

      protected int responseCode
      HTTP response code for streams being downloaded. This status should be set as 200 (HTTP OK) if the entire document has been processed. If DocumentProcessor.process(ContentStream) receives an object that defines byte range headers in headers, return the appropriate byte range headers and set this member as 206 (HTTP Partial Content). Byte ranges are usually requested for video files. This element is ignored for streams being uploaded.
      See Also:
  • Constructor Details

    • ContentStream

      public ContentStream()
    • ContentStream

      public ContentStream(ContentStream rhs)
  • Method Details

    • getStream

      public InputStream getStream()
    • setStream

      public void setStream(InputStream stream)
    • getHeaders

      public Map<String,List<String>> getHeaders()
    • setHeaders

      public void setHeaders(Map<String,List<String>> headers)
    • getContentLength

      public long getContentLength()
    • setContentLength

      public void setContentLength(long contentLength)
    • getContentType

      public String getContentType()
    • setContentType

      public void setContentType(String contentType)
    • getResponseCode

      public int getResponseCode()
    • setResponseCode

      public void setResponseCode(int responseCode)
    • getFileExtension

      public String getFileExtension()
    • setFileExtension

      public void setFileExtension(String fileExtension)
    • toString

      public String toString()
      Overrides:
      toString in class Object