net.adamcin.oakpal.api

Class Rules

java.lang.Object

net.adamcin.oakpal.api.Rules

public final class Rules
extends Object

Factory methods and defaults for Rule.

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static Rule	DEFAULT_ALLOW A default ALLOW rule that matches everything.
static Rule	DEFAULT_DENY A default DENY rule that matches everything.
static Rule	DEFAULT_EXCLUDE A default EXCLUDE rule that matches everything.
static Rule	DEFAULT_INCLUDE A default INCLUDE rule that matches everything.

Method Summary

Modifier and Type	Method and Description
static Rule	fromJson(javax.json.JsonObject ruleJson) Construct a single rule from a JSON object with keys type and pattern.
static List<Rule>	fromJsonArray(javax.json.JsonArray rulesArray) Conveniently creates a list of Rules from the conventional use case of a JSON array containing a list of rule JSON objects to be evaluated in sequence.
static Rule	fuzzyDefaultAllow(List<Rule> rules) Return DEFAULT_ALLOW, unless first element in rules list is an explicit allow, in which case return DEFAULT_DENY.
static Rule	fuzzyDefaultDeny(List<Rule> rules) Return DEFAULT_DENY, unless first element in rules list is an explicit deny, in which case return DEFAULT_ALLOW.
static Rule	fuzzyDefaultExclude(List<Rule> rules) Return DEFAULT_EXCLUDE, unless first element in rules list is an explicit exclude, in which case return DEFAULT_INCLUDE.
static Rule	fuzzyDefaultInclude(List<Rule> rules) Return DEFAULT_INCLUDE, unless first element in rules list is an explicit include, in which case return DEFAULT_EXCLUDE.
static Rule	lastMatch(List<Rule> rules, String value) Evaluate the provided list of rules against the String value, using fuzzyDefaultInclude(List) to select the default rule when none match.
static Rule	lastMatch(List<Rule> rules, String value, Function<List<Rule>,Rule> selectDefault) Evaluate the provided list of rules against the String value using the provided selector function to select the default rule when none match.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DENY

public static final Rule DEFAULT_DENY

A default DENY rule that matches everything.

DEFAULT_ALLOW

public static final Rule DEFAULT_ALLOW

A default ALLOW rule that matches everything.

DEFAULT_EXCLUDE

public static final Rule DEFAULT_EXCLUDE

A default EXCLUDE rule that matches everything.

DEFAULT_INCLUDE

public static final Rule DEFAULT_INCLUDE

A default INCLUDE rule that matches everything.

Method Detail

fromJsonArray

public static List<Rule> fromJsonArray(javax.json.JsonArray rulesArray)

Conveniently creates a list of Rules from the conventional use case of a JSON array containing a list of rule JSON objects to be evaluated in sequence.

Parameters:

rulesArray - a JSON array where calling fromJson(JsonObject) on each element will construct a valid Rule

Returns:

a list of rules to be evaluated in sequence.

fromJson

public static Rule fromJson(javax.json.JsonObject ruleJson)

Construct a single rule from a JSON object with keys type and pattern.

Parameters:

ruleJson - a single rule config object

Returns:

a new rule

fuzzyDefaultAllow

public static Rule fuzzyDefaultAllow(List<Rule> rules)

Return DEFAULT_ALLOW, unless first element in rules list is an explicit allow, in which case return DEFAULT_DENY.

Parameters:

rules - rules list

Returns:

usually DEFAULT_ALLOW, but sometimes DEFAULT_DENY

fuzzyDefaultDeny

public static Rule fuzzyDefaultDeny(List<Rule> rules)

Return DEFAULT_DENY, unless first element in rules list is an explicit deny, in which case return DEFAULT_ALLOW.

Parameters:

rules - rules list

Returns:

usually DEFAULT_EXCLUDE, but sometimes DEFAULT_INCLUDE

fuzzyDefaultInclude

public static Rule fuzzyDefaultInclude(List<Rule> rules)

Return DEFAULT_INCLUDE, unless first element in rules list is an explicit include, in which case return DEFAULT_EXCLUDE.

Parameters:

rules - rules list

Returns:

usually DEFAULT_INCLUDE, but sometimes DEFAULT_EXCLUDE

fuzzyDefaultExclude

public static Rule fuzzyDefaultExclude(List<Rule> rules)

Return DEFAULT_EXCLUDE, unless first element in rules list is an explicit exclude, in which case return DEFAULT_INCLUDE.

Parameters:

rules - rules list

Returns:

usually DEFAULT_EXCLUDE, but sometimes DEFAULT_INCLUDE

lastMatch

public static Rule lastMatch(List<Rule> rules,
                             String value,
                             Function<List<Rule>,Rule> selectDefault)

Evaluate the provided list of rules against the String value using the provided selector function to select the default rule when none match.

Parameters:

rules - a list of rules to match against the value. the last one to match, if any, is returned.

value - the string value to match against.

selectDefault - a function to select the default rule based on the specified list of rules.

Returns:

the last rule in the list that matches the value, or a default rule

lastMatch

public static Rule lastMatch(List<Rule> rules,
                             String value)

Evaluate the provided list of rules against the String value, using fuzzyDefaultInclude(List) to select the default rule when none match.

Parameters:

rules - a list of rules to match against the value. the last one to match, if any, is returned.

value - the string value to match against.

Returns:

the last rule in the list that matches the value, or a default rule