Package org.simpleframework.http
Enum Scheme
- java.lang.Object
-
- java.lang.Enum<Scheme>
-
- org.simpleframework.http.Scheme
-
-
Enum Constant Summary
Enum Constants Enum Constant Description 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.
-
Constructor Summary
Constructors Modifier Constructor Description private
Scheme(java.lang.String scheme, boolean secure)
Constructor for theScheme
object.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getScheme()
This 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(java.lang.String token)
This is used to resolve the scheme given a token.static Scheme
resolveScheme(java.net.URI target)
This is used to resolve the scheme given aURI
.static Scheme
valueOf(java.lang.String name)
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 Detail
-
HTTP
public static final Scheme HTTP
This represents the scheme for a plaintext HTTP connection.
-
HTTPS
public static final Scheme HTTPS
This represents the scheme for a HTTP over TLS connection.
-
WS
public static final Scheme WS
This represents the scheme for a plaintext WebSocket connection.
-
WSS
public static final Scheme WSS
This represents the scheme for WebSocket over TLS connection.
-
-
Constructor Detail
-
Scheme
private Scheme(java.lang.String scheme, boolean secure)
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 Detail
-
values
public static Scheme[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (Scheme c : Scheme.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Scheme valueOf(java.lang.String name)
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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- 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
public java.lang.String 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
public static Scheme resolveScheme(java.lang.String token)
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
public static Scheme resolveScheme(java.net.URI target)
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
-
-