com.scalar.dl.ledger.crypto

Class SecretEntry

java.lang.Object

com.scalar.dl.ledger.crypto.SecretEntry

@Immutable
public class SecretEntry
extends java.lang.Object

Container for a registered HMAC secret key and metadata about the secret key. In addition to the secret key, a SecretEntry has:

• the entity ID that has the secret key
• the version of the secret key
• the time at which the secret key was registered

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SecretEntry.Key

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENTITY_ID
static java.lang.String	KEY_VERSION
static java.lang.String	REGISTERED_AT
static java.lang.String	SECRET_KEY

Constructor Summary

Constructors

Constructor and Description
SecretEntry(java.lang.String entityId, int keyVersion, java.lang.String secretKey, long registeredAt) Constructs a SecretEntry with the specified entity ID, secret key version, secret key, and time the secret was registered at.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Indicates whether some other object is "equal to" this object.
java.lang.String	getEntityId() Returns the entity ID.
SecretEntry.Key	getKey() Returns the Key of the SecretEntry.
int	getKeyVersion() Returns the secret key version.
long	getRegisteredAt() Returns the time the secret key was registered at.
java.lang.String	getSecretKey() Returns the secret key.
int	hashCode() Returns a hash code value for the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENTITY_ID

public static final java.lang.String ENTITY_ID

See Also:

Constant Field Values

KEY_VERSION

public static final java.lang.String KEY_VERSION

See Also:

Constant Field Values

SECRET_KEY

public static final java.lang.String SECRET_KEY

See Also:

Constant Field Values

REGISTERED_AT

public static final java.lang.String REGISTERED_AT

See Also:

Constant Field Values

Constructor Detail

SecretEntry

public SecretEntry(java.lang.String entityId,
                   int keyVersion,
                   java.lang.String secretKey,
                   long registeredAt)

Constructs a SecretEntry with the specified entity ID, secret key version, secret key, and time the secret was registered at.

Parameters:

entityId - the ID of an entity

keyVersion - the version of a secret

secretKey - a secret key

registeredAt - the time the contract was registered at

Method Detail

getKey

public SecretEntry.Key getKey()

Returns the Key of the SecretEntry. A Key is made up of the entity ID and the secret key version.

Returns:

the Key of the SecretEntry

getEntityId

public java.lang.String getEntityId()

Returns the entity ID.

Returns:

the entity ID

getKeyVersion

public int getKeyVersion()

Returns the secret key version.

Returns:

the secret key version

getSecretKey

public java.lang.String getSecretKey()

Returns the secret key.

Returns:

the secret key

getRegisteredAt

public long getRegisteredAt()

Returns the time the secret key was registered at.

Returns:

the time the secret key was registered at

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

equals

public boolean equals(java.lang.Object o)

Indicates whether some other object is "equal to" this object. The other object is considered equal if it is also an SecretEntry and both instances have the same

• entity ID
• key version
• secret key
• registered at time

Overrides:

equals in class java.lang.Object

Parameters:

o - an object to be tested for equality

Returns:

true if the other object is "equal to" this object otherwise false