com.atlassian.jwt

Enum SigningAlgorithm

java.lang.Object

java.lang.Enum<SigningAlgorithm>

com.atlassian.jwt.SigningAlgorithm

All Implemented Interfaces:

Serializable, Comparable<SigningAlgorithm>

public enum SigningAlgorithm
extends Enum<SigningAlgorithm>

An enumeration of supported JWS algorithms. Values must match the names used in the JWT 'alg' header. Valid values are specified by JSON Web Algorithms.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
HS256
RS256

Method Summary

Modifier and Type	Method and Description
static SigningAlgorithm	forName(String alg)
boolean	requiresKeyPair()
boolean	requiresSharedSecret()
static SigningAlgorithm	valueOf(String name) Returns the enum constant of this type with the specified name.
static SigningAlgorithm[]	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

HS256

public static final SigningAlgorithm HS256

RS256

public static final SigningAlgorithm RS256

Method Detail

values

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

Returns:

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

valueOf

public static SigningAlgorithm 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

forName

public static SigningAlgorithm forName(String alg)
                                throws JwsUnsupportedAlgorithmException

Throws:

JwsUnsupportedAlgorithmException

requiresSharedSecret

public boolean requiresSharedSecret()

requiresKeyPair

public boolean requiresKeyPair()