net.adamcin.oakpal.core.checks

Class JcrProperties

java.lang.Object

net.adamcin.oakpal.core.checks.JcrProperties

All Implemented Interfaces:

net.adamcin.oakpal.api.ProgressCheckFactory

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

A complex check for enforcing characteristics of JCR Properties of imported nodes and their descendants within the scope of the workspace filter.

config options:

scopePaths (Rule[])

A list of rules, with each pattern matched against an import path, and the type (RuleType) of the last matching rule determines whether the matched path is in scope for checking the properties on the node and its descendants.

denyNodeTypes

A list of nodeType strings, which specify primary or mixin types that should be disallowed. If matched, the path is marked as a violation, without descending further to children and without evaluating property checks.

scopeNodeTypes

A list of nodeType strings, which specify primary or mixin types that the list of property constraints should apply to.

properties

A list of JcrPropertyConstraints definitions.

     "config": {
         "scopePaths": [
             {
                 "pattern": "/apps/.*",
                 "type": "allow"
             },
             {
                 "pattern": "/libs/.*",
                 "type": "allow"
             }
         ],
         "denyNodeTypes": ["sling:OsgiConfig"],
         "scopeNodeTypes": ["{http://www.day.com/jcr/cq/1.0}Component"],
         "properties": [
             {
                 "name": "{http://sling.apache.org/jcr/sling/1.0}resourceType",
                 "denyIfPresent": true
             },
             {
                 "name": "componentGroup",
                 "denyIfAbsent": true,
                 "denyIfMultivalued": true
             },
             {
                 "name": "sling:resourceSuperType",
                 "valueRules": [{
                     "pattern": "[^/].*",
                     "type": "deny"
                 }]
             }
         ]
     }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JcrProperties.JsonKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_DENY_NODE_TYPES Deprecated.
static String	CONFIG_PROPERTIES Deprecated.
static String	CONFIG_SCOPE_NODE_TYPES Deprecated.
static String	CONFIG_SCOPE_PATHS Deprecated.

Constructor Summary

Constructors

Constructor and Description
JcrProperties()

Method Summary

Modifier and Type	Method and Description
static @NotNull JcrProperties.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_SCOPE_PATHS

@Deprecated
public static final String CONFIG_SCOPE_PATHS

Deprecated.

CONFIG_DENY_NODE_TYPES

@Deprecated
public static final String CONFIG_DENY_NODE_TYPES

Deprecated.

CONFIG_SCOPE_NODE_TYPES

@Deprecated
public static final String CONFIG_SCOPE_NODE_TYPES

Deprecated.

CONFIG_PROPERTIES

@Deprecated
public static final String CONFIG_PROPERTIES

Deprecated.

Constructor Detail

JcrProperties

public JcrProperties()

Method Detail

keys

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

newInstance

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

Specified by:

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