net.named_data.jndn.security.v2.validator_config

Class ConfigRule

java.lang.Object

net.named_data.jndn.security.v2.validator_config.ConfigRule

public class ConfigRule
extends Object

A ConfigRule represents a rule configuration section, used by ConfigValidator.

Constructor Summary

Constructors

Constructor and Description
ConfigRule(String id, boolean isForInterest) Create a ConfigRule with empty filters and checkers.

Method Summary

Modifier and Type	Method and Description
void	addChecker(ConfigChecker checker) Add the ConfigChecker to the list of checkers.
void	addFilter(ConfigFilter filter) Add the ConfigFilter to the list of filters.
boolean	check(boolean isForInterest, Name packetName, Name keyLocatorName, ValidationState state) Check if the packet satisfies the rule's condition.
static ConfigRule	create(BoostInfoTree configSection) Create a rule from configuration section.
String	getId() Get the rule ID.
boolean	getIsForInterest() Get the isForInterest flag.
boolean	match(boolean isForInterest, Name packetName) Check if the packet name matches the rule's filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigRule

public ConfigRule(String id,
                  boolean isForInterest)

Create a ConfigRule with empty filters and checkers.

Parameters:

id - The rule ID from the configuration section.

isForInterest - True if the rule is for an Interest packet, false if it is for a Data packet.

Method Detail

getId

public final String getId()

Get the rule ID.

Returns:

The rule ID.

getIsForInterest

public final boolean getIsForInterest()

Get the isForInterest flag.

Returns:

True if the rule is for an Interest packet, false if it is for a Data packet.

addFilter

public final void addFilter(ConfigFilter filter)

Add the ConfigFilter to the list of filters.

Parameters:

filter - The ConfigFilter.

addChecker

public final void addChecker(ConfigChecker checker)

Add the ConfigChecker to the list of checkers.

Parameters:

checker - The ConfigChecker.

match

public final boolean match(boolean isForInterest,
                           Name packetName)
                    throws ValidatorConfigError

Check if the packet name matches the rule's filter. If no filters were added, the rule matches everything.

Parameters:

isForInterest - True if packetName is for an Interest, false if for a Data packet.

packetName - The packet name. For a signed interest, the last two components are skipped but not removed.

Returns:

True if at least one filter matches the packet name, false if none of the filters match the packet name.

Throws:

ValidatorConfigError - if the supplied isForInterest doesn't match the one for which the rule is designed.

check

public final boolean check(boolean isForInterest,
                           Name packetName,
                           Name keyLocatorName,
                           ValidationState state)
                    throws ValidatorConfigError

Check if the packet satisfies the rule's condition.

Parameters:

isForInterest - True if packetName is for an Interest, false if for a Data packet.

packetName - The packet name. For a signed interest, the last two components are skipped but not removed.

keyLocatorName - The KeyLocator's name.

state - This calls state.fail() if the packet is invalid.

Returns:

True if further signature verification is needed, or false if the packet is immediately determined to be invalid in which case this calls state.fail() with the proper code and message.

Throws:

ValidatorConfigError - if the supplied isForInterest doesn't match the one for which the rule is designed.

create

public static ConfigRule create(BoostInfoTree configSection)
                         throws ValidatorConfigError

Create a rule from configuration section.

Parameters:

configSection - The section containing the definition of the checker, e.g. one of "validator.rule".

Returns:

A new ConfigRule created from the configuration

Throws:

ValidatorConfigError