Module io.inverno.mod.http.base

Package io.inverno.mod.http.base.internal.header

Class AuthorizationCodec

java.lang.Object

io.inverno.mod.http.base.internal.header.AuthorizationCodec

All Implemented Interfaces:

HeaderCodec<AuthorizationCodec.Authorization>

public class AuthorizationCodec
extends Object
implements HeaderCodec<AuthorizationCodec.Authorization>

Authorization HTTP HeaderCodec implementation.

Since:

1.5

Author:

Jeremy Kuhn

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AuthorizationCodec.Authorization	Headers.Authorization header implementation.

Field Summary

Fields inherited from interface io.inverno.mod.http.base.header.HeaderCodec

COLON, COMMA, CR, DOUBLE_QUOTE, EQUALS, HT, LF, SEMICOLON, SP, SP_CHAR

Constructor Summary

Constructors

Constructor	Description
AuthorizationCodec()	Creates an authorization header codec.
AuthorizationCodec(Set<String> tokenExpectedSchemes)	Creates an authorization header codec with the specified expected schemes.

Method Summary

Modifier and Type	Method	Description
AuthorizationCodec.Authorization	decode(String name, io.netty.buffer.ByteBuf buffer, Charset charset)	Decodes the specified raw value ByteBuf for the specified header name using the specified charset.
AuthorizationCodec.Authorization	decode(String name, String value)	Decodes the specified raw header value for the specified header name.
String	encode(AuthorizationCodec.Authorization header)	Encodes the specified header as a string.
String	encodeValue(AuthorizationCodec.Authorization header)	Encodes the value of the specified header as a string.
Set<String>	getSupportedHeaderNames()	Returns a list of header names supported by the codec.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.inverno.mod.http.base.header.HeaderCodec

encode, encodeValue

Constructor Details

AuthorizationCodec

public AuthorizationCodec()

Creates an authorization header codec.

AuthorizationCodec

public AuthorizationCodec(Set<String> tokenExpectedSchemes)

Creates an authorization header codec with the specified expected schemes.

Parameters:

tokenExpectedSchemes - a set of authorization schemes

Method Details

decode

public AuthorizationCodec.Authorization decode(String name,
 String value)

Description copied from interface: HeaderCodec

Decodes the specified raw header value for the specified header name.

Specified by:

decode in interface HeaderCodec<AuthorizationCodec.Authorization>

Parameters:

name - a header name

value - a header raw value

Returns:

a decoded header instance

decode

public AuthorizationCodec.Authorization decode(String name,
 io.netty.buffer.ByteBuf buffer,
 Charset charset)

Description copied from interface: HeaderCodec

Decodes the specified raw value ByteBuf for the specified header name using the specified charset.

Specified by:

decode in interface HeaderCodec<AuthorizationCodec.Authorization>

Parameters:

name - a header name

buffer - a header raw value

charset - the charset to use for decoding

Returns:

a decoded header instance

encode

public String encode(AuthorizationCodec.Authorization header)

Description copied from interface: HeaderCodec

Encodes the specified header as a string.

The resulting value is a header field as defined by RFC 7230 Section 3.2.

Specified by:

encode in interface HeaderCodec<AuthorizationCodec.Authorization>

Parameters:

header - the header to encode

Returns:

the encoded header

encodeValue

public String encodeValue(AuthorizationCodec.Authorization header)

Description copied from interface: HeaderCodec

Encodes the value of the specified header as a string.

The resulting value corresponds to the header field value as defined by RFC 7230 Section 3.2.

Specified by:

encodeValue in interface HeaderCodec<AuthorizationCodec.Authorization>

Parameters:

header - the header to encode

Returns:

the encoded header value

getSupportedHeaderNames

public Set<String> getSupportedHeaderNames()

Description copied from interface: HeaderCodec

Returns a list of header names supported by the codec.

Specified by:

getSupportedHeaderNames in interface HeaderCodec<AuthorizationCodec.Authorization>

Returns:

a list of header names