net.named_data.jndn.security.v2

Class TrustAnchorContainer

java.lang.Object

net.named_data.jndn.security.v2.TrustAnchorContainer

public class TrustAnchorContainer
extends Object

A TrustAnchorContainer represents a container for trust anchors. There are two kinds of anchors: static anchors that are permanent for the lifetime of the container, and dynamic anchors that are periodically updated. Trust anchors are organized in groups. Each group has a unique group id. The same anchor certificate (same name without considering the implicit digest) can be inserted into multiple groups, but no more than once into each. Dynamic groups are created using the appropriate TrustAnchorContainer.insert method. Once created, the dynamic anchor group cannot be updated. The returned pointer to Certificate from `find` methods is only guaranteed to be valid until the next invocation of `find` and may be invalidated afterwards.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrustAnchorContainer.Error Note that even though this is called "Error" to be consistent with the other libraries, it extends the Java Exception class, not Error.

Constructor Summary

Constructors

Constructor and Description
TrustAnchorContainer()

Method Summary

Modifier and Type	Method and Description
void	clear() Remove all static and dynamic anchors.
CertificateV2	find(Interest interest) Find a certificate for the given interest.
CertificateV2	find(Name keyName) Search for a certificate across all groups (longest prefix match).
TrustAnchorGroup	getGroup(String groupId) Get the trust anchor group for the groupId.
void	insert(String groupId, CertificateV2 certificate) Insert a static trust anchor.
void	insert(String groupId, String path, double refreshPeriod) Call the main insert where isDirectory is false.
void	insert(String groupId, String path, double refreshPeriod, boolean isDirectory) Insert dynamic trust anchors from the path.
int	size() Get the number of trust anchors across all groups.

Methods inherited from class java.lang.Object

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

Constructor Detail

TrustAnchorContainer

public TrustAnchorContainer()

Method Detail

insert

public final void insert(String groupId,
                         CertificateV2 certificate)
                  throws TrustAnchorContainer.Error

Insert a static trust anchor. If the certificate (having the same name without considering implicit digest) already exists in the group with groupId, then do nothing.

Parameters:

groupId - The certificate group id.

certificate - The certificate to insert, which is copied.

Throws:

TrustAnchorContainer.Error - If groupId is a dynamic anchor group .

insert

public final void insert(String groupId,
                         String path,
                         double refreshPeriod,
                         boolean isDirectory)
                  throws TrustAnchorContainer.Error

Insert dynamic trust anchors from the path.

Parameters:

groupId - The certificate group id, which must not be empty.

path - The path to load the trust anchors.

refreshPeriod - The refresh time in milliseconds for the anchors under path. This must be positive. The relevant trust anchors will only be updated when find is called.

isDirectory - If true, then path is a directory. If false, it is a single file.

Throws:

IllegalArgumentException - If refreshPeriod is not positive.

TrustAnchorContainer.Error - a group with groupId already exists

insert

public final void insert(String groupId,
                         String path,
                         double refreshPeriod)
                  throws TrustAnchorContainer.Error

Call the main insert where isDirectory is false.

Throws:

TrustAnchorContainer.Error

clear

public final void clear()

Remove all static and dynamic anchors.

find

public final CertificateV2 find(Name keyName)

Search for a certificate across all groups (longest prefix match).

Parameters:

keyName - The key name prefix for searching for the certificate.

Returns:

The found certificate, or null if not found.

find

public final CertificateV2 find(Interest interest)

Find a certificate for the given interest.

Parameters:

interest - The input interest packet.

Returns:

The found certificate, or null if not found.

Note:

Interest with implicit digest is not supported., ChildSelector is not supported.

getGroup

public final TrustAnchorGroup getGroup(String groupId)
                                throws TrustAnchorContainer.Error

Get the trust anchor group for the groupId.

Parameters:

groupId - The group ID.

Returns:

The trust anchor group.

Throws:

TrustAnchorContainer.Error - if the groupId does not exist.

size

public final int size()

Get the number of trust anchors across all groups.

Returns:

The number of trust anchors.