Package com.oracle.bmc.http.signing.internal

Enum SignedRequestVersion

java.lang.Object

java.lang.Enum<SignedRequestVersion>

com.oracle.bmc.http.signing.internal.SignedRequestVersion

All Implemented Interfaces:

Version, Serializable, Comparable<SignedRequestVersion>

public enum SignedRequestVersion
extends Enum<SignedRequestVersion>
implements Version

List of supported signed request versions with associated version rules.

Nested Class Summary

Nested classes/interfaces inherited from interface com.oracle.bmc.http.signing.internal.Version

Version.Error

Enum Constant Summary

Enum Constants

Enum Constant	Description
ONE

Method Summary

Modifier and Type	Method	Description
static SignedRequestVersion	getLatestVersion()	Get the latest signed request version.
int	getMinimumKeySizeInBits()	Get the minimum public key size in bits.
Set<Algorithm>	getSupportedAlgorithms()	Get a set of supported algorithms.
Set<KeyIdType>	getSupportedKeyIdTypes()	Get a set of supported keyId types.
String	getVersionName()	Get the name of this version - usually the version number as a String.
int	getVersionNumber()	Get the version number.
Optional<Version.Error>	validateAlgorithm(Algorithm algorithm)
Optional<Version.Error>	validateKeyId(String keyId)
Optional<Version.Error>	validateKeySize(RSAPublicKey publicKey)
static SignedRequestVersion	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SignedRequestVersion[]	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

ONE

public static final SignedRequestVersion ONE

Method Detail

values

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

Returns:

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

valueOf

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

getSupportedAlgorithms

public Set<Algorithm> getSupportedAlgorithms()

Description copied from interface: Version

Get a set of supported algorithms.

Specified by:

getSupportedAlgorithms in interface Version

getSupportedKeyIdTypes

public Set<KeyIdType> getSupportedKeyIdTypes()

Description copied from interface: Version

Get a set of supported keyId types.

Specified by:

getSupportedKeyIdTypes in interface Version

getVersionNumber

public int getVersionNumber()

Description copied from interface: Version

Get the version number.

Specified by:

getVersionNumber in interface Version

getVersionName

public String getVersionName()

Description copied from interface: Version

Get the name of this version - usually the version number as a String.

Specified by:

getVersionName in interface Version

getMinimumKeySizeInBits

public int getMinimumKeySizeInBits()

Description copied from interface: Version

Get the minimum public key size in bits.

Specified by:

getMinimumKeySizeInBits in interface Version

validateKeyId

public Optional<Version.Error> validateKeyId(@Nonnull
                                             String keyId)

Specified by:

validateKeyId in interface Version

validateAlgorithm

public Optional<Version.Error> validateAlgorithm(@Nonnull
                                                 Algorithm algorithm)

Specified by:

validateAlgorithm in interface Version

validateKeySize

public Optional<Version.Error> validateKeySize(@Nonnull
                                               RSAPublicKey publicKey)

Specified by:

validateKeySize in interface Version

getLatestVersion

public static SignedRequestVersion getLatestVersion()

Get the latest signed request version.