Package groovyx.net.http
Class HttpResponseDecorator
- java.lang.Object
-
- groovyx.net.http.HttpResponseDecorator
-
- All Implemented Interfaces:
org.apache.http.HttpMessage
,org.apache.http.HttpResponse
public class HttpResponseDecorator extends java.lang.Object implements org.apache.http.HttpResponse
This class is a wrapper forHttpResponse
, which allows for simplified header access, as well as carrying the auto-parsed response data. (seeHTTPBuilder.parseResponse(HttpResponse, Object)
).- Since:
- 0.5.0
- See Also:
HttpResponseDecorator.HeadersDecorator
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
HttpResponseDecorator.HeadersDecorator
This class is returned bygetHeaders()
.
-
Field Summary
Fields Modifier and Type Field Description (package private) HttpContextDecorator
context
(package private) HttpResponseDecorator.HeadersDecorator
headers
(package private) org.apache.http.HttpResponse
responseBase
(package private) java.lang.Object
responseData
-
Constructor Summary
Constructors Constructor Description HttpResponseDecorator(org.apache.http.HttpResponse base, HttpContextDecorator context, java.lang.Object parsedResponse)
HttpResponseDecorator(org.apache.http.HttpResponse base, java.lang.Object parsedResponse)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addHeader(java.lang.String arg0, java.lang.String arg1)
void
addHeader(org.apache.http.Header arg0)
boolean
containsHeader(java.lang.String arg0)
org.apache.http.Header[]
getAllHeaders()
java.lang.String
getContentType()
Get the content-type for this response.HttpContextDecorator
getContext()
Get the execution context used during this requestjava.lang.Object
getData()
Return the parsed data from this response body.org.apache.http.HttpEntity
getEntity()
org.apache.http.Header
getFirstHeader(java.lang.String arg0)
HttpResponseDecorator.HeadersDecorator
getHeaders()
Return aHttpResponseDecorator.HeadersDecorator
, which provides a more Groovy API for accessing response headers.org.apache.http.Header[]
getHeaders(java.lang.String arg0)
org.apache.http.Header
getLastHeader(java.lang.String arg0)
java.util.Locale
getLocale()
org.apache.http.params.HttpParams
getParams()
org.apache.http.ProtocolVersion
getProtocolVersion()
int
getStatus()
Get the response status code.org.apache.http.StatusLine
getStatusLine()
org.apache.http.HeaderIterator
headerIterator()
org.apache.http.HeaderIterator
headerIterator(java.lang.String arg0)
boolean
isSuccess()
Quickly determine if the request resulted in an error code.void
removeHeader(org.apache.http.Header arg0)
void
removeHeaders(java.lang.String arg0)
(package private) void
setData(java.lang.Object responseData)
void
setEntity(org.apache.http.HttpEntity arg0)
void
setHeader(java.lang.String arg0, java.lang.String arg1)
void
setHeader(org.apache.http.Header arg0)
void
setHeaders(org.apache.http.Header[] arg0)
void
setLocale(java.util.Locale arg0)
void
setParams(org.apache.http.params.HttpParams arg0)
void
setReasonPhrase(java.lang.String arg0)
void
setStatusCode(int arg0)
void
setStatusLine(org.apache.http.ProtocolVersion arg0, int arg1)
void
setStatusLine(org.apache.http.ProtocolVersion arg0, int arg1, java.lang.String arg2)
void
setStatusLine(org.apache.http.StatusLine arg0)
-
-
-
Field Detail
-
headers
HttpResponseDecorator.HeadersDecorator headers
-
responseBase
org.apache.http.HttpResponse responseBase
-
context
HttpContextDecorator context
-
responseData
java.lang.Object responseData
-
-
Constructor Detail
-
HttpResponseDecorator
public HttpResponseDecorator(org.apache.http.HttpResponse base, java.lang.Object parsedResponse)
-
HttpResponseDecorator
public HttpResponseDecorator(org.apache.http.HttpResponse base, HttpContextDecorator context, java.lang.Object parsedResponse)
-
-
Method Detail
-
getHeaders
public HttpResponseDecorator.HeadersDecorator getHeaders()
Return aHttpResponseDecorator.HeadersDecorator
, which provides a more Groovy API for accessing response headers.- Returns:
- the headers for this response
-
isSuccess
public boolean isSuccess()
Quickly determine if the request resulted in an error code.- Returns:
- true if the response code is within the range of
Status.SUCCESS
-
getStatus
public int getStatus()
Get the response status code.- Returns:
- the HTTP response code.
- See Also:
StatusLine.getStatusCode()
-
getContentType
public java.lang.String getContentType()
Get the content-type for this response.- Returns:
- the content-type string, without any charset information.
- See Also:
ParserRegistry.getContentType(HttpResponse)
-
getData
public java.lang.Object getData()
Return the parsed data from this response body.- Returns:
- the parsed response object, or
null
if the response does not contain any data.
-
setData
void setData(java.lang.Object responseData)
-
getContext
public HttpContextDecorator getContext()
Get the execution context used during this request- Returns:
- the
HttpContext
- See Also:
ExecutionContext
-
getEntity
public org.apache.http.HttpEntity getEntity()
- Specified by:
getEntity
in interfaceorg.apache.http.HttpResponse
-
getLocale
public java.util.Locale getLocale()
- Specified by:
getLocale
in interfaceorg.apache.http.HttpResponse
-
getStatusLine
public org.apache.http.StatusLine getStatusLine()
- Specified by:
getStatusLine
in interfaceorg.apache.http.HttpResponse
-
setEntity
public void setEntity(org.apache.http.HttpEntity arg0)
- Specified by:
setEntity
in interfaceorg.apache.http.HttpResponse
-
setLocale
public void setLocale(java.util.Locale arg0)
- Specified by:
setLocale
in interfaceorg.apache.http.HttpResponse
-
setReasonPhrase
public void setReasonPhrase(java.lang.String arg0) throws java.lang.IllegalStateException
- Specified by:
setReasonPhrase
in interfaceorg.apache.http.HttpResponse
- Throws:
java.lang.IllegalStateException
-
setStatusCode
public void setStatusCode(int arg0) throws java.lang.IllegalStateException
- Specified by:
setStatusCode
in interfaceorg.apache.http.HttpResponse
- Throws:
java.lang.IllegalStateException
-
setStatusLine
public void setStatusLine(org.apache.http.StatusLine arg0)
- Specified by:
setStatusLine
in interfaceorg.apache.http.HttpResponse
-
setStatusLine
public void setStatusLine(org.apache.http.ProtocolVersion arg0, int arg1)
- Specified by:
setStatusLine
in interfaceorg.apache.http.HttpResponse
-
setStatusLine
public void setStatusLine(org.apache.http.ProtocolVersion arg0, int arg1, java.lang.String arg2)
- Specified by:
setStatusLine
in interfaceorg.apache.http.HttpResponse
-
addHeader
public void addHeader(org.apache.http.Header arg0)
- Specified by:
addHeader
in interfaceorg.apache.http.HttpMessage
-
addHeader
public void addHeader(java.lang.String arg0, java.lang.String arg1)
- Specified by:
addHeader
in interfaceorg.apache.http.HttpMessage
-
containsHeader
public boolean containsHeader(java.lang.String arg0)
- Specified by:
containsHeader
in interfaceorg.apache.http.HttpMessage
-
getAllHeaders
public org.apache.http.Header[] getAllHeaders()
- Specified by:
getAllHeaders
in interfaceorg.apache.http.HttpMessage
-
getFirstHeader
public org.apache.http.Header getFirstHeader(java.lang.String arg0)
- Specified by:
getFirstHeader
in interfaceorg.apache.http.HttpMessage
-
getHeaders
public org.apache.http.Header[] getHeaders(java.lang.String arg0)
- Specified by:
getHeaders
in interfaceorg.apache.http.HttpMessage
-
getLastHeader
public org.apache.http.Header getLastHeader(java.lang.String arg0)
- Specified by:
getLastHeader
in interfaceorg.apache.http.HttpMessage
-
getParams
public org.apache.http.params.HttpParams getParams()
- Specified by:
getParams
in interfaceorg.apache.http.HttpMessage
-
getProtocolVersion
public org.apache.http.ProtocolVersion getProtocolVersion()
- Specified by:
getProtocolVersion
in interfaceorg.apache.http.HttpMessage
-
headerIterator
public org.apache.http.HeaderIterator headerIterator()
- Specified by:
headerIterator
in interfaceorg.apache.http.HttpMessage
-
headerIterator
public org.apache.http.HeaderIterator headerIterator(java.lang.String arg0)
- Specified by:
headerIterator
in interfaceorg.apache.http.HttpMessage
-
removeHeader
public void removeHeader(org.apache.http.Header arg0)
- Specified by:
removeHeader
in interfaceorg.apache.http.HttpMessage
-
removeHeaders
public void removeHeaders(java.lang.String arg0)
- Specified by:
removeHeaders
in interfaceorg.apache.http.HttpMessage
-
setHeader
public void setHeader(org.apache.http.Header arg0)
- Specified by:
setHeader
in interfaceorg.apache.http.HttpMessage
-
setHeader
public void setHeader(java.lang.String arg0, java.lang.String arg1)
- Specified by:
setHeader
in interfaceorg.apache.http.HttpMessage
-
setHeaders
public void setHeaders(org.apache.http.Header[] arg0)
- Specified by:
setHeaders
in interfaceorg.apache.http.HttpMessage
-
setParams
public void setParams(org.apache.http.params.HttpParams arg0)
- Specified by:
setParams
in interfaceorg.apache.http.HttpMessage
-
-