org.cryptacular.x509

Enum KeyUsageBits

java.lang.Object

java.lang.Enum<KeyUsageBits>

org.cryptacular.x509.KeyUsageBits

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<KeyUsageBits>

public enum KeyUsageBits
extends java.lang.Enum<KeyUsageBits>

Representation of the bit meanings in the KeyUsage BIT STRING type defined in section 4.2.1.3 of RFC 2459.

Version:

$Revision: 2745 $

Enum Constant Summary

Enum Constants

Enum Constant and Description
CRLSign cRLSign bit.
DataEncipherment dataEncipherment bit.
DecipherOnly decipherOnly bit.
DigitalSignature digitalSignature bit.
EncipherOnly encipherOnly bit.
KeyAgreement keyAgreement bit.
KeyCertSign keyCertSign bit.
KeyEncipherment keyEncipherment bit.
NonRepudiation nonRepudiation bit.

Field Summary

Fields

Modifier and Type	Field and Description
private int	offset Bit mask offset.

Method Summary

Modifier and Type	Method and Description
int	getMask()
boolean	isSet(byte[] bitString) Determines whether this key usage bit is set in the given key usage bit string.
boolean	isSet(int bitString) Determines whether this key usage bit is set in the given key usage bit string.
boolean	isSet(org.bouncycastle.asn1.x509.KeyUsage keyUsage) Determines whether this key usage bit is set in the given key usage value.
static int	usage(KeyUsageBits... bits) Computes the key usage value from one or more key usage bits.
static KeyUsageBits	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KeyUsageBits[]	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

DigitalSignature

public static final KeyUsageBits DigitalSignature

digitalSignature bit.

NonRepudiation

public static final KeyUsageBits NonRepudiation

nonRepudiation bit.

KeyEncipherment

public static final KeyUsageBits KeyEncipherment

keyEncipherment bit.

DataEncipherment

public static final KeyUsageBits DataEncipherment

dataEncipherment bit.

KeyAgreement

public static final KeyUsageBits KeyAgreement

keyAgreement bit.

KeyCertSign

public static final KeyUsageBits KeyCertSign

keyCertSign bit.

CRLSign

public static final KeyUsageBits CRLSign

cRLSign bit.

EncipherOnly

public static final KeyUsageBits EncipherOnly

encipherOnly bit.

DecipherOnly

public static final KeyUsageBits DecipherOnly

decipherOnly bit.

Field Detail

offset

private final int offset

Bit mask offset.

Method Detail

values

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

Returns:

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

valueOf

public static KeyUsageBits valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getMask

public int getMask()

Returns:

Bit mask value.

isSet

public boolean isSet(org.bouncycastle.asn1.x509.KeyUsage keyUsage)

Determines whether this key usage bit is set in the given key usage value.

Parameters:

keyUsage - BC key usage object.

Returns:

True if bit is set, false otherwise.

isSet

public boolean isSet(byte[] bitString)

Determines whether this key usage bit is set in the given key usage bit string.

Parameters:

bitString - Key usage bit string as a byte array.

Returns:

True if bit is set, false otherwise.

isSet

public boolean isSet(int bitString)

Determines whether this key usage bit is set in the given key usage bit string.

Parameters:

bitString - Key usage bit string as a big endian integer.

Returns:

True if bit is set, false otherwise.

usage

public static int usage(KeyUsageBits... bits)

Computes the key usage value from one or more key usage bits.

Parameters:

bits - One ore more key usage bits.

Returns:

Key usage bit string as an integer.