Package org.simpleframework.http
Enum Scheme
- All Implemented Interfaces:
Serializable
,Comparable<Scheme>
,java.lang.constant.Constable
The
Scheme
represents a scheme used for a URI. Here
only schemes that directly relate to HTTP are provided, which
includes HTTP/1.1 schemes and WebSocket 1.0 schemes.-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThis is used to acquire the scheme token for this.boolean
isSecure()
This is used to determine if the scheme is secure or not.static Scheme
resolveScheme
(String token) This is used to resolve the scheme given a token.static Scheme
resolveScheme
(URI target) This is used to resolve the scheme given aURI
.static Scheme
Returns the enum constant of this type with the specified name.static Scheme[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
HTTP
This represents the scheme for a plaintext HTTP connection. -
HTTPS
This represents the scheme for a HTTP over TLS connection. -
WS
This represents the scheme for a plaintext WebSocket connection. -
WSS
This represents the scheme for WebSocket over TLS connection.
-
-
Field Details
-
scheme
This is the actual scheme token that is to be used in the URI. -
secure
public final boolean secureThis is used to determine if the connection is secure or not.
-
-
Constructor Details
-
Scheme
Constructor for theScheme
object. This is used create an entry using the specific scheme token and a boolean indicating if the scheme is secure or not.- Parameters:
scheme
- this is the scheme token to be usedsecure
- this determines if the scheme is secure or not
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-
isSecure
public boolean isSecure()This is used to determine if the scheme is secure or not. In general a secure scheme is one sent over a SSL/TLS connection.- Returns:
- this returns true if the scheme is a secure one
-
getScheme
This is used to acquire the scheme token for this. The scheme token can be used to prefix a absolute fully qualified URI.- Returns:
- the scheme token representing this scheme
-
resolveScheme
This is used to resolve the scheme given a token. If there is no matching scheme for the provided token a default of HTTP is provided.- Parameters:
token
- this is the token used to determine the scheme- Returns:
- this returns the match or HTTP if none matched
-
resolveScheme
This is used to resolve the scheme given aURI
. If there is no matching scheme for the provided instance then this will return null.- Parameters:
token
- this is the object to resolve a scheme for- Returns:
- this returns the match or null if none matched
-