de.unkrig.commons.net.http

Interface HttpMessage.Body

Enclosing class:

HttpMessage

public static interface HttpMessage.Body

The life cycle of a HttpMessage.Body is as follows:

1. Create the object by calling one of the following methods:
   • HttpMessage.body(String, Charset)
   • HttpMessage.body(InputStream)
   • HttpMessage.body(File)
   • HttpMessage.body(ConsumerWhichThrows)
2. Call exactly one of the following methods:
   • string(Charset)
   • inputStream()
   • write(OutputStream)
   • dispose()
3. Call dispose() as many times as you want

Otherwise, a resource leak will occur.

Method Summary

Modifier and Type	Method and Description
void	dispose() Releases any resources associated with this object.
java.io.InputStream	inputStream() The caller is responsible for closing the returned InputStream.
java.lang.String	string(java.nio.charset.Charset charset)
void	write(java.io.OutputStream stream) Writes the contents of the body to the given stream.

Method Detail

string

java.lang.String string(java.nio.charset.Charset charset)
                 throws java.io.IOException

Returns:

The contents of the body of an HttpMessage as a string

Throws:

java.io.IOException

See Also:

HttpMessage.Body

inputStream

java.io.InputStream inputStream()
                         throws java.io.IOException

The caller is responsible for closing the returned InputStream.

Returns:

Produces the contents of the body of an HttpMessage as a stream of bytes

Throws:

java.io.IOException

See Also:

HttpMessage.Body

write

void write(java.io.OutputStream stream)
    throws java.io.IOException

Writes the contents of the body to the given stream.

Throws:

java.io.IOException

See Also:

HttpMessage.Body

dispose

void dispose()

Releases any resources associated with this object.

See Also:

HttpMessage.Body