net.named_data.jndn.security.pib

Class PibIdentityContainer

java.lang.Object

net.named_data.jndn.security.pib.PibIdentityContainer

public class PibIdentityContainer
extends Object

A PibIdentityContainer is used to search/enumerate the identities in a PIB. (A PibIdentityContainer object can only be created by the Pib class.)

Constructor Summary

Constructors

Constructor and Description
PibIdentityContainer(PibImpl pibImpl) Create a PibIdentityContainer using to use the pibImpl backend implementation.

Method Summary

Modifier and Type	Method and Description
PibIdentity	add(Name identityName) Add an identity with name identityName into the container.
PibIdentity	get(Name identityName) Get the identity with name identityName from the container.
HashMap<Name,PibIdentityImpl>	getIdentities_() Get the identities_ map, which should only be used for testing.
void	remove(Name identityName) Remove the identity with name identityName from the container, and its related keys and certificates.
int	size() Get the number of identities in the container.

Methods inherited from class java.lang.Object

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

Constructor Detail

PibIdentityContainer

public PibIdentityContainer(PibImpl pibImpl)
                     throws PibImpl.Error

Create a PibIdentityContainer using to use the pibImpl backend implementation. This constructor should only be called by the Pib class.

Parameters:

pibImpl - The PIB backend implementation.

Throws:

PibImpl.Error

Method Detail

size

public final int size()

Get the number of identities in the container.

Returns:

The number of identities.

add

public final PibIdentity add(Name identityName)
                      throws PibImpl.Error,
                             Pib.Error

Add an identity with name identityName into the container. Create the identity if it does not exist.

Parameters:

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

Returns:

The PibIdentity object.

Throws:

PibImpl.Error

Pib.Error

remove

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

Remove the identity with name identityName from the container, and its related keys and certificates. If the default identity is being removed, no default identity will be selected. If the identity does not exist, do nothing.

Parameters:

identityName - The name of the identity.

Throws:

PibImpl.Error

get

public final PibIdentity get(Name identityName)
                      throws PibImpl.Error,
                             Pib.Error

Get the identity with name identityName from the container.

Parameters:

identityName - The name of the identity.

Returns:

The PibIdentity object.

Throws:

Pib.Error - if the identity does not exist.

PibImpl.Error

getIdentities_

public final HashMap<Name,PibIdentityImpl> getIdentities_()

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