Package io.quarkus.vertx.http.runtime.security

Class HttpCredentialTransport

java.lang.Object

io.quarkus.vertx.http.runtime.security.HttpCredentialTransport

public class HttpCredentialTransport
extends Object

A representation of HTTP credential transport. In particular this includes things such as: Cookies Authorization header POST Note that using multiple HTTP authentication mechanisms to use the same credential transport type can lead to unexpected authentication failures as they will not be able to figure out which mechanisms should process which request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	HttpCredentialTransport.Type

Constructor Summary

Constructors

Constructor	Description
HttpCredentialTransport(HttpCredentialTransport.Type transportType, String typeTarget)	HttpCredentialTransport constructor that accepts two parameters.
HttpCredentialTransport(HttpCredentialTransport.Type transportType, String typeTarget, String authenticationScheme)	HttpCredentialTransport constructor that accepts three parameters.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getAuthenticationScheme()
HttpCredentialTransport.Type	getTransportType()
String	getTypeTarget()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

HttpCredentialTransport

public HttpCredentialTransport(HttpCredentialTransport.Type transportType,
 String typeTarget)

HttpCredentialTransport constructor that accepts two parameters.

Parameters:

transportType - the transport type, for example, HttpCredentialTransport.Type.AUTHORIZATION

typeTarget - the type target, case-insensitive, for example, "Bearer". It also becomes an authentication scheme returned from getAuthenticationScheme()

HttpCredentialTransport

public HttpCredentialTransport(HttpCredentialTransport.Type transportType,
 String typeTarget,
 String authenticationScheme)

HttpCredentialTransport constructor that accepts three parameters.

Parameters:

transportType - the transport type, for example, HttpCredentialTransport.Type.AUTHORIZATION

typeTarget - the type target, case-insensitive, for example, "Bearer" or a Form authentication post location.

authenticationScheme - case-insensitive. Usually, it is equal to the typeTarget but can also take a unique value. For example, "Form" for a Form authentication mechanism whose typeTarget may be set to a form post location.

Both HttpAuthenticationMechanism.value() and an optional HTTP security policy's `auth-mechanism` property must be set to the "authenticationScheme" value to find a matching HttpAuthenticationMechanism that must secure a specific REST resource method or request path. For example, '@HttpAuthenticationMechanism("custom-scheme")', 'quarkus.http.auth.permission.my-policy.auth-mechanism=custom-scheme'.

Method Details

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getTransportType

public HttpCredentialTransport.Type getTransportType()

getTypeTarget

public String getTypeTarget()

getAuthenticationScheme

public String getAuthenticationScheme()