net.adamcin.oakpal.core.checks

Class Paths

java.lang.Object

net.adamcin.oakpal.core.checks.Paths

All Implemented Interfaces:

net.adamcin.oakpal.api.ProgressCheckFactory

public final class Paths
extends Object
implements net.adamcin.oakpal.api.ProgressCheckFactory

Deny path imports/deletes by regular expression.

Example config:

     "config": {
         "rules": [{
             "type": "deny",
             "pattern": "/etc/tags(/.*)?"
         },{
             "type": "allow",
             "pattern": "/etc/tags/acme(/.*)?"
         }],
         "denyAllDeletes": true,
         "severity": "minor"
     }
 

config options:

rules

A list of Rule elements. Rules are evaluated top-to-bottom. The type of the last rule to match is the effective action taken for the element. Any affected path matching a DENY rule will be reported as a violation.

denyAllDeletes

By default any affected path matching a DENY rule will be reported as a violation regardless of the nature of the change. Set this true to also report a violation if ANY delete is detected, because that is generally indicative of an existing path (forced root or preInstallPackage) being inadvertently captured by this package's workspace filter.

severity

By default, the severity of violations created by this check is MAJOR, but can be set to MINOR or SEVERE.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Paths.JsonKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_DENY_ALL_DELETES Deprecated.
static String	CONFIG_RULES Deprecated.
static String	CONFIG_SEVERITY Deprecated.
static net.adamcin.oakpal.api.Severity	DEFAULT_SEVERITY

Constructor Summary

Constructors

Constructor and Description
Paths()

Method Summary

Modifier and Type	Method and Description
static @NotNull Paths.JsonKeys	keys()
net.adamcin.oakpal.api.ProgressCheck	newInstance(javax.json.JsonObject config)

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_RULES

@Deprecated
public static final String CONFIG_RULES

Deprecated.

CONFIG_DENY_ALL_DELETES

@Deprecated
public static final String CONFIG_DENY_ALL_DELETES

Deprecated.

CONFIG_SEVERITY

@Deprecated
public static final String CONFIG_SEVERITY

Deprecated.

DEFAULT_SEVERITY

public static final net.adamcin.oakpal.api.Severity DEFAULT_SEVERITY

Constructor Detail

Paths

public Paths()

Method Detail

keys

@NotNull
public static @NotNull Paths.JsonKeys keys()

newInstance

public net.adamcin.oakpal.api.ProgressCheck newInstance(javax.json.JsonObject config)

Specified by:

newInstance in interface net.adamcin.oakpal.api.ProgressCheckFactory