net.named_data.jndn.security.pib

Class PibKeyContainer

java.lang.Object

net.named_data.jndn.security.pib.PibKeyContainer

public class PibKeyContainer
extends Object

A PibKeyContainer is used to search/enumerate the keys of an identity. (A PibKeyContainer object can only be created by PibIdentity.)

Constructor Summary

Constructors

Constructor and Description
PibKeyContainer(Name identityName, PibImpl pibImpl) Create a PibKeyContainer for an identity with identityName.

Method Summary

Modifier and Type	Method and Description
PibKey	add(ByteBuffer key, Name keyName) Add a key with name keyName into the container.
PibKey	get(Name keyName) Get the key with name keyName from the container.
ArrayList<Name>	getKeyNames() Get the names of all the keys in the container.
HashMap<Name,PibKeyImpl>	getKeys_() Get the keys_ map, which should only be used for testing.
boolean	isConsistent() Check if the container is consistent with the backend storage.
void	remove(Name keyName) Remove the key with name keyName from the container, and its related certificates.
int	size() Get the number of keys in the container.

Methods inherited from class java.lang.Object

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

Constructor Detail

PibKeyContainer

public PibKeyContainer(Name identityName,
                       PibImpl pibImpl)
                throws PibImpl.Error

Create a PibKeyContainer for an identity with identityName. This constructor should only be called by PibIdentityImpl.

Parameters:

identityName - The name of the identity, which is copied.

pibImpl - The PIB backend implementation.

Throws:

PibImpl.Error

Method Detail

size

public final int size()

Get the number of keys in the container.

Returns:

The number of keys.

add

public final PibKey add(ByteBuffer key,
                        Name keyName)
                 throws PibImpl.Error,
                        Pib.Error

Add a key with name keyName into the container. If a key with the same name already exists, this replaces it.

Parameters:

key - The buffer of encoded key bytes.

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

Returns:

The PibKey object.

Throws:

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

PibImpl.Error

Pib.Error

remove

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

Remove the key with name keyName from the container, and its related certificates. If the key does not exist, do nothing.

Parameters:

keyName - The name of the key.

Throws:

IllegalArgumentException - if keyName does not match the identity name.

PibImpl.Error

get

public final PibKey get(Name keyName)
                 throws Pib.Error,
                        PibImpl.Error

Get the key with name keyName from the container.

Parameters:

keyName - The name of the key.

Returns:

The PibKey object.

Throws:

IllegalArgumentException - if keyName does not match the identity name.

Pib.Error - if the key does not exist.

PibImpl.Error

getKeyNames

public final ArrayList<Name> getKeyNames()

Get the names of all the keys in the container.

Returns:

A new list of Name.

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.

getKeys_

public final HashMap<Name,PibKeyImpl> getKeys_()

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