Package org.apache.http
Interface HttpResponse
-
- All Superinterfaces:
HttpMessage
- All Known Subinterfaces:
CloseableHttpResponse
- All Known Implementing Classes:
BasicHttpResponse
public interface HttpResponse extends HttpMessage
After receiving and interpreting a request message, a server responds with an HTTP response message.Response = Status-Line *(( general-header | response-header | entity-header ) CRLF) CRLF [ message-body ]
- Since:
- 4.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description HttpEntity
getEntity()
Obtains the message entity of this response, if any.Locale
getLocale()
Obtains the locale of this response.StatusLine
getStatusLine()
Obtains the status line of this response.void
setEntity(HttpEntity entity)
Associates a response entity with this response.void
setLocale(Locale loc)
Changes the locale of this response.void
setReasonPhrase(String reason)
Updates the status line of this response with a new reason phrase.void
setStatusCode(int code)
Updates the status line of this response with a new status code.void
setStatusLine(ProtocolVersion ver, int code)
Sets the status line of this response.void
setStatusLine(ProtocolVersion ver, int code, String reason)
Sets the status line of this response with a reason phrase.void
setStatusLine(StatusLine statusline)
Sets the status line of this response.-
Methods inherited from interface org.apache.http.HttpMessage
addHeader, addHeader, containsHeader, getAllHeaders, getFirstHeader, getHeaders, getLastHeader, getParams, getProtocolVersion, headerIterator, headerIterator, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setParams
-
-
-
-
Method Detail
-
getStatusLine
StatusLine getStatusLine()
Obtains the status line of this response. The status line can be set using one of thesetStatusLine
methods, or it can be initialized in a constructor.- Returns:
- the status line, or
null
if not yet set
-
setStatusLine
void setStatusLine(StatusLine statusline)
Sets the status line of this response.- Parameters:
statusline
- the status line of this response
-
setStatusLine
void setStatusLine(ProtocolVersion ver, int code)
Sets the status line of this response. The reason phrase will be determined based on the currentlocale
.- Parameters:
ver
- the HTTP versioncode
- the status code
-
setStatusLine
void setStatusLine(ProtocolVersion ver, int code, String reason)
Sets the status line of this response with a reason phrase.- Parameters:
ver
- the HTTP versioncode
- the status codereason
- the reason phrase, ornull
to omit
-
setStatusCode
void setStatusCode(int code) throws IllegalStateException
Updates the status line of this response with a new status code.- Parameters:
code
- the HTTP status code.- Throws:
IllegalStateException
- if the status line has not be set- See Also:
HttpStatus
,setStatusLine(StatusLine)
,setStatusLine(ProtocolVersion,int)
-
setReasonPhrase
void setReasonPhrase(String reason) throws IllegalStateException
Updates the status line of this response with a new reason phrase.- Parameters:
reason
- the new reason phrase as a single-line string, ornull
to unset the reason phrase- Throws:
IllegalStateException
- if the status line has not be set- See Also:
setStatusLine(StatusLine)
,setStatusLine(ProtocolVersion,int)
-
getEntity
HttpEntity getEntity()
Obtains the message entity of this response, if any. The entity is provided by callingsetEntity
.- Returns:
- the response entity, or
null
if there is none
-
setEntity
void setEntity(HttpEntity entity)
Associates a response entity with this response.Please note that if an entity has already been set for this response and it depends on an input stream (
HttpEntity.isStreaming()
returnstrue
), it must be fully consumed in order to ensure release of resources.- Parameters:
entity
- the entity to associate with this response, ornull
to unset- See Also:
HttpEntity.isStreaming()
,EntityUtils.updateEntity(HttpResponse, HttpEntity)
-
getLocale
Locale getLocale()
Obtains the locale of this response. The locale is used to determine the reason phrase for thestatus code
. It can be changed usingsetLocale
.- Returns:
- the locale of this response, never
null
-
setLocale
void setLocale(Locale loc)
Changes the locale of this response.- Parameters:
loc
- the new locale
-
-