net.named_data.jndn.security.v2

Class CertificateCacheV2

java.lang.Object

net.named_data.jndn.security.v2.CertificateCacheV2

public class CertificateCacheV2
extends Object

A CertificateCacheV2 holds other user's verified certificates in security v2 format CertificateV2. A certificate is removed no later than its NotAfter time, or maxLifetime after it has been added to the cache.

Constructor Summary

Constructors

Constructor and Description
CertificateCacheV2() Create a CertificateCacheV2.
CertificateCacheV2(double maxLifetimeMilliseconds) Create a CertificateCacheV2.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear all certificates from the cache.
void	deleteCertificate(Name certificateName) Remove the certificate whose name equals the given name.
CertificateV2	find(Interest interest) Find the certificate by the given interest.
CertificateV2	find(Name certificatePrefix) Find the certificate by the given key name.
static double	getDefaultLifetime() Get the default maximum lifetime (1 hour).
void	insert(CertificateV2 certificate) Insert the certificate into the cache.
void	setNowOffsetMilliseconds_(double nowOffsetMilliseconds) Set the offset when insert() and refresh() get the current time, which should only be used for testing.

Methods inherited from class java.lang.Object

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

Constructor Detail

CertificateCacheV2

public CertificateCacheV2(double maxLifetimeMilliseconds)

Create a CertificateCacheV2.

Parameters:

maxLifetimeMilliseconds - The maximum time that certificates can live inside the cache, in milliseconds.

CertificateCacheV2

public CertificateCacheV2()

Create a CertificateCacheV2. Set the maximum time that certificates can live inside the cache to getDefaultLifetime().

Method Detail

insert

public final void insert(CertificateV2 certificate)
                  throws CertificateV2.Error

Insert the certificate into the cache. The inserted certificate will be removed no later than its NotAfter time, or maxLifetimeMilliseconds given to the constructor.

Parameters:

certificate - The certificate object, which is copied.

Throws:

CertificateV2.Error

find

public final CertificateV2 find(Name certificatePrefix)

Find the certificate by the given key name.

Parameters:

certificatePrefix - The certificate prefix for searching for the certificate.

Returns:

The found certificate, or null if not found. You must not modify the returned object. If you need to modify it, then make a copy.

find

public final CertificateV2 find(Interest interest)

Find the certificate by the given interest.

Parameters:

interest - The input interest object.

Returns:

The found certificate which matches the interest, or null if not found. You must not modify the returned object. If you need to modify it, then make a copy.

Note:

ChildSelector is not supported.

deleteCertificate

public final void deleteCertificate(Name certificateName)

Remove the certificate whose name equals the given name. If no such certificate is in the cache, do nothing.

Parameters:

certificateName - The name of the certificate.

clear

public final void clear()

Clear all certificates from the cache.

getDefaultLifetime

public static double getDefaultLifetime()

Get the default maximum lifetime (1 hour).

Returns:

The lifetime in milliseconds.

setNowOffsetMilliseconds_

public final void setNowOffsetMilliseconds_(double nowOffsetMilliseconds)

Set the offset when insert() and refresh() get the current time, which should only be used for testing.

Parameters:

nowOffsetMilliseconds - The offset in milliseconds.