net.named_data.jndn.security

Class ValidityPeriod

java.lang.Object

net.named_data.jndn.security.ValidityPeriod

All Implemented Interfaces:

ChangeCountable

public class ValidityPeriod
extends Object
implements ChangeCountable

A ValidityPeriod is used in a Data packet's SignatureInfo and represents the begin and end times of a certificate's validity period.

Constructor Summary

Constructors

Constructor and Description
ValidityPeriod() Create a default ValidityPeriod where the period is not specified.
ValidityPeriod(double notBefore, double notAfter) Create a ValidityPeriod with the given period.
ValidityPeriod(ValidityPeriod validityPeriod) Create a new ValidityPeriod with a copy of the fields in the given validityPeriod.

Method Summary

Modifier and Type	Method and Description
static boolean	canGetFromSignature(Signature signature) If the signature is a type that has a ValidityPeriod (so that getFromSignature will succeed), return true.
void	clear() Reset to a default ValidityPeriod where the period is not specified.
boolean	equals(Object other)
boolean	equals(ValidityPeriod other) Check if this is the same validity period as other.
long	getChangeCount() Get the change count, which is incremented each time this object is changed.
static ValidityPeriod	getFromSignature(Signature signature) If the signature is a type that has a ValidityPeriod, then return it.
double	getNotAfter() Get the end of the validity period range.
double	getNotBefore() Get the beginning of the validity period range.
boolean	hasPeriod() Check if the period has been set.
boolean	isValid() Check if the current time falls within the validity period.
boolean	isValid(double time) Check if the time falls within the validity period.
ValidityPeriod	setPeriod(double notBefore, double notAfter) Set the validity period.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidityPeriod

public ValidityPeriod()

Create a default ValidityPeriod where the period is not specified.

ValidityPeriod

public ValidityPeriod(ValidityPeriod validityPeriod)

Create a new ValidityPeriod with a copy of the fields in the given validityPeriod.

Parameters:

validityPeriod - The ValidityPeriod to copy.

ValidityPeriod

public ValidityPeriod(double notBefore,
                      double notAfter)

Create a ValidityPeriod with the given period.

Parameters:

notBefore - The beginning of the validity period range as milliseconds since Jan 1, 1970 UTC. Note that this is rounded up to the nearest whole second.

notAfter - The end of the validity period range as milliseconds since Jan 1, 1970 UTC. Note that this is rounded down to the nearest whole second.

Method Detail

hasPeriod

public final boolean hasPeriod()

Check if the period has been set.

Returns:

True if the period has been set, false if the period is not specified (after calling the default constructor or clear).

getNotBefore

public final double getNotBefore()

Get the beginning of the validity period range.

Returns:

The time as milliseconds since Jan 1, 1970 UTC.

getNotAfter

public final double getNotAfter()

Get the end of the validity period range.

Returns:

The time as milliseconds since Jan 1, 1970 UTC.

clear

public final void clear()

Reset to a default ValidityPeriod where the period is not specified.

setPeriod

public final ValidityPeriod setPeriod(double notBefore,
                                      double notAfter)

Set the validity period.

Parameters:

notBefore - The beginning of the validity period range as milliseconds since Jan 1, 1970 UTC. Note that this is rounded up to the nearest whole second.

notAfter - The end of the validity period range as milliseconds since Jan 1, 1970 UTC. Note that this is rounded down to the nearest whole second.

Returns:

This ValidityPeriod so that you can chain calls to update values.

equals

public final boolean equals(ValidityPeriod other)

Check if this is the same validity period as other.

Parameters:

other - The other ValidityPeriod to compare with.

Returns:

true if the validity periods are equal.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

isValid

public final boolean isValid(double time)

Check if the time falls within the validity period.

Parameters:

time - The time to check as milliseconds since Jan 1, 1970 UTC.

Returns:

True if the beginning of the validity period is less than or equal to time and time is less than or equal to the end of the validity period.

isValid

public final boolean isValid()

Check if the current time falls within the validity period.

Returns:

True if the beginning of the validity period is less than or equal to the current time and the current time is less than or equal to the end of the validity period.

canGetFromSignature

public static boolean canGetFromSignature(Signature signature)

If the signature is a type that has a ValidityPeriod (so that getFromSignature will succeed), return true. Note: This is a static method of ValidityPeriod instead of a method of Signature so that the Signature base class does not need to be overloaded with all the different kinds of information that various signature algorithms may use.

Parameters:

signature - An object of a subclass of Signature.

Returns:

True if the signature is a type that has a ValidityPeriod, otherwise false.

getFromSignature

public static ValidityPeriod getFromSignature(Signature signature)

If the signature is a type that has a ValidityPeriod, then return it. Otherwise throw an error. To check if the signature has a ValidityPeriod without throwing an error, you can use canGetFromSignature().

Parameters:

signature - An object of a subclass of Signature.

Returns:

The signature's ValidityPeriod. It is an error if signature doesn't have a ValidityPeriod.

getChangeCount

public final long getChangeCount()

Get the change count, which is incremented each time this object is changed.

Specified by:

getChangeCount in interface ChangeCountable

Returns:

The change count.