Package org.keycloak.protocol.saml

Enum SAMLEncryptionAlgorithms

java.lang.Object

java.lang.Enum<SAMLEncryptionAlgorithms>

org.keycloak.protocol.saml.SAMLEncryptionAlgorithms

All Implemented Interfaces:

Serializable, Comparable<SAMLEncryptionAlgorithms>

public enum SAMLEncryptionAlgorithms
extends Enum<SAMLEncryptionAlgorithms>

This enum provides mapping between Keycloak provided encryption algorithms and algorithms from xmlsec. It is used to make sure we are using keys generated for given algorithm only with that algorithm.

Enum Constant Summary

Enum Constants

Enum Constant	Description
RSA_OAEP
RSA1_5

Method Summary

Modifier and Type	Method	Description
static SAMLEncryptionAlgorithms	forKeycloakIdentifier(String keycloakIdentifier)	Returns the SAMLEncryptionAlgorithms for the keycloak identifier.
static SAMLEncryptionAlgorithms	forXMLEncIdentifier(String xmlEncIdentifier)	Returns the SAMLEncryptionAlgorithms that contains the xml enc identifier.
String	getKeycloakIdentifier()	Getter for the keycloak identifier.
String[]	getXmlEncIdentifiers()	Getter for all the XML encoding identifiers.
static SAMLEncryptionAlgorithms	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SAMLEncryptionAlgorithms[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RSA_OAEP

public static final SAMLEncryptionAlgorithms RSA_OAEP

RSA1_5

public static final SAMLEncryptionAlgorithms RSA1_5

Method Detail

values

public static SAMLEncryptionAlgorithms[] 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 (SAMLEncryptionAlgorithms c : SAMLEncryptionAlgorithms.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SAMLEncryptionAlgorithms valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getXmlEncIdentifiers

public String[] getXmlEncIdentifiers()

Getter for all the XML encoding identifiers. There should be at least one.

Returns:

The array of XML encoding identifiers

getKeycloakIdentifier

public String getKeycloakIdentifier()

Getter for the keycloak identifier.

Returns:

The keycloak identifier.

forXMLEncIdentifier

public static SAMLEncryptionAlgorithms forXMLEncIdentifier(String xmlEncIdentifier)

Returns the SAMLEncryptionAlgorithms that contains the xml enc identifier.

Parameters:

xmlEncIdentifier - The Xml encoding identifier

Returns:

The associated SAMLEncryptionAlgorithms or null

forKeycloakIdentifier

public static SAMLEncryptionAlgorithms forKeycloakIdentifier(String keycloakIdentifier)

Returns the SAMLEncryptionAlgorithms for the keycloak identifier.

Parameters:

keycloakIdentifier - The keycloak identifier

Returns:

The associated SAMLEncryptionAlgorithms or null