MultipartEntityBuilder
.@Deprecated public class MultipartEntity extends Object implements HttpEntity
Constructor and Description |
---|
MultipartEntity()
Deprecated.
Creates an instance using mode
HttpMultipartMode.STRICT |
MultipartEntity(HttpMultipartMode mode)
Deprecated.
Creates an instance using the specified
HttpMultipartMode mode. |
MultipartEntity(HttpMultipartMode mode,
String boundary,
Charset charset)
Deprecated.
Creates an instance using the specified parameters
|
Modifier and Type | Method and Description |
---|---|
void |
addPart(FormBodyPart bodyPart)
Deprecated.
|
void |
addPart(String name,
ContentBody contentBody)
Deprecated.
|
void |
consumeContent()
Deprecated.
This method is deprecated since version 4.1.
|
InputStream |
getContent()
Deprecated.
Returns a content stream of the entity.
|
Header |
getContentEncoding()
Deprecated.
Obtains the Content-Encoding header, if known.
|
long |
getContentLength()
Deprecated.
Tells the length of the content, if known.
|
Header |
getContentType()
Deprecated.
Obtains the Content-Type header, if known.
|
boolean |
isChunked()
Deprecated.
Tells about chunked encoding for this entity.
|
boolean |
isRepeatable()
Deprecated.
Tells if the entity is capable of producing its data more than once.
|
boolean |
isStreaming()
Deprecated.
Tells whether this entity depends on an underlying stream.
|
void |
writeTo(OutputStream outstream)
Deprecated.
Writes the entity content out to the output stream.
|
public MultipartEntity(HttpMultipartMode mode, String boundary, Charset charset)
mode
- the mode to use, may be null
, in which case HttpMultipartMode.STRICT
is usedboundary
- the boundary string, may be null
, in which case generateBoundary()
is invoked to create the stringcharset
- the character set to use, may be null
, in which case MIME.DEFAULT_CHARSET
- i.e. US-ASCII - is used.public MultipartEntity(HttpMultipartMode mode)
HttpMultipartMode
mode.
Boundary and charset are set to null
.mode
- the desired modepublic MultipartEntity()
HttpMultipartMode.STRICT
public void addPart(FormBodyPart bodyPart)
public void addPart(String name, ContentBody contentBody)
public boolean isRepeatable()
HttpEntity
isRepeatable
in interface HttpEntity
public boolean isChunked()
HttpEntity
The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.
isChunked
in interface HttpEntity
true
if chunked encoding is preferred for this
entity, or false
if it is notpublic boolean isStreaming()
HttpEntity
true
. Self-contained entities should return
false
. Wrapping entities should delegate this call
to the wrapped entity.isStreaming
in interface HttpEntity
true
if the entity content is streamed,
false
otherwisepublic long getContentLength()
HttpEntity
getContentLength
in interface HttpEntity
Long.MAX_VALUE
,
a negative number is returned.public Header getContentType()
HttpEntity
getContentType
in interface HttpEntity
null
if the content type is unknownpublic Header getContentEncoding()
HttpEntity
getContentEncoding
in interface HttpEntity
null
if the content encoding is unknownpublic void consumeContent() throws IOException, UnsupportedOperationException
HttpEntity
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.
consumeContent
in interface HttpEntity
IOException
- if an I/O error occurs.UnsupportedOperationException
and #writeTo(OutputStream)
public InputStream getContent() throws IOException, UnsupportedOperationException
HttpEntity
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.
getContent
in interface HttpEntity
IOException
- if the stream could not be createdUnsupportedOperationException
- if entity content cannot be represented as InputStream
.HttpEntity.isRepeatable()
public void writeTo(OutputStream outstream) throws IOException
HttpEntity
IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.
writeTo
in interface HttpEntity
outstream
- the output stream to write entity content toIOException
- if an I/O error occursCopyright © 2010 - 2020 Adobe. All Rights Reserved