Class SerializableEntity

    • Field Detail

      • serializable

        private final java.io.Serializable serializable
    • Constructor Detail

      • SerializableEntity

        public SerializableEntity​(java.io.Serializable serializable,
                                  ContentType contentType,
                                  java.lang.String contentEncoding)
        Creates new instance of this class.
        Parameters:
        serializable - the serializable object.
        contentType - the content type.
        contentEncoding - the content encoding.
      • SerializableEntity

        public SerializableEntity​(java.io.Serializable serializable,
                                  ContentType contentType)
        Creates new instance of this class.
        Parameters:
        serializable - the serializable object.
        contentType - the content type.
    • Method Detail

      • getContent

        public final java.io.InputStream getContent()
                                             throws java.io.IOException,
                                                    java.lang.IllegalStateException
        Description copied from interface: HttpEntity
        Returns a content stream of the entity. Repeatable entities are expected to create a new instance of InputStream for each invocation of this method and therefore can be consumed multiple times. Entities that are not repeatable are expected to return the same InputStream instance and therefore may not be consumed more than once.

        If this entity belongs to an incoming HTTP message, calling InputStream.close() on the returned InputStream will try to consume the complete entity content to keep the connection alive. In cases where this is undesired, e.g. when only a small part of the content is relevant and consuming the complete entity content would be too inefficient, only the HTTP message from which this entity was obtained should be closed (if supported).

        IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated after the InputStream.close() method is invoked.

        Returns:
        content stream of the entity.
        Throws:
        java.io.IOException - if the stream could not be created
        java.lang.IllegalStateException
        See Also:
        HttpEntity.isRepeatable()
      • getContentLength

        public final long getContentLength()
        Description copied from interface: EntityDetails
        Returns length of the entity, if known.
      • isRepeatable

        public final boolean isRepeatable()
        Description copied from interface: HttpEntity
        Tells if the entity is capable of producing its data more than once. A repeatable entity's getContent() and writeTo(OutputStream) methods can be called more than once whereas a non-repeatable entity's can not.
        Specified by:
        isRepeatable in interface HttpEntity
        Overrides:
        isRepeatable in class AbstractHttpEntity
        Returns:
        true if the entity is repeatable, false otherwise.
      • isStreaming

        public final boolean isStreaming()
        Description copied from interface: HttpEntity
        Tells whether this entity depends on an underlying stream. Streamed entities that read data directly from the socket should return true. Self-contained entities should return false. Wrapping entities should delegate this call to the wrapped entity.
        Returns:
        true if the entity content is streamed, false otherwise
      • writeTo

        public final void writeTo​(java.io.OutputStream outStream)
                           throws java.io.IOException
        Description copied from interface: HttpEntity
        Writes the entity content out to the output stream.

        IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.

        Specified by:
        writeTo in interface HttpEntity
        Overrides:
        writeTo in class AbstractHttpEntity
        Parameters:
        outStream - the output stream to write entity content to
        Throws:
        java.io.IOException - if an I/O error occurs
      • close

        public final void close()
                         throws java.io.IOException
        Throws:
        java.io.IOException