Package com.linecorp.armeria.common

Enum Class SessionProtocol

java.lang.Object

java.lang.Enum<SessionProtocol>

com.linecorp.armeria.common.SessionProtocol

All Implemented Interfaces:

Serializable, Comparable<SessionProtocol>, java.lang.constant.Constable

public enum SessionProtocol
extends Enum<SessionProtocol>

Session-level protocol that provides facilities such as framing and flow control.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
H1	HTTP/1 - over TLS.
H1C	HTTP/1 - cleartext.
H2	HTTP/2 - over TLS.
H2C	HTTP/2 - cleartext.
HTTP	HTTP - cleartext, HTTP/2 preferred.
HTTPS	HTTP - over TLS, HTTP/2 preferred.
PROXY	PROXY protocol - v1 or v2.

Method Summary

Modifier and Type	Method	Description
int	defaultPort()	Returns the default INET port number of this protocol.
static @Nullable SessionProtocol	find(String uriText)	Finds the SessionProtocol with the specified uriText().
static Set<SessionProtocol>	httpsValues()	Returns an immutable Set that contains HTTPS, H1 and H2.
static Set<SessionProtocol>	httpValues()	Returns an immutable Set that contains HTTP, H1C and H2C.
boolean	isHttp()	Returns true if this SessionProtocol is one of HTTP, H1C and H2C.
boolean	isHttps()	Returns true if this SessionProtocol is one of HTTPS, H1 and H2.
boolean	isMultiplex()	Returns true if and only if this protocol can multiplex a single transport-layer connection into more than one stream.
boolean	isTls()	Returns true if and only if this protocol uses TLS as its transport-level security layer.
static SessionProtocol	of(String uriText)	Returns the SessionProtocol with the specified uriText().
String	toString()
String	uriText()	Returns the textual representation of this format for use in a Scheme.
static SessionProtocol	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SessionProtocol[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HTTPS

public static final SessionProtocol HTTPS

HTTP - over TLS, HTTP/2 preferred.

HTTP

public static final SessionProtocol HTTP

HTTP - cleartext, HTTP/2 preferred.

H1

public static final SessionProtocol H1

HTTP/1 - over TLS.

H1C

public static final SessionProtocol H1C

HTTP/1 - cleartext.

H2

public static final SessionProtocol H2

HTTP/2 - over TLS.

H2C

public static final SessionProtocol H2C

HTTP/2 - cleartext.

PROXY

public static final SessionProtocol PROXY

PROXY protocol - v1 or v2.

Method Details

values

public static SessionProtocol[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SessionProtocol valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

of

public static SessionProtocol of(String uriText)

Returns the SessionProtocol with the specified uriText().

Throws:

IllegalArgumentException - if there's no such SessionProtocol

find

@Nullable
public static @Nullable SessionProtocol find(String uriText)

Finds the SessionProtocol with the specified uriText().

httpValues

public static Set<SessionProtocol> httpValues()

Returns an immutable Set that contains HTTP, H1C and H2C. Note that it does not contain HTTPS protocols such as HTTPS, H1 and H2.

See Also:

httpsValues()

httpsValues

public static Set<SessionProtocol> httpsValues()

Returns an immutable Set that contains HTTPS, H1 and H2. Note that it does not contain HTTP protocols such as HTTP, H1C and H2C.

See Also:

httpValues()

isHttp

public boolean isHttp()

Returns true if this SessionProtocol is one of HTTP, H1C and H2C.

See Also:

httpValues()

isHttps

public boolean isHttps()

Returns true if this SessionProtocol is one of HTTPS, H1 and H2.

See Also:

httpsValues()

isTls

public boolean isTls()

Returns true if and only if this protocol uses TLS as its transport-level security layer.

uriText

public String uriText()

Returns the textual representation of this format for use in a Scheme.

isMultiplex

public boolean isMultiplex()

Returns true if and only if this protocol can multiplex a single transport-layer connection into more than one stream.

defaultPort

public int defaultPort()

Returns the default INET port number of this protocol.

toString

public String toString()

Overrides:

toString in class Enum<SessionProtocol>