Package org.frankframework.http

Enum Class AbstractHttpSession.OauthAuthenticationMethod

java.lang.Object

java.lang.Enum<AbstractHttpSession.OauthAuthenticationMethod>

org.frankframework.http.AbstractHttpSession.OauthAuthenticationMethod

All Implemented Interfaces:

Serializable, Comparable<AbstractHttpSession.OauthAuthenticationMethod>, Constable

Enclosing class:

AbstractHttpSession

public static enum AbstractHttpSession.OauthAuthenticationMethod
extends Enum<AbstractHttpSession.OauthAuthenticationMethod>

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
CLIENT_CREDENTIALS_BASIC_AUTH	Requires tokenEndpoint, clientId and clientSecret to be set.
CLIENT_CREDENTIALS_QUERY_PARAMETERS	Requires tokenEndpoint, clientId and clientSecret to be set.
RESOURCE_OWNER_PASSWORD_CREDENTIALS_BASIC_AUTH	Requires tokenEndpoint, clientId, clientSecret, username and password to be set.
RESOURCE_OWNER_PASSWORD_CREDENTIALS_QUERY_PARAMETERS	Requires tokenEndpoint, clientId, clientSecret, username and password to be set.
SAML_ASSERTION	Requires samlNameId, samlIssuer, samlAudience, samlAssertionExpiry, and a certificate and private key.

Method Summary

Modifier and Type	Method	Description
static AbstractHttpSession.OauthAuthenticationMethod	determineOauthAuthenticationMethod(AbstractHttpSession session)
IOauthAuthenticator	newAuthenticator(AbstractHttpSession session)
static AbstractHttpSession.OauthAuthenticationMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AbstractHttpSession.OauthAuthenticationMethod[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CLIENT_CREDENTIALS_BASIC_AUTH

public static final AbstractHttpSession.OauthAuthenticationMethod CLIENT_CREDENTIALS_BASIC_AUTH

Requires tokenEndpoint, clientId and clientSecret to be set. Implements rfc6749. The clientId and clientSecret are sent as basic authorization to the authorization server. The accessToken is then used in the Authorization header to authenticate against the resource server.

CLIENT_CREDENTIALS_QUERY_PARAMETERS

public static final AbstractHttpSession.OauthAuthenticationMethod CLIENT_CREDENTIALS_QUERY_PARAMETERS

Requires tokenEndpoint, clientId and clientSecret to be set. Implements rfc6749. The clientId and clientSecret are sent in the form body to the authorization server. The accessToken is then used in the Authorization header to authenticate against the resource server.

RESOURCE_OWNER_PASSWORD_CREDENTIALS_BASIC_AUTH

public static final AbstractHttpSession.OauthAuthenticationMethod RESOURCE_OWNER_PASSWORD_CREDENTIALS_BASIC_AUTH

Requires tokenEndpoint, clientId, clientSecret, username and password to be set. Implements rfc6749. The clientId and clientSecret are sent as basic authorization to the authorization server. The username and password are sent in the form body to the authorization server. The accessToken is then used in the Authorization header to authenticate against the resource server.

RESOURCE_OWNER_PASSWORD_CREDENTIALS_QUERY_PARAMETERS

public static final AbstractHttpSession.OauthAuthenticationMethod RESOURCE_OWNER_PASSWORD_CREDENTIALS_QUERY_PARAMETERS

Requires tokenEndpoint, clientId, clientSecret, username and password to be set. Implements rfc6749. The clientId, clientSecret, username and password are sent in the form body to the authorization server. The accessToken is then used in the Authorization header to authenticate against the resource server.

SAML_ASSERTION

public static final AbstractHttpSession.OauthAuthenticationMethod SAML_ASSERTION

Requires samlNameId, samlIssuer, samlAudience, samlAssertionExpiry, and a certificate and private key. Generates a new SAML assertion, which will be exchanged for a token by the authorization server. The accessToken is then used in the Authorization header to authenticate against the resource server.

Method Details

values

public static AbstractHttpSession.OauthAuthenticationMethod[] 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 AbstractHttpSession.OauthAuthenticationMethod 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

newAuthenticator

public IOauthAuthenticator newAuthenticator(AbstractHttpSession session)
                                     throws HttpAuthenticationException

Throws:

HttpAuthenticationException

determineOauthAuthenticationMethod

@Nullable
public static AbstractHttpSession.OauthAuthenticationMethod determineOauthAuthenticationMethod(AbstractHttpSession session)