net.named_data.jndn.security.pib.detail

Class PibKeyImpl

java.lang.Object

net.named_data.jndn.security.pib.detail.PibKeyImpl

public class PibKeyImpl
extends Object

PibKeyImpl provides the backend implementation for PibKey. A PibKey has only one backend instance, but may have multiple frontend handles. Each frontend handle is associated with the only one backend PibKeyImpl.

Constructor Summary

Constructors

Constructor and Description
PibKeyImpl(Name keyName, ByteBuffer keyEncoding, PibImpl pibImpl) Create a PibKeyImpl with keyName.
PibKeyImpl(Name keyName, PibImpl pibImpl) Create a PibKeyImpl with keyName.

Method Summary

Modifier and Type	Method and Description
void	addCertificate(CertificateV2 certificate) Add the certificate.
CertificateV2	getCertificate(Name certificateName) Get the certificate with name certificateName.
PibCertificateContainer	getCertificates_() Get the certificates_ container, which should only be used for testing.
CertificateV2	getDefaultCertificate() Get the default certificate for this Key.
Name	getIdentityName() Get the name of the identity this key belongs to.
KeyType	getKeyType() Get the key type.
Name	getName()
Blob	getPublicKey() Get the public key encoding.
void	removeCertificate(Name certificateName) Remove the certificate with name certificateName.
CertificateV2	setDefaultCertificate(CertificateV2 certificate) Add the certificate and set it as the default certificate of the key.
CertificateV2	setDefaultCertificate(Name certificateName) Set the existing certificate with name certificateName as the default certificate.

Methods inherited from class java.lang.Object

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

Constructor Detail

PibKeyImpl

public PibKeyImpl(Name keyName,
                  ByteBuffer keyEncoding,
                  PibImpl pibImpl)
           throws PibImpl.Error

Create a PibKeyImpl with keyName. If the key does not exist in the backend implementation, add it by creating it from the keyEncoding. If a key with keyName already exists, overwrite it.

Parameters:

keyName - The name of the key, which is copied.

keyEncoding - The buffer of encoded key bytes, which is copied.

pibImpl - The Pib backend implementation.

Throws:

PibImpl.Error

PibKeyImpl

public PibKeyImpl(Name keyName,
                  PibImpl pibImpl)
           throws Pib.Error,
                  PibImpl.Error

Create a PibKeyImpl with keyName. Initialize the cached key encoding with pibImpl.getKeyBits().

Parameters:

keyName - The name of the key, which is copied.

pibImpl - The Pib backend implementation.

Throws:

Pib.Error - if the key with keyName does not exist.

PibImpl.Error

Method Detail

getName

public final Name getName()

getIdentityName

public final Name getIdentityName()

Get the name of the identity this key belongs to.

Returns:

The name of the identity. You must not change the object. If you need to change it, make a copy.

getKeyType

public final KeyType getKeyType()

Get the key type.

Returns:

The key type.

getPublicKey

public final Blob getPublicKey()

Get the public key encoding.

Returns:

The public key encoding.

addCertificate

public final void addCertificate(CertificateV2 certificate)
                          throws CertificateV2.Error,
                                 PibImpl.Error

Add the certificate. If a certificate with the same name (without implicit digest) already exists, then overwrite the certificate. If no default certificate for the key has been set, then set the added certificate as default for the key.

Parameters:

certificate - The certificate to add. This copies the object.

Throws:

IllegalArgumentException - if the name of the certificate does not match the key name.

CertificateV2.Error

PibImpl.Error

removeCertificate

public final void removeCertificate(Name certificateName)
                             throws PibImpl.Error

Remove the certificate with name certificateName. If the certificate does not exist, do nothing.

Parameters:

certificateName - The name of the certificate.

Throws:

IllegalArgumentException - if certificateName does not match the key name.

PibImpl.Error

getCertificate

public final CertificateV2 getCertificate(Name certificateName)
                                   throws Pib.Error,
                                          PibImpl.Error

Get the certificate with name certificateName.

Parameters:

certificateName - The name of the certificate.

Returns:

A copy of the CertificateV2 object.

Throws:

IllegalArgumentException - if certificateName does not match the key name.

Pib.Error - if the certificate does not exist.

PibImpl.Error

setDefaultCertificate

public final CertificateV2 setDefaultCertificate(Name certificateName)
                                          throws Pib.Error,
                                                 PibImpl.Error

Set the existing certificate with name certificateName as the default certificate.

Parameters:

certificateName - The name of the certificate.

Returns:

The default certificate.

Throws:

IllegalArgumentException - if certificateName does not match the key name

Pib.Error - if the certificate does not exist.

PibImpl.Error

setDefaultCertificate

public final CertificateV2 setDefaultCertificate(CertificateV2 certificate)
                                          throws CertificateV2.Error,
                                                 PibImpl.Error,
                                                 Pib.Error

Add the certificate and set it as the default certificate of the key. If a certificate with the same name (without implicit digest) already exists, then overwrite the certificate.

Parameters:

certificate - The certificate to add. This copies the object.

Returns:

The default certificate.

Throws:

IllegalArgumentException - if the name of the certificate does not match the key name.

CertificateV2.Error

PibImpl.Error

Pib.Error

getDefaultCertificate

public final CertificateV2 getDefaultCertificate()
                                          throws Pib.Error,
                                                 PibImpl.Error

Get the default certificate for this Key.

Returns:

A copy of the default certificate.

Throws:

Pib.Error - if the default certificate does not exist.

PibImpl.Error

getCertificates_

public final PibCertificateContainer getCertificates_()

Get the certificates_ container, which should only be used for testing.