io.netty.handler.codec.http

Class HttpUtil

java.lang.Object

io.netty.handler.codec.http.HttpUtil

public final class HttpUtil
extends Object

Utility methods useful in the HTTP context.

Method Summary

Methods

Modifier and Type	Method and Description
static Charset	getCharset(HttpMessage message) Fetch charset from message's Content-Type header.
static Charset	getCharset(HttpMessage message, Charset defaultCharset) Fetch charset from message's Content-Type header.
static CharSequence	getCharsetAsSequence(HttpMessage message) Fetch charset from message's Content-Type header as a char sequence.
static CharSequence	getCharsetAsString(HttpMessage message) Deprecated. use getCharsetAsSequence(HttpMessage)
static long	getContentLength(HttpMessage message) Returns the length of the content.
static int	getContentLength(HttpMessage message, int defaultValue) Get an int representation of getContentLength(HttpMessage, long).
static long	getContentLength(HttpMessage message, long defaultValue) Returns the length of the content.
static CharSequence	getMimeType(HttpMessage message) Fetch MIME type part from message's Content-Type header as a char sequence.
static boolean	is100ContinueExpected(HttpMessage message) Returns true if and only if the specified message contains the "Expect: 100-continue" header.
static boolean	isAsteriskForm(URI uri) Determine if a uri is in asteric-form according to rfc7230, 5.3.
static boolean	isContentLengthSet(HttpMessage m)
static boolean	isKeepAlive(HttpMessage message) Returns true if and only if the connection can remain open and thus 'kept alive'.
static boolean	isOriginForm(URI uri) Determine if a uri is in origin-form according to rfc7230, 5.3.
static boolean	isTransferEncodingChunked(HttpMessage message) Checks to see if the transfer encoding in a specified HttpMessage is chunked
static void	set100ContinueExpected(HttpMessage message, boolean expected) Sets or removes the "Expect: 100-continue" header to / from the specified message.
static void	setContentLength(HttpMessage message, long length) Sets the "Content-Length" header.
static void	setKeepAlive(HttpHeaders h, HttpVersion httpVersion, boolean keepAlive) Sets the value of the "Connection" header depending on the protocol version of the specified message.
static void	setKeepAlive(HttpMessage message, boolean keepAlive) Sets the value of the "Connection" header depending on the protocol version of the specified message.
static void	setTransferEncodingChunked(HttpMessage m, boolean chunked) Set the HttpHeaderNames.TRANSFER_ENCODING to either include HttpHeaderValues.CHUNKED if chunked is true, or remove HttpHeaderValues.CHUNKED if chunked is false.

Methods inherited from class java.lang.Object

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

Method Detail

isOriginForm

public static boolean isOriginForm(URI uri)

Determine if a uri is in origin-form according to rfc7230, 5.3.

isAsteriskForm

public static boolean isAsteriskForm(URI uri)

Determine if a uri is in asteric-form according to rfc7230, 5.3.

isKeepAlive

public static boolean isKeepAlive(HttpMessage message)

Returns true if and only if the connection can remain open and thus 'kept alive'. This methods respects the value of the. "Connection" header first and then the return value of HttpVersion.isKeepAliveDefault().

setKeepAlive

public static void setKeepAlive(HttpMessage message,
                boolean keepAlive)

Sets the value of the "Connection" header depending on the protocol version of the specified message. This getMethod sets or removes the "Connection" header depending on what the default keep alive mode of the message's protocol version is, as specified by HttpVersion.isKeepAliveDefault().

• If the connection is kept alive by default:
  • set to "close" if keepAlive is false.
  • remove otherwise.
• If the connection is closed by default:
  • set to "keep-alive" if keepAlive is true.
  • remove otherwise.

See Also:

setKeepAlive(HttpHeaders, HttpVersion, boolean)

setKeepAlive

public static void setKeepAlive(HttpHeaders h,
                HttpVersion httpVersion,
                boolean keepAlive)

Sets the value of the "Connection" header depending on the protocol version of the specified message. This getMethod sets or removes the "Connection" header depending on what the default keep alive mode of the message's protocol version is, as specified by HttpVersion.isKeepAliveDefault().

• If the connection is kept alive by default:
  • set to "close" if keepAlive is false.
  • remove otherwise.
• If the connection is closed by default:
  • set to "keep-alive" if keepAlive is true.
  • remove otherwise.

getContentLength

public static long getContentLength(HttpMessage message)

Returns the length of the content. Please note that this value is not retrieved from ByteBufHolder.content() but from the "Content-Length" header, and thus they are independent from each other.

Returns:

the content length

Throws:

NumberFormatException - if the message does not have the "Content-Length" header or its value is not a number

getContentLength

public static long getContentLength(HttpMessage message,
                    long defaultValue)

Returns the length of the content. Please note that this value is not retrieved from ByteBufHolder.content() but from the "Content-Length" header, and thus they are independent from each other.

Returns:

the content length or defaultValue if this message does not have the "Content-Length" header or its value is not a number

getContentLength

public static int getContentLength(HttpMessage message,
                   int defaultValue)

Get an int representation of getContentLength(HttpMessage, long).

Returns:

the content length or defaultValue if this message does not have the "Content-Length" header or its value is not a number. Not to exceed the boundaries of integer.

setContentLength

public static void setContentLength(HttpMessage message,
                    long length)

Sets the "Content-Length" header.

isContentLengthSet

public static boolean isContentLengthSet(HttpMessage m)

is100ContinueExpected

public static boolean is100ContinueExpected(HttpMessage message)

Returns true if and only if the specified message contains the "Expect: 100-continue" header.

set100ContinueExpected

public static void set100ContinueExpected(HttpMessage message,
                          boolean expected)

Sets or removes the "Expect: 100-continue" header to / from the specified message. If expected is true, the "Expect: 100-continue" header is set and all other previous "Expect" headers are removed. Otherwise, all "Expect" headers are removed completely.

isTransferEncodingChunked

public static boolean isTransferEncodingChunked(HttpMessage message)

Checks to see if the transfer encoding in a specified HttpMessage is chunked

Parameters:

message - The message to check

Returns:

True if transfer encoding is chunked, otherwise false

setTransferEncodingChunked

public static void setTransferEncodingChunked(HttpMessage m,
                              boolean chunked)

Set the HttpHeaderNames.TRANSFER_ENCODING to either include HttpHeaderValues.CHUNKED if chunked is true, or remove HttpHeaderValues.CHUNKED if chunked is false.

Parameters:

m - The message which contains the headers to modify.

chunked - if true then include HttpHeaderValues.CHUNKED in the headers. otherwise remove HttpHeaderValues.CHUNKED from the headers.

getCharset

public static Charset getCharset(HttpMessage message)

Fetch charset from message's Content-Type header.

Returns:

the charset from message's Content-Type header or CharsetUtil.ISO_8859_1 if charset is not presented or unparsable

getCharset

public static Charset getCharset(HttpMessage message,
                 Charset defaultCharset)

Fetch charset from message's Content-Type header.

Returns:

the charset from message's Content-Type header or defaultCharset if charset is not presented or unparsable

getCharsetAsString

@Deprecated
public static CharSequence getCharsetAsString(HttpMessage message)

Deprecated. use getCharsetAsSequence(HttpMessage)

Fetch charset from message's Content-Type header as a char sequence. A lot of sites/possibly clients have charset="CHARSET", for example charset="utf-8". Or "utf8" instead of "utf-8" This is not according to standard, but this method provide an ability to catch desired mistakes manually in code

Returns:

the CharSequence with charset from message's Content-Type header or null if charset is not presented

getCharsetAsSequence

public static CharSequence getCharsetAsSequence(HttpMessage message)

Fetch charset from message's Content-Type header as a char sequence. A lot of sites/possibly clients have charset="CHARSET", for example charset="utf-8". Or "utf8" instead of "utf-8" This is not according to standard, but this method provide an ability to catch desired mistakes manually in code

Returns:

the CharSequence with charset from message's Content-Type header or null if charset is not presented

getMimeType

public static CharSequence getMimeType(HttpMessage message)

Fetch MIME type part from message's Content-Type header as a char sequence.

Returns:

the MIME type as a CharSequence from message's Content-Type header or null if content-type header or MIME type part of this header are not presented

"content-type: text/html; charset=utf-8" - "text/html" will be returned
"content-type: text/html" - "text/html" will be returned
"content-type: " or no header - null we be returned