Package org.apache.hc.core5.http.message
Class BasicHttpResponse
java.lang.Object
org.apache.hc.core5.http.message.HeaderGroup
org.apache.hc.core5.http.message.BasicHttpResponse
- All Implemented Interfaces:
Serializable
,HttpMessage
,HttpResponse
,MessageHeaders
- Direct Known Subclasses:
BasicClassicHttpResponse
Basic implementation of
HttpResponse
.- Since:
- 4.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private Locale
private final ReasonPhraseCatalog
private String
private static final long
private ProtocolVersion
-
Constructor Summary
ConstructorsConstructorDescriptionBasicHttpResponse
(int code) Creates a new response.BasicHttpResponse
(int code, String reasonPhrase) Creates a new response.BasicHttpResponse
(int code, ReasonPhraseCatalog catalog, Locale locale) Creates a new response. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a header to this message.int
getCode()
Obtains the code of this response message.Obtains the locale of this response.protected String
getReason
(int code) Looks up a reason phrase.Obtains the reason phrase of this response if available.Returns protocol version ornull
when not available.void
setCode
(int code) Updates status code of this response message.void
Overwrites the first header with the same name.void
Changes the locale of this response.void
setReasonPhrase
(String reason) Updates the status line of this response with a new reason phrase.void
setVersion
(ProtocolVersion version) Sets protocol version.toString()
Methods inherited from class org.apache.hc.core5.http.message.HeaderGroup
addHeader, clear, containsHeader, countHeaders, getCondensedHeader, getFirstHeader, getHeader, getHeaders, getHeaders, getLastHeader, headerIterator, headerIterator, removeHeader, removeHeaders, removeHeaders, setHeader, setHeaders
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.hc.core5.http.HttpMessage
addHeader, removeHeader, removeHeaders, setHeader, setHeaders
Methods inherited from interface org.apache.hc.core5.http.MessageHeaders
containsHeader, countHeaders, getFirstHeader, getHeader, getHeaders, getHeaders, getLastHeader, headerIterator, headerIterator
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
reasonCatalog
-
version
-
locale
-
code
private int code -
reasonPhrase
-
-
Constructor Details
-
BasicHttpResponse
Creates a new response.- Parameters:
code
- the status codecatalog
- the reason phrase catalog, ornull
to disable automatic reason phrase lookuplocale
- the locale for looking up reason phrases, ornull
for the system locale
-
BasicHttpResponse
Creates a new response.- Parameters:
code
- the status code of the responsereasonPhrase
- the reason phrase to the status code, ornull
-
BasicHttpResponse
public BasicHttpResponse(int code) Creates a new response.- Parameters:
code
- the status code of the response
-
-
Method Details
-
addHeader
Description copied from interface:HttpMessage
Adds a header to this message. The header will be appended to the end of the list.- Specified by:
addHeader
in interfaceHttpMessage
- Parameters:
name
- the name of the header.value
- the value of the header, taken as the value'sObject.toString()
.
-
setHeader
Description copied from interface:HttpMessage
Overwrites the first header with the same name. The new header will be appended to the end of the list, if no header with the given name can be found.- Specified by:
setHeader
in interfaceHttpMessage
- Parameters:
name
- the name of the header.value
- the value of the header, taken as the value'sObject.toString()
.
-
setVersion
Description copied from interface:HttpMessage
Sets protocol version.For incoming messages it represents protocol version this message was transmitted with. For outgoing messages it represents a hint what protocol version should be used to transmit the message.
- Specified by:
setVersion
in interfaceHttpMessage
-
getVersion
Description copied from interface:HttpMessage
Returns protocol version ornull
when not available.For incoming messages it represents protocol version this message was transmitted with. For outgoing messages it represents a hint what protocol version should be used to transmit the message.
- Specified by:
getVersion
in interfaceHttpMessage
-
getCode
public int getCode()Description copied from interface:HttpResponse
Obtains the code of this response message.- Specified by:
getCode
in interfaceHttpResponse
- Returns:
- the status code.
-
getLocale
Description copied from interface:HttpResponse
Obtains the locale of this response. The locale is used to determine the reason phrase for thestatus code
. It can be changed usingsetLocale
.- Specified by:
getLocale
in interfaceHttpResponse
- Returns:
- the locale of this response, never
null
-
setCode
public void setCode(int code) Description copied from interface:HttpResponse
Updates status code of this response message.- Specified by:
setCode
in interfaceHttpResponse
- Parameters:
code
- the HTTP status code.- See Also:
-
getReasonPhrase
Description copied from interface:HttpResponse
Obtains the reason phrase of this response if available.- Specified by:
getReasonPhrase
in interfaceHttpResponse
- Returns:
- the reason phrase.
-
setReasonPhrase
Description copied from interface:HttpResponse
Updates the status line of this response with a new reason phrase.- Specified by:
setReasonPhrase
in interfaceHttpResponse
- Parameters:
reason
- the new reason phrase as a single-line string, ornull
to unset the reason phrase
-
setLocale
Description copied from interface:HttpResponse
Changes the locale of this response.- Specified by:
setLocale
in interfaceHttpResponse
- Parameters:
locale
- the new locale
-
getReason
Looks up a reason phrase. This method evaluates the currently set catalog and locale. It also handles a missing catalog.- Parameters:
code
- the status code for which to look up the reason- Returns:
- the reason phrase, or
null
if there is none
-
toString
- Overrides:
toString
in classHeaderGroup
-