net.named_data.jndn.security.pib.detail

Class PibIdentityImpl

java.lang.Object

net.named_data.jndn.security.pib.detail.PibIdentityImpl

public class PibIdentityImpl
extends Object

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

Constructor Summary

Constructors

Constructor and Description
PibIdentityImpl(Name identityName, PibImpl pibImpl, boolean needInit) Create a PibIdentityImpl with identityName.

Method Summary

Modifier and Type	Method and Description
PibKey	addKey(ByteBuffer key, Name keyName) Add the key.
PibKey	getDefaultKey() Get the default key of this Identity.
PibKey	getKey(Name keyName) Get the key with name keyName.
PibKeyContainer	getKeys_() Get the PibKeyContainer.
Name	getName()
void	removeKey(Name keyName) Remove the key with keyName and its related certificates.
PibKey	setDefaultKey(ByteBuffer key, Name keyName) Add a key with name keyName and set it as the default key of the identity.
PibKey	setDefaultKey(Name keyName) Set the key with name keyName as the default key of the identity.

Methods inherited from class java.lang.Object

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

Constructor Detail

PibIdentityImpl

public PibIdentityImpl(Name identityName,
                       PibImpl pibImpl,
                       boolean needInit)
                throws PibImpl.Error,
                       Pib.Error

Create a PibIdentityImpl with identityName.

Parameters:

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

pibImpl - The Pib backend implementation.

needInit - If true and the identity does not exist in the pibImpl back end, then create it (and If no default identity has been set, identityName becomes the default). If false, then throw Pib.Error if the identity does not exist in the pibImpl back end.

Throws:

Pib.Error - if the identity does not exist in the pibImpl back end and needInit is false.

PibImpl.Error

Method Detail

getName

public final Name getName()

addKey

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

Add the key. If a key with the same name already exists, overwrite the key. If no default key for the identity has been set, then set the added key as default for the identity.

Parameters:

key - The public key bits. This copies the buffer.

keyName - The name of the key. This copies the name.

Returns:

The PibKey object.

Throws:

PibImpl.Error

Pib.Error

removeKey

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

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

Parameters:

keyName - The name of the key.

Throws:

PibImpl.Error

getKey

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

Get the key with name keyName.

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

setDefaultKey

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

Set the key with name keyName as the default key of the identity.

Parameters:

keyName - The name of the key. This copies the name.

Returns:

The PibKey object of the default key.

Throws:

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

Pib.Error - if the key does not exist.

PibImpl.Error

setDefaultKey

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

Add a key with name keyName and set it as the default key of the identity.

Parameters:

key - The buffer of encoded key bytes.

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

Returns:

The PibKey object of the default key.

Throws:

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

Pib.Error - if a key with the same name already exists.

PibImpl.Error

getDefaultKey

public final PibKey getDefaultKey()
                           throws Pib.Error,
                                  PibImpl.Error

Get the default key of this Identity.

Returns:

The default PibKey.

Throws:

Pib.Error - if the default key has not been set.

PibImpl.Error

getKeys_

public PibKeyContainer getKeys_()

Get the PibKeyContainer. This should only be called by PibIdentity.