org.asynchttpclient.webdav

Class WebDavResponse

java.lang.Object

org.asynchttpclient.webdav.WebDavResponse

All Implemented Interfaces:

Response

public class WebDavResponse
extends Object
implements Response

Customized Response which add support for getting the response's body as an XML document (@link WebDavResponse#getBodyAsXML}

Nested Class Summary

Nested classes/interfaces inherited from interface org.asynchttpclient.Response

Response.ResponseBuilder

Method Summary

Modifier and Type	Method and Description
Document	getBodyAsXML()
String	getContentType() Return the content-type header value.
List<io.netty.handler.codec.http.cookie.Cookie>	getCookies()
String	getHeader(CharSequence name)
io.netty.handler.codec.http.HttpHeaders	getHeaders()
List<String>	getHeaders(CharSequence name) Return a List of the response header value.
SocketAddress	getLocalAddress() Get the local address that the client initiated the request from.
SocketAddress	getRemoteAddress() Get the remote address that the client initiated the request to.
String	getResponseBody() Return the entire response body as a String.
String	getResponseBody(Charset charset) Return the entire response body as a String.
ByteBuffer	getResponseBodyAsByteBuffer() Return the entire response body as a ByteBuffer.
byte[]	getResponseBodyAsBytes() Return the entire response body as a byte[].
InputStream	getResponseBodyAsStream() Returns an input stream for the response body.
int	getStatusCode() Returns the status code for the request.
String	getStatusText() Returns the status text for the request.
Uri	getUri() Return the request Uri.
boolean	hasResponseBody() Return true if the response's body has been computed by an AsyncHandler.
boolean	hasResponseHeaders() Return true if the response's headers has been computed by an AsyncHandler It will return false if the either AsyncHandler.onStatusReceived(HttpResponseStatus) or AsyncHandler.onHeadersReceived(HttpHeaders) returned AsyncHandler.State.ABORT
boolean	hasResponseStatus() Return true if the response's status has been computed by an AsyncHandler
boolean	isRedirected() Return true if the response redirects to another object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.asynchttpclient.Response

toString

Method Detail

getStatusCode

public int getStatusCode()

Description copied from interface: Response

Returns the status code for the request.

Specified by:

getStatusCode in interface Response

Returns:

The status code

getStatusText

public String getStatusText()

Description copied from interface: Response

Returns the status text for the request.

Specified by:

getStatusText in interface Response

Returns:

The status text

getResponseBodyAsBytes

public byte[] getResponseBodyAsBytes()

Description copied from interface: Response

Return the entire response body as a byte[].

Specified by:

getResponseBodyAsBytes in interface Response

Returns:

the entire response body as a byte[].

getResponseBodyAsByteBuffer

public ByteBuffer getResponseBodyAsByteBuffer()

Description copied from interface: Response

Return the entire response body as a ByteBuffer.

Specified by:

getResponseBodyAsByteBuffer in interface Response

Returns:

the entire response body as a ByteBuffer.

getResponseBodyAsStream

public InputStream getResponseBodyAsStream()

Description copied from interface: Response

Returns an input stream for the response body. Note that you should not try to get this more than once, and that you should not close the stream.

Specified by:

getResponseBodyAsStream in interface Response

Returns:

The input stream

getResponseBody

public String getResponseBody()

Description copied from interface: Response

Return the entire response body as a String.

Specified by:

getResponseBody in interface Response

Returns:

the entire response body as a String.

getResponseBody

public String getResponseBody(Charset charset)

Description copied from interface: Response

Return the entire response body as a String.

Specified by:

getResponseBody in interface Response

Parameters:

charset - the charset to use when decoding the stream

Returns:

the entire response body as a String.

getUri

public Uri getUri()

Description copied from interface: Response

Return the request Uri. Note that if the request got redirected, the value of the Uri will be the last valid redirect url.

Specified by:

getUri in interface Response

Returns:

the request Uri.

getContentType

public String getContentType()

Description copied from interface: Response

Return the content-type header value.

Specified by:

getContentType in interface Response

Returns:

the content-type header value.

getHeader

public String getHeader(CharSequence name)

Specified by:

getHeader in interface Response

Parameters:

name - the header name

Returns:

the first response header value

getHeaders

public List<String> getHeaders(CharSequence name)

Description copied from interface: Response

Return a List of the response header value.

Specified by:

getHeaders in interface Response

Parameters:

name - the header name

Returns:

the response header value

getHeaders

public io.netty.handler.codec.http.HttpHeaders getHeaders()

Specified by:

getHeaders in interface Response

isRedirected

public boolean isRedirected()

Description copied from interface: Response

Return true if the response redirects to another object.

Specified by:

isRedirected in interface Response

Returns:

True if the response redirects to another object.

getCookies

public List<io.netty.handler.codec.http.cookie.Cookie> getCookies()

Specified by:

getCookies in interface Response

Returns:

the list of Cookie.

hasResponseStatus

public boolean hasResponseStatus()

Description copied from interface: Response

Return true if the response's status has been computed by an AsyncHandler

Specified by:

hasResponseStatus in interface Response

Returns:

true if the response's status has been computed by an AsyncHandler

hasResponseHeaders

public boolean hasResponseHeaders()

Description copied from interface: Response

Return true if the response's headers has been computed by an AsyncHandler It will return false if the either AsyncHandler.onStatusReceived(HttpResponseStatus) or AsyncHandler.onHeadersReceived(HttpHeaders) returned AsyncHandler.State.ABORT

Specified by:

hasResponseHeaders in interface Response

Returns:

true if the response's headers has been computed by an AsyncHandler

hasResponseBody

public boolean hasResponseBody()

Description copied from interface: Response

Return true if the response's body has been computed by an AsyncHandler. It will return false if:

• either the AsyncHandler.onStatusReceived(HttpResponseStatus) returned AsyncHandler.State.ABORT
• or AsyncHandler.onHeadersReceived(HttpHeaders) returned AsyncHandler.State.ABORT
• response body was empty

Specified by:

hasResponseBody in interface Response

Returns:

true if the response's body has been computed by an AsyncHandler to new empty bytes

getRemoteAddress

public SocketAddress getRemoteAddress()

Description copied from interface: Response

Get the remote address that the client initiated the request to.

Specified by:

getRemoteAddress in interface Response

Returns:

The remote address that the client initiated the request to. May be null if asynchronous provider is unable to provide the remote address

getLocalAddress

public SocketAddress getLocalAddress()

Description copied from interface: Response

Get the local address that the client initiated the request from.

Specified by:

getLocalAddress in interface Response

Returns:

The local address that the client initiated the request from. May be null if asynchronous provider is unable to provide the local address

getBodyAsXML

public Document getBodyAsXML()