Package org.apache.juneau.rest.server.auth.saml

Enum Class SamlBinding

java.lang.Object

java.lang.Enum<SamlBinding>

org.apache.juneau.rest.server.auth.saml.SamlBinding

All Implemented Interfaces:

Serializable, Comparable<SamlBinding>, Constable

public enum SamlBinding
extends Enum<SamlBinding>

SAML 2.0 bindings supported by SamlAuthFilter for delivering a <Response> from an IdP to the SP.

v1 ships the two HTTP-flavored bindings. Artifact and SOAP back-channel bindings are deferred.

HTTP POST binding

The IdP returns an auto-submitting HTML form whose SAMLResponse field carries the base64-encoded <Response> document. The browser POSTs the form to the SP's assertion-consumer URL. This is the dominant binding for SAML 2.0 web SSO.

HTTP Redirect binding

The IdP redirects the browser to the SP with the SAMLResponse carried in a query-string parameter. The value is deflated (RFC 1951) and then base64-encoded so that even mid-size assertions fit inside URL length limits. This binding is more commonly used for <AuthnRequest> than for <Response>, but some IdPs offer it for assertions too.

See Also:

• SamlAuthFilter
• SAML 2.0 Bindings (OASIS)

Since:

10.0.0

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
POST	HTTP POST binding.
REDIRECT	HTTP Redirect binding.

Method Summary

Modifier and Type	Method	Description
static SamlBinding	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SamlBinding[]	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

POST

public static final SamlBinding POST

HTTP POST binding. SAMLResponse carried as a base64-encoded form field on a POST request.

REDIRECT

public static final SamlBinding REDIRECT

HTTP Redirect binding. SAMLResponse carried as a deflated + base64-encoded query parameter on a GET request.

Method Details

values

public static SamlBinding[] 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 SamlBinding 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