net.named_data.jndn.security

Class CommandInterestPreparer

java.lang.Object

net.named_data.jndn.security.CommandInterestPreparer

Direct Known Subclasses:

CommandInterestGenerator, CommandInterestSigner

public class CommandInterestPreparer
extends Object

A CommandInterestPreparer keeps track of a timestamp and prepares a command interest by adding a timestamp and nonce to the name of an Interest. This class is primarily designed to be used by the CommandInterestSigner, but can also be using in an application that defines custom signing methods not supported by the KeyChain (such as HMAC-SHA1). See the Command Interest documentation: https://redmine.named-data.net/projects/ndn-cxx/wiki/CommandInterest

Constructor Summary

Constructors

Constructor and Description
CommandInterestPreparer() Create a CommandInterestPreparer and initialize the timestamp to now.

Method Summary

Modifier and Type	Method and Description
void	prepareCommandInterestName(Interest interest) Append a timestamp component and a random nonce component to interest's name.
void	prepareCommandInterestName(Interest interest, WireFormat wireFormat) Append a timestamp component and a random nonce component to interest's name.
void	setNowOffsetMilliseconds_(double nowOffsetMilliseconds) Set the offset for when prepareCommandInterestName() gets 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

CommandInterestPreparer

public CommandInterestPreparer()

Create a CommandInterestPreparer and initialize the timestamp to now.

Method Detail

prepareCommandInterestName

public void prepareCommandInterestName(Interest interest,
                                       WireFormat wireFormat)

Append a timestamp component and a random nonce component to interest's name. This ensures that the timestamp is greater than the timestamp used in the previous call.

Parameters:

interest - The interest whose name is append with components.

wireFormat - A WireFormat object used to encode the SignatureInfo.

prepareCommandInterestName

public void prepareCommandInterestName(Interest interest)

Append a timestamp component and a random nonce component to interest's name. This ensures that the timestamp is greater than the timestamp used in the previous call. Use the default WireFormat to encode the SignatureInfo.

Parameters:

interest - The interest whose name is append with components.

setNowOffsetMilliseconds_

public final void setNowOffsetMilliseconds_(double nowOffsetMilliseconds)

Set the offset for when prepareCommandInterestName() gets the current time, which should only be used for testing.

Parameters:

nowOffsetMilliseconds - The offset in milliseconds.