Package org.apache.http.entity.mime

Class MultipartEntity

java.lang.Object
org.apache.http.entity.mime.MultipartEntity
All Implemented Interfaces:
HttpEntity
@Deprecated public class MultipartEntity extends Object implements HttpEntity
Deprecated.
4.3 Use MultipartEntityBuilder.
Multipart/form coded HTTP entity consisting of multiple body parts.
Since:
4.0

  • Constructor Details

    • MultipartEntity

      public MultipartEntity(HttpMultipartMode mode, String boundary, Charset charset)
      Deprecated.
      Creates an instance using the specified parameters
      Parameters:
      mode - the mode to use, may be null, in which case HttpMultipartMode.STRICT is used
      boundary - the boundary string, may be null, in which case generateBoundary() is invoked to create the string
      charset - the character set to use, may be null, in which case MIME.DEFAULT_CHARSET - i.e. US-ASCII - is used.

    • MultipartEntity

      public MultipartEntity(HttpMultipartMode mode)
      Deprecated.
      Creates an instance using the specified HttpMultipartMode mode. Boundary and charset are set to null.
      Parameters:
      mode - the desired mode

    • MultipartEntity

      public MultipartEntity()
      Deprecated.
      Creates an instance using mode HttpMultipartMode.STRICT

  • Method Details

    • addPart

      public void addPart(FormBodyPart bodyPart)
      Deprecated.

    • addPart

      public void addPart(String name, ContentBody contentBody)
      Deprecated.

    • isRepeatable

      public boolean isRepeatable()
      Deprecated.
      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
      Returns:
      true if the entity is repeatable, false otherwise.

    • isChunked

      public boolean isChunked()
      Deprecated.
      Description copied from interface: HttpEntity
      Tells about chunked encoding for this entity. The primary purpose of this method is to indicate whether chunked encoding should be used when the entity is sent. For entities that are received, it can also indicate whether the entity was received with chunked encoding.

      The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.

      Specified by:
      isChunked in interface HttpEntity
      Returns:
      true if chunked encoding is preferred for this entity, or false if it is not

    • isStreaming

      public boolean isStreaming()
      Deprecated.
      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.
      Specified by:
      isStreaming in interface HttpEntity
      Returns:
      true if the entity content is streamed, false otherwise

    • getContentLength

      public long getContentLength()
      Deprecated.
      Description copied from interface: HttpEntity
      Tells the length of the content, if known.
      Specified by:
      getContentLength in interface HttpEntity
      Returns:
      the number of bytes of the content, or a negative number if unknown. If the content length is known but exceeds Long.MAX_VALUE, a negative number is returned.

    • getContentType

      public Header getContentType()
      Deprecated.
      Description copied from interface: HttpEntity
      Obtains the Content-Type header, if known. This is the header that should be used when sending the entity, or the one that was received with the entity. It can include a charset attribute.
      Specified by:
      getContentType in interface HttpEntity
      Returns:
      the Content-Type header for this entity, or null if the content type is unknown

    • getContentEncoding

      public Header getContentEncoding()
      Deprecated.
      Description copied from interface: HttpEntity
      Obtains the Content-Encoding header, if known. This is the header that should be used when sending the entity, or the one that was received with the entity. Wrapping entities that modify the content encoding should adjust this header accordingly.
      Specified by:
      getContentEncoding in interface HttpEntity
      Returns:
      the Content-Encoding header for this entity, or null if the content encoding is unknown

    • consumeContent

      public void consumeContent() throws IOException, UnsupportedOperationException
      Deprecated.
      Description copied from interface: HttpEntity
      This method is deprecated since version 4.1. Please use standard java convention to ensure resource deallocation by calling InputStream.close() on the input stream returned by HttpEntity.getContent()

      This method is called to indicate that the content of this entity is no longer required. All entity implementations are expected to release all allocated resources as a result of this method invocation. Content streaming entities are also expected to dispose of the remaining content, if any. Wrapping entities should delegate this call to the wrapped entity.

      This method is of particular importance for entities being received from a connection. The entity needs to be consumed completely in order to re-use the connection with keep-alive.

      Specified by:
      consumeContent in interface HttpEntity
      Throws:
      IOException - if an I/O error occurs.
      UnsupportedOperationException
      See Also:

    • getContent

      public InputStream getContent() throws IOException, UnsupportedOperationException
      Deprecated.
      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.

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

      Specified by:
      getContent in interface HttpEntity
      Returns:
      content stream of the entity.
      Throws:
      IOException - if the stream could not be created
      UnsupportedOperationException - if entity content cannot be represented as InputStream.
      See Also:

    • writeTo

      public void writeTo(OutputStream outStream) throws IOException
      Deprecated.
      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
      Parameters:
      outStream - the output stream to write entity content to
      Throws:
      IOException - if an I/O error occurs