Package com.ning.http.client.providers.grizzly

Class GrizzlyResponseBodyPart

java.lang.Object

com.ning.http.client.HttpResponseBodyPart

com.ning.http.client.providers.grizzly.GrizzlyResponseBodyPart

public class GrizzlyResponseBodyPart
extends HttpResponseBodyPart

HttpResponseBodyPart implementation using the Grizzly 2.0 HTTP client codec.

Since:

1.7.0

Author:

The Grizzly Team

Constructor Summary

Constructors

Constructor	Description
GrizzlyResponseBodyPart(org.glassfish.grizzly.http.HttpContent content, org.glassfish.grizzly.Connection connection)	Deprecated.
GrizzlyResponseBodyPart(org.glassfish.grizzly.http.HttpContent content, org.glassfish.grizzly.filterchain.FilterChainContext context)

Method Summary

Modifier and Type	Method	Description
ByteBuffer	getBodyByteBuffer()	Return a ByteBuffer that wraps the actual bytes read from the response's chunk.
byte[]	getBodyPartBytes()	Return the response body's part bytes received.
PauseHandler	getPauseHandler()	Retrieves a PauseHandler to pause/resume event processing.
boolean	isLast()	Return true if this is the last part.
boolean	isUnderlyingConnectionToBeClosed()	Return true of the underlying connection will be closed once the response has been fully processed.
int	length()	Return length of this part in bytes.
void	markUnderlyingConnectionAsToBeClosed()	Close the underlying connection once the processing has completed.
int	writeTo(OutputStream outputStream)	Write the available bytes to the OutputStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GrizzlyResponseBodyPart

public GrizzlyResponseBodyPart(org.glassfish.grizzly.http.HttpContent content,
 org.glassfish.grizzly.filterchain.FilterChainContext context)

GrizzlyResponseBodyPart

@Deprecated
public GrizzlyResponseBodyPart(org.glassfish.grizzly.http.HttpContent content,
 org.glassfish.grizzly.Connection connection)

Deprecated.

Method Details

getBodyPartBytes

public byte[] getBodyPartBytes()

Description copied from class: HttpResponseBodyPart

Return the response body's part bytes received.

Specified by:

getBodyPartBytes in class HttpResponseBodyPart

Returns:

the response body's part bytes received.

writeTo

public int writeTo(OutputStream outputStream)
            throws IOException

Description copied from class: HttpResponseBodyPart

Write the available bytes to the OutputStream

Specified by:

writeTo in class HttpResponseBodyPart

Returns:

The number of bytes written

Throws:

IOException

getBodyByteBuffer

public ByteBuffer getBodyByteBuffer()

Description copied from class: HttpResponseBodyPart

Return a ByteBuffer that wraps the actual bytes read from the response's chunk. The ByteBuffer capacity is equal to the number of bytes available.

Specified by:

getBodyByteBuffer in class HttpResponseBodyPart

Returns:

ByteBuffer

isLast

public boolean isLast()

Description copied from class: HttpResponseBodyPart

Return true if this is the last part.

Overrides:

isLast in class HttpResponseBodyPart

Returns:

true if this is the last part.

markUnderlyingConnectionAsToBeClosed

public void markUnderlyingConnectionAsToBeClosed()

Description copied from class: HttpResponseBodyPart

Close the underlying connection once the processing has completed. Invoking that method means the underlying TCP connection will be closed as soon as the processing of the response is completed. That means the underlying connection will never get pooled.

Overrides:

markUnderlyingConnectionAsToBeClosed in class HttpResponseBodyPart

isUnderlyingConnectionToBeClosed

public boolean isUnderlyingConnectionToBeClosed()

Description copied from class: HttpResponseBodyPart

Return true of the underlying connection will be closed once the response has been fully processed.

Overrides:

isUnderlyingConnectionToBeClosed in class HttpResponseBodyPart

Returns:

true of the underlying connection will be closed once the response has been fully processed.

length

public int length()

Description copied from class: HttpResponseBodyPart

Return length of this part in bytes.

Specified by:

length in class HttpResponseBodyPart

getPauseHandler

public PauseHandler getPauseHandler()

Description copied from class: HttpResponseBodyPart

Retrieves a PauseHandler to pause/resume event processing. Useful when an AsyncHandler's resources are saturated, and it can't handle the body part temporarily. If the handler uses the PauseHandler.requestPause() method, it's also responsible for calling PauseHandler.resume() when it could handle the part correctly.

Overrides:

getPauseHandler in class HttpResponseBodyPart

Returns:

a PauseHandler to pause the events processing in the current http transaction.