net.named_data.jndn.security

Class KeyParams

java.lang.Object

net.named_data.jndn.security.KeyParams

Direct Known Subclasses:

AesKeyParams, EcKeyParams, RsaKeyParams

public class KeyParams
extends Object

KeyParams is a base class for key parameters. Its subclasses are used to store parameters for key generation.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KeyParams(KeyType keyType, KeyIdType keyIdType) Create a key generation parameter.
protected	KeyParams(KeyType keyType, Name.Component keyId) Create a key generation parameter.

Method Summary

Modifier and Type	Method and Description
Name.Component	getKeyId()
KeyIdType	getKeyIdType()
KeyType	getKeyType()
void	setKeyId(Name.Component keyId)

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyParams

protected KeyParams(KeyType keyType,
                    KeyIdType keyIdType)

Create a key generation parameter.

Parameters:

keyType - The type for the created key.

keyIdType - The method for how the key id should be generated, which must not be KeyIdType.USER_SPECIFIED.

Throws:

AssertionError - if keyIdType is KeyIdType.USER_SPECIFIED.

KeyParams

protected KeyParams(KeyType keyType,
                    Name.Component keyId)

Create a key generation parameter.

Parameters:

keyType - The type for the created key.

keyId - The user-specified key ID. This sets the keyIdType to KeyIdType.USER_SPECIFIED. keyId must not be empty.

Throws:

AssertionError - if keyId is empty.

Method Detail

getKeyType

public final KeyType getKeyType()

getKeyIdType

public final KeyIdType getKeyIdType()

setKeyId

public final void setKeyId(Name.Component keyId)

getKeyId

public final Name.Component getKeyId()