net.named_data.jndn.security.pib

Class PibIdentity

java.lang.Object

net.named_data.jndn.security.pib.PibIdentity

public class PibIdentity
extends Object

PibIdentity is at the top level in PIB's Identity-Key-Certificate hierarchy. An identity has a Name, and contains zero or more keys, at most one of which is set as the default key of this identity. Properties of a key can be accessed after obtaining a PibKey object.

Constructor Summary

Constructors

Constructor and Description
PibIdentity(PibIdentityImpl impl) Create a PibIdentity which uses the impl backend implementation.

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 in the PibIdentityImpl.
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

PibIdentity

public PibIdentity(PibIdentityImpl impl)

Create a PibIdentity which uses the impl backend implementation. This constructor should only be called by PibIdentityContainer.

Method Detail

getName

public final Name getName()

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:

AssertionError - if the backend implementation instance is invalid.

IllegalArgumentException - if keyName does not match the identity name.

Pib.Error - if the key does not exist.

PibImpl.Error

getDefaultKey

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

Get the default key of this Identity.

Returns:

The default PibKey.

Throws:

AssertionError - if the backend implementation instance is invalid.

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

PibImpl.Error

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. This should only be called by KeyChain.

Parameters:

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

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. This should only be called by KeyChain.

Parameters:

keyName - The name of the key.

Throws:

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. This should only be called by KeyChain.

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. This should only be called by KeyChain.

Parameters:

key - The array 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

getKeys_

public final PibKeyContainer getKeys_()

Get the PibKeyContainer in the PibIdentityImpl. This should only be called by KeyChain.