Rule (inversion-api 0.9.11.1 API)

java.lang.Object
- io.inversion.Rule<R>

All Implemented Interfaces:

java.lang.Comparable<R>

Direct Known Subclasses:

AclRule, Action, Api, Collection, Endpoint, Engine
```
public abstract class Rule<R extends Rule>
extends java.lang.Object
implements java.lang.Comparable<R>
```
Matches against an HTTP method and URL path to determine if the object should be included when processing the associated Request.
Matching relies heavily on variablized Path matching via io.inversion.Path.match

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Rule.RuleMatcher

Nested Classes
Modifier and Type	Class and Description
`static class`	`Rule.RuleMatcher`

Field Summary

Fields
Modifier and Type	Field and Description
`protected JSNode`	`configMap` `JSNode` is used because it implements a case insensitive map without modifying the keys
`protected java.lang.String`	`configStr`
`protected java.util.List<Rule.RuleMatcher>`	`excludeMatchers` Method/path combinations that would cause this Rule to be excluded from the relevant processing.
`protected java.util.List<Rule.RuleMatcher>`	`includeMatchers` Method/path combinations that would cause this Rule to be included in the relevant processing.
`protected org.slf4j.Logger`	`log`
`protected java.lang.String`	`name` The name used for configuration and debug purposes.
`protected int`	`order` Rules are always processed in sequence sorted by ascending order.

Constructor Summary

Constructors
Constructor and Description

Rule()

Constructors
Constructor and Description
`Rule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkLazyConfig()`
`int`	`compareTo(Rule a)`
`protected void`	`doLazyConfig()`
`java.lang.String`	`getConfig(java.lang.String key)`
`java.lang.String`	`getConfig(java.lang.String key, java.lang.String defaultValue)`
`java.util.Set<java.lang.String>`	`getConfigKeys()`
`protected Rule.RuleMatcher`	`getDefaultIncludeMatch()` Designed to allow subclasses to provide a default match behavior of no configuration was provided by the developer.
`java.util.List<Rule.RuleMatcher>`	`getExcludeMatchers()`
`java.util.List<Path>`	`getExcludePaths()`
`java.util.List<Rule.RuleMatcher>`	`getIncludeMatchers()`
`java.util.List<Path>`	`getIncludePaths()`
`java.lang.String`	`getName()`
`int`	`getOrder()`
`protected Path`	`match(java.lang.String method, Path path)` Find the first ordered Path that satisfies this method/path match.
`boolean`	`matches(java.lang.String method, Path path)` Check if the http method and path match this Rule.
`boolean`	`matches(java.lang.String method, java.lang.String path)` Check if the http method and path match this Rule.
`java.lang.String`	`toString()`
`R`	`withConfig(java.lang.String queryString)`
`R`	`withExcludeOn(Rule.RuleMatcher matcher)` Don't select this Rule when any method and path match.
`R`	`withExcludeOn(java.lang.String methods, Path... paths)`
`R`	`withExcludeOn(java.lang.String methods, java.lang.String... paths)` Don't select this Rule when any method and path match.
`R`	`withIncludeOn(Rule.RuleMatcher matcher)`
`R`	`withIncludeOn(java.lang.String methods, Path... paths)` Select this Rule when any method and path match.
`R`	`withIncludeOn(java.lang.String methods, java.lang.String... paths)` Select this Rule when any method and path match.
`R`	`withName(java.lang.String name)`
`R`	`withOrder(int order)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - log
```
protected final transient org.slf4j.Logger log
```
  - name
```
protected java.lang.String name
```
    The name used for configuration and debug purposes.
  - order
```
protected int order
```
    Rules are always processed in sequence sorted by ascending order.
  - includeMatchers
```
protected java.util.List<Rule.RuleMatcher> includeMatchers
```
    Method/path combinations that would cause this Rule to be included in the relevant processing.
  - excludeMatchers
```
protected java.util.List<Rule.RuleMatcher> excludeMatchers
```
    Method/path combinations that would cause this Rule to be excluded from the relevant processing.
  - configMap
```
protected transient JSNode configMap
```
    JSNode is used because it implements a case insensitive map without modifying the keys
  - configStr
```
protected java.lang.String configStr
```
- Constructor Detail
  - Rule
```
public Rule()
```
- Method Detail
  - checkLazyConfig
```
public void checkLazyConfig()
```
  - doLazyConfig
```
protected void doLazyConfig()
```
  - getDefaultIncludeMatch
```
protected Rule.RuleMatcher getDefaultIncludeMatch()
```
    Designed to allow subclasses to provide a default match behavior of no configuration was provided by the developer.
    
    Returns:
  - matches
```
public boolean matches(java.lang.String method,
                       java.lang.String path)
```
    Check if the http method and path match this Rule.
    
    Parameters:
    
    method - the HTTP method to match
    
    path - the concrete path to match
    
    Returns:
    
    true if the http method and path are included and not excluded
  - matches
```
public boolean matches(java.lang.String method,
                       Path path)
```
    Check if the http method and path match this Rule.
    
    Parameters:
    
    method - the HTTP method to match
    
    path - the concrete path to match
    
    Returns:
    
    true if the http method and path are included and not excluded
  - match
```
protected Path match(java.lang.String method,
                     Path path)
```
    Find the first ordered Path that satisfies this method/path match.
    
    Parameters:
    
    method - the HTTP method to match
    
    path - the concrete path to match
    
    Returns:
    
    the first includeMatchers path to match when method also matches, null if no matches or excluded
  - getIncludePaths
```
public java.util.List<Path> getIncludePaths()
```
  - getExcludePaths
```
public java.util.List<Path> getExcludePaths()
```
  - getIncludeMatchers
```
public java.util.List<Rule.RuleMatcher> getIncludeMatchers()
```
  - withIncludeOn
```
public R withIncludeOn(Rule.RuleMatcher matcher)
```
  - withIncludeOn
```
public R withIncludeOn(java.lang.String methods,
                       java.lang.String... paths)
```
    Select this Rule when any method and path match.
    
    Parameters:
    
    one - or more comma separated http method names, can be null to match on any
    
    paths - each path can be one or more comma separated variableized Paths
    
    Returns:
    
    this
  - withIncludeOn
```
public R withIncludeOn(java.lang.String methods,
                       Path... paths)
```
    Select this Rule when any method and path match.
    
    Parameters:
    
    one - or more comma separated http method names, can be null to match on any
    
    paths - each path can be one or more comma separated variableized Paths
    
    Returns:
    
    this
  - withExcludeOn
```
public R withExcludeOn(java.lang.String methods,
                       java.lang.String... paths)
```
    Don't select this Rule when any method and path match.
    
    Parameters:
    
    one - or more comma separated http method names, can be null to match on any
    
    paths - each path can be one or more comma separated variableized Paths
    
    Returns:
    
    this
  - withExcludeOn
```
public R withExcludeOn(Rule.RuleMatcher matcher)
```
    Don't select this Rule when any method and path match.
    
    Parameters:
    
    one - or more comma separated http method names, can be null to match on any
    
    paths - each path can be one or more comma separated variableized Paths
    
    Returns:
    
    this
  - withExcludeOn
```
public R withExcludeOn(java.lang.String methods,
                       Path... paths)
```
  - getExcludeMatchers
```
public java.util.List<Rule.RuleMatcher> getExcludeMatchers()
```
  - getName
```
public java.lang.String getName()
```
  - withName
```
public R withName(java.lang.String name)
```
  - getOrder
```
public int getOrder()
```
  - withOrder
```
public R withOrder(int order)
```
  - getConfigKeys
```
public java.util.Set<java.lang.String> getConfigKeys()
```
  - getConfig
```
public java.lang.String getConfig(java.lang.String key)
```
  - getConfig
```
public java.lang.String getConfig(java.lang.String key,
                                  java.lang.String defaultValue)
```
  - withConfig
```
public R withConfig(java.lang.String queryString)
```
  - compareTo
```
public int compareTo(Rule a)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<R extends Rule>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Rule<R extends Rule>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

name

order

includeMatchers

excludeMatchers

configMap

configStr

Constructor Detail

Rule

Method Detail

checkLazyConfig

doLazyConfig

getDefaultIncludeMatch

matches

matches

match

getIncludePaths

getExcludePaths

getIncludeMatchers

withIncludeOn

withIncludeOn

withIncludeOn

withExcludeOn

withExcludeOn

withExcludeOn

getExcludeMatchers

getName

withName

getOrder

withOrder

getConfigKeys

getConfig

getConfig

withConfig

compareTo

toString