net.named_data.jndn.security.pib

Class PibCertificateContainer

java.lang.Object

net.named_data.jndn.security.pib.PibCertificateContainer

public class PibCertificateContainer
extends Object

A PibCertificateContainer is used to search/enumerate the certificates of a key. (A PibCertificateContainer object can only be created by PibKey.)

Constructor Summary

Constructors

Constructor and Description
PibCertificateContainer(Name keyName, PibImpl pibImpl) Create a PibCertificateContainer for a key with keyName.

Method Summary

Modifier and Type	Method and Description
void	add(CertificateV2 certificate) Add certificate into the container.
CertificateV2	get(Name certificateName) Get the certificate with certificateName from the container.
HashMap<Name,CertificateV2>	getCertificates_() Get the certificates_ map, which should only be used for testing.
boolean	isConsistent() Check if the container is consistent with the backend storage.
void	remove(Name certificateName) Remove the certificate with name certificateName from the container.
int	size() Get the number of certificates in the container.

Methods inherited from class java.lang.Object

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

Constructor Detail

PibCertificateContainer

public PibCertificateContainer(Name keyName,
                               PibImpl pibImpl)
                        throws PibImpl.Error

Create a PibCertificateContainer for a key with keyName. This constructor should only be called by PibKeyImpl.

Parameters:

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

pibImpl - The PIB backend implementation.

Throws:

PibImpl.Error

Method Detail

size

public final int size()

Get the number of certificates in the container.

Returns:

The number of certificates.

add

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

Add certificate into the container. If the certificate already exists, this replaces it.

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

remove

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

Remove the certificate with name certificateName from the container. 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

get

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

Get the certificate with certificateName from the container.

Parameters:

certificateName - The name of the certificate.

Returns:

A copy of the certificate.

Throws:

IllegalArgumentException - if certificateName does not match the key name

Pib.Error - if the certificate does not exist.

PibImpl.Error

isConsistent

public final boolean isConsistent()
                           throws PibImpl.Error

Check if the container is consistent with the backend storage.

Returns:

True if the container is consistent, false otherwise.

Throws:

PibImpl.Error

Note:

This method is heavy-weight and should be used in a debugging mode only.

getCertificates_

public final HashMap<Name,CertificateV2> getCertificates_()

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