Modifier and Type	Class and Description
public static class	HttpResponsePacket.Builder `HttpResponsePacket` message builder.

Modifier and Type	Field and Description
private boolean	allowCustomReasonPhrase Do we allow custom reason phrase.
private String	contentLanguage The value of the `Content-Language` response header.
protected HttpStatus	httpStatus Status code.
private HttpStatus	interimStatus Status of the informational (1xx) interim response (e.g. `HttpStatus#EARLY_HINTS_103` or `HttpStatus#CONINTUE_100`) that is pending serialization.
private boolean	isHtmlEncodingCustomReasonPhrase Do we need to encode HTML sensitive characters in custom reason phrase.
private Locale	locale The `Locale` of the entity body being sent by this response.
private final DataChunk	reasonPhraseC Status message.
private HttpRequestPacket	request The request that triggered this response.

Access	Constructor and Description
protected	HttpResponsePacket()

Method Summary

Modifier and Type	Method and Description
public static HttpResponsePacket.Builder	Returns: `Builder`. builder(final HttpRequestPacket request) Returns `HttpResponsePacket` builder.
public String	getContentLanguage() Returns: the value that will be used by the `Content-Language` response header
public HttpStatus	Returns: the HTTP status for this response. getHttpStatus() Gets the HTTP status for this response.
public HttpStatus	getInterimStatus() Returns: the status of the interim response pending serialization, or `null` if none is pending.
public Locale	getLocale() Returns: the `Locale` of this response.
public final String	Returns: the status reason phrase for this response. getReasonPhrase() Gets the status reason phrase for this response.
public final DataChunk	Returns: the status reason phrase for this response as `DataChunk` (avoid creation of a String object}. getReasonPhraseDC() Gets the status reason phrase for this response as `DataChunk` (avoid creation of a String object}.
public final DataChunk	Returns: the status reason phrase for this response as `DataChunk` (avoid creation of a String object}. getReasonPhraseRawDC() Gets the custom status reason phrase for this response as `DataChunk` (avoid creation of a String object}.
public HttpRequestPacket	getRequest() Returns: the request that triggered this response
public int	Returns: the status code for this response. getStatus() Gets the status code for this response.
public void	interimResponseSent() Mark the pending interim response as having been serialized.
public final boolean	Returns: `true` if custom status reason phrases are allowed for this response, or `false` otherwise. isAllowCustomReasonPhrase() Returns `true` if custom status reason phrases are allowed for this response, or `false` otherwise.
public final boolean	isCustomReasonPhraseSet()
public boolean	isHtmlEncodingCustomReasonPhrase() Returns if we need to encode HTML sensitive characters in custom reason phrase.
public boolean	isInterimResponse() Returns: `true` if an informational (1xx) interim response is pending serialization for this packet.
public final boolean	isRequest() Implements abstract org.glassfish.grizzly.http.HttpHeader.isRequest. Returns `true`, if the current `HttpHeader` represent HTTP request message, or `false` otherwise.
protected void	reset() Overrides org.glassfish.grizzly.http.HttpHeader.reset. Reset the internal state.
public final void	setAllowCustomReasonPhrase(final boolean `true` if custom status reason phrases are allowed for this response, or `false` otherwise. allowCustomReasonPhrase) Sets if the custom status reason phrases are allowed for this response.
public void	setContentLanguage(final String contentLanguage) Set the value that will be used by the `Content-Language` response header.
public void	setContentLengthLong(long contentLength) Overrides org.glassfish.grizzly.http.HttpHeader.setContentLengthLong. Set the content-length of this `HttpPacket`.
public void	setHtmlEncodingCustomReasonPhrase(boolean isHtmlEncodingCustomReasonPhrase) Sets if we need to encode HTML sensitive characters in custom reason phrase.
public void	setInterimStatus(final HttpStatus the 1xx status of the interim response to serialize. interimStatus) Request the serialization of an informational (1xx) interim response, such as `HttpStatus#EARLY_HINTS_103`, using the headers currently set on this packet.
public void	setLocale(final Locale locale) Called explicitly by user to set the Content-Language and the default encoding
public void	setReasonPhrase(final String the status reason phrase for this response. message) Sets the status reason phrase for this response.
public void	setReasonPhrase(final Buffer reason)
public void	setRequest(final HttpRequestPacket the request that triggered this response request) Associates the request that triggered this response.
public void	setStatus(final int the status code for this response. status) Sets the status code for this response.
public void	setStatus(final HttpStatus the status for this response. status) Sets the status code for this response.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.glassfish.grizzly.http.HttpHeader:: addContentEncoding addHeader addHeader addHeader addHeader containsHeader containsHeader extractContentEncoding flushSpecialHeaders getAttributes getCharacterEncoding getContentEncodings getContentEncodings getContentLength getContentType getContentTypeHolder getHeader getHeader getHeaders getHttpHeader getParsingState getProcessingState getProtocol getProtocolDC getProtocolString getTempHeaderEncodingBuffer getTransferEncoding getUpgrade getUpgradeDC httpContentBuilder httpTrailerBuilder isChunked isChunkingAllowed isCommitted isContentBroken isContentEncodingsSelected isContentTypeSet isExpectContent isHeader isIgnoreContentModifiers isSecure isSkipRemainder isUpgrade makeContentLengthHeader makeTransferEncodingHeader makeUpgradeHeader recycle setCharacterEncoding setChunked setChunkingAllowed setCommitted setContentBroken setContentEncodingsSelected setContentLength setContentType setContentType setExpectContent setHeader setHeader setHeader setHeader setHeaderBuffer setIgnoreContentModifiers setProtocol setSecure setSkipRemainder setTransferEncoding setUpgrade

Field Detail

allowCustomReasonPhrase	back to summary
private boolean allowCustomReasonPhrase Do we allow custom reason phrase.

contentLanguage	back to summary
private String contentLanguage The value of the `Content-Language` response header.

httpStatus	back to summary
protected HttpStatus httpStatus Status code.

interimStatus back to summary

interimStatus	back to summary
private HttpStatus interimStatus Status of the informational (1xx) interim response (e.g. `HttpStatus#EARLY_HINTS_103` or `HttpStatus#CONINTUE_100`) that is pending serialization. Held separately from `httpStatus` so that serializing an interim response does not disturb the status of the final response. Non-`null` only between the moment an interim response is requested and the moment it has been serialized.

private HttpStatus interimStatus

Status of the informational (1xx) interim response (e.g. HttpStatus#EARLY_HINTS_103 or HttpStatus#CONINTUE_100) that is pending serialization. Held separately from httpStatus so that serializing an interim response does not disturb the status of the final response. Non-null only between the moment an interim response is requested and the moment it has been serialized.

isHtmlEncodingCustomReasonPhrase	back to summary
private boolean isHtmlEncodingCustomReasonPhrase Do we need to encode HTML sensitive characters in custom reason phrase.

locale	back to summary
private Locale locale The `Locale` of the entity body being sent by this response.

reasonPhraseC	back to summary
private final DataChunk reasonPhraseC Status message.

request	back to summary
private HttpRequestPacket request The request that triggered this response.

Constructor Detail

HttpResponsePacket	back to summary
protected HttpResponsePacket()

Method Detail

builder back to summary

builder	back to summary
public static HttpResponsePacket.Builder builder(final HttpRequestPacket request) Returns `HttpResponsePacket` builder. Returns:HttpResponsePacket.Builder `Builder`.

public static HttpResponsePacket.Builder builder(final HttpRequestPacket request)

Returns HttpResponsePacket builder.

Returns:HttpResponsePacket.Builder: Builder.

getContentLanguage	back to summary
public String getContentLanguage() Returns:String the value that will be used by the `Content-Language` response header

getHttpStatus	back to summary
public HttpStatus getHttpStatus() Gets the HTTP status for this response. Returns:HttpStatus the HTTP status for this response.

getHttpStatus

back to summary

public HttpStatus getHttpStatus()

Gets the HTTP status for this response.

Returns:HttpStatus: the HTTP status for this response.

getInterimStatus	back to summary
public HttpStatus getInterimStatus() Returns:HttpStatus the status of the interim response pending serialization, or `null` if none is pending.

getLocale	back to summary
public Locale getLocale() Returns:Locale the `Locale` of this response.

getReasonPhrase	back to summary
public final String getReasonPhrase() Gets the status reason phrase for this response. Returns:String the status reason phrase for this response.

getReasonPhrase

back to summary

public final String getReasonPhrase()

Gets the status reason phrase for this response.

Returns:String: the status reason phrase for this response.

getReasonPhraseDC back to summary

getReasonPhraseDC	back to summary
public final DataChunk getReasonPhraseDC() Gets the status reason phrase for this response as `DataChunk` (avoid creation of a String object}. This implementation takes into consideration the `isAllowCustomReasonPhrase()` property - if the custom reason phrase is allowed and it's value is not null - then the returned result will be equal to `getReasonPhraseRawDC()`, otherwise if custom reason phrase is disallowed or its value is null - the default reason phrase for the HTTP response `getStatus()` will be returned. Returns:DataChunk the status reason phrase for this response as `DataChunk` (avoid creation of a String object}.

public final DataChunk getReasonPhraseDC()

Gets the status reason phrase for this response as DataChunk (avoid creation of a String object}. This implementation takes into consideration the isAllowCustomReasonPhrase() property - if the custom reason phrase is allowed and it's value is not null - then the returned result will be equal to getReasonPhraseRawDC(), otherwise if custom reason phrase is disallowed or its value is null - the default reason phrase for the HTTP response getStatus() will be returned.

Returns:DataChunk: the status reason phrase for this response as DataChunk (avoid creation of a String object}.

getReasonPhraseRawDC back to summary

getReasonPhraseRawDC	back to summary
public final DataChunk getReasonPhraseRawDC() Gets the custom status reason phrase for this response as `DataChunk` (avoid creation of a String object}. Returns:DataChunk the status reason phrase for this response as `DataChunk` (avoid creation of a String object}.

public final DataChunk getReasonPhraseRawDC()

Gets the custom status reason phrase for this response as DataChunk (avoid creation of a String object}.

Returns:DataChunk: the status reason phrase for this response as DataChunk (avoid creation of a String object}.

getRequest	back to summary
public HttpRequestPacket getRequest() Returns:HttpRequestPacket the request that triggered this response

getStatus	back to summary
public int getStatus() Gets the status code for this response. Returns:int the status code for this response.

getStatus

back to summary

public int getStatus()

Gets the status code for this response.

Returns:int: the status code for this response.

interimResponseSent	back to summary
public void interimResponseSent() Mark the pending interim response as having been serialized. If the interim status was `100 Continue`, the associated request's expectation flag is also cleared so that subsequent processing no longer treats the request as awaiting acknowledgement.

isAllowCustomReasonPhrase back to summary

isAllowCustomReasonPhrase	back to summary
public final boolean isAllowCustomReasonPhrase() Returns `true` if custom status reason phrases are allowed for this response, or `false` otherwise. Returns:boolean `true` if custom status reason phrases are allowed for this response, or `false` otherwise.

public final boolean isAllowCustomReasonPhrase()

Returns true if custom status reason phrases are allowed for this response, or false otherwise.

Returns:boolean: true if custom status reason phrases are allowed for this response, or false otherwise.

isCustomReasonPhraseSet	back to summary
public final boolean isCustomReasonPhraseSet()

isHtmlEncodingCustomReasonPhrase	back to summary
public boolean isHtmlEncodingCustomReasonPhrase() Returns if we need to encode HTML sensitive characters in custom reason phrase.

isInterimResponse	back to summary
public boolean isInterimResponse() Returns:boolean `true` if an informational (1xx) interim response is pending serialization for this packet.

isRequest back to summary

isRequest	back to summary
public final boolean isRequest() Implements abstract org.glassfish.grizzly.http.HttpHeader.isRequest. Doc from org.glassfish.grizzly.http.HttpHeader.isRequest. Returns `true`, if the current `HttpHeader` represent HTTP request message, or `false` otherwise. Annotations @Override

public final boolean isRequest()

Implements abstract org.glassfish.grizzly.http.HttpHeader.isRequest.

Doc from org.glassfish.grizzly.http.HttpHeader.isRequest.

Returns true, if the current HttpHeader represent HTTP request message, or false otherwise.

Annotations

@Override

reset	back to summary
protected void reset() Overrides org.glassfish.grizzly.http.HttpHeader.reset. Doc from org.glassfish.grizzly.http.HttpHeader.reset. Reset the internal state. Annotations @Override

reset

back to summary

protected void reset()

Overrides org.glassfish.grizzly.http.HttpHeader.reset.

Doc from org.glassfish.grizzly.http.HttpHeader.reset.

Reset the internal state.

Annotations

@Override

setAllowCustomReasonPhrase back to summary

setAllowCustomReasonPhrase	back to summary
public final void setAllowCustomReasonPhrase(final boolean allowCustomReasonPhrase) Sets if the custom status reason phrases are allowed for this response. Parameters allowCustomReasonPhrase:boolean `true` if custom status reason phrases are allowed for this response, or `false` otherwise.

public final void setAllowCustomReasonPhrase(final boolean allowCustomReasonPhrase)

Sets if the custom status reason phrases are allowed for this response.

Parameters

allowCustomReasonPhrase:boolean: true if custom status reason phrases are allowed for this response, or false otherwise.

setContentLanguage	back to summary
public void setContentLanguage(final String contentLanguage) Set the value that will be used by the `Content-Language` response header.

setContentLengthLong back to summary

setContentLengthLong	back to summary
public void setContentLengthLong(long contentLength) Overrides org.glassfish.grizzly.http.HttpHeader.setContentLengthLong. Doc from org.glassfish.grizzly.http.HttpHeader.setContentLengthLong. Set the content-length of this `HttpPacket`. Applicable only in case of fixed-length HTTP message. Annotations @Override

public void setContentLengthLong(long contentLength)

Overrides org.glassfish.grizzly.http.HttpHeader.setContentLengthLong.

Doc from org.glassfish.grizzly.http.HttpHeader.setContentLengthLong.

Set the content-length of this HttpPacket. Applicable only in case of fixed-length HTTP message.

Annotations

@Override

setHtmlEncodingCustomReasonPhrase	back to summary
public void setHtmlEncodingCustomReasonPhrase(boolean isHtmlEncodingCustomReasonPhrase) Sets if we need to encode HTML sensitive characters in custom reason phrase.

setInterimStatus back to summary

setInterimStatus	back to summary
public void setInterimStatus(final HttpStatus interimStatus) Request the serialization of an informational (1xx) interim response, such as `HttpStatus#EARLY_HINTS_103`, using the headers currently set on this packet. This does not affect the status, headers or committed state of the final response. Parameters interimStatus:HttpStatus the 1xx status of the interim response to serialize.

public void setInterimStatus(final HttpStatus interimStatus)

Request the serialization of an informational (1xx) interim response, such as HttpStatus#EARLY_HINTS_103, using the headers currently set on this packet. This does not affect the status, headers or committed state of the final response.

Parameters

interimStatus:HttpStatus: the 1xx status of the interim response to serialize.

setLocale	back to summary
public void setLocale(final Locale locale) Called explicitly by user to set the Content-Language and the default encoding

setReasonPhrase	back to summary
public void setReasonPhrase(final String message) Sets the status reason phrase for this response. Parameters message:String the status reason phrase for this response.

setReasonPhrase

back to summary

public void setReasonPhrase(final String message)

Sets the status reason phrase for this response.

Parameters

message:String: the status reason phrase for this response.

setReasonPhrase	back to summary
public void setReasonPhrase(final Buffer reason)

setRequest	back to summary
public void setRequest(final HttpRequestPacket request) Associates the request that triggered this response. Parameters request:HttpRequestPacket the request that triggered this response

setRequest

back to summary

public void setRequest(final HttpRequestPacket request)

Associates the request that triggered this response.

Parameters

request:HttpRequestPacket: the request that triggered this response

setStatus	back to summary
public void setStatus(final int status) Sets the status code for this response. Parameters status:int the status code for this response.

setStatus

back to summary

public void setStatus(final int status)

Sets the status code for this response.

Parameters

status:int: the status code for this response.

setStatus	back to summary
public void setStatus(final HttpStatus status) Sets the status code for this response. Parameters status:HttpStatus the status for this response.

setStatus

back to summary

public void setStatus(final HttpStatus status)

Sets the status code for this response.

Parameters

status:HttpStatus: the status for this response.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

org.glassfish.grizzly.http back to summary

public Class HttpResponsePacket.Builder

Class Inheritance

extends HttpHeader.Builder<HttpResponsePacket.Builder>

java.lang.Object
org.glassfish.grizzly.http.HttpHeader.Builder
org.glassfish.grizzly.http.HttpResponsePacket.Builder

HttpResponsePacket message builder.

Field Summary

Modifier and Type	Field and Description
protected String	reasonPhrase
protected HttpRequestPacket	requestPacket
protected Integer	status

Inherited from org.glassfish.grizzly.http.HttpHeader.Builder:: chunked contentLength contentType mimeHeaders protocol protocolString upgrade

Constructor Summary

Access	Constructor and Description
public	Builder()

Method Summary

Modifier and Type	Method and Description
public final HttpResponsePacket	Returns: `HttpResponsePacket` build() Overrides org.glassfish.grizzly.http.HttpHeader.Builder.build. Build the `HttpResponsePacket` message.
protected HttpHeader	create() Implements abstract org.glassfish.grizzly.http.HttpHeader.Builder.create.
public HttpResponsePacket.Builder	reasonPhrase(final String the status reason phrase for this response. reasonPhrase) Sets the status reason phrase for this response.
public HttpResponsePacket.Builder	requestPacket(final HttpRequestPacket requestPacket)
public void	reset() Overrides org.glassfish.grizzly.http.HttpHeader.Builder.reset.
public HttpResponsePacket.Builder	status(final int the status code for this response. status) Sets the status code for this response.

Inherited from org.glassfish.grizzly.http.HttpHeader.Builder:: chunked contentLength contentType header header maxNumHeaders protocol protocol removeHeader removeHeader upgrade

Field Detail

reasonPhrase	back to summary
protected String reasonPhrase

requestPacket	back to summary
protected HttpRequestPacket requestPacket

status	back to summary
protected Integer status

Constructor Detail

Builder	back to summary
public Builder()

Method Detail

build back to summary

build	back to summary
public final HttpResponsePacket build() Overrides org.glassfish.grizzly.http.HttpHeader.Builder.build. Build the `HttpResponsePacket` message. Returns:HttpResponsePacket `HttpResponsePacket` Annotations @Override

public final HttpResponsePacket build()

Overrides org.glassfish.grizzly.http.HttpHeader.Builder.build.

Build the HttpResponsePacket message.

Returns:HttpResponsePacket

HttpResponsePacket

Annotations