ChecksumGeneratorOptions (ACS AEM Commons Bundle 5.0.0 API)

All Known Implementing Classes:

AbstractChecksumGeneratorOptions, CustomChecksumGeneratorOptions, DefaultChecksumGeneratorOptions, RequestChecksumGeneratorOptions
```
@ProviderType
public interface ChecksumGeneratorOptions
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DATA`
`static String`	`NODE_NAME_EXCLUDES`
`static String`	`NODE_TYPE_EXCLUDES`
`static String`	`NODES_TYPES`
`static String`	`PATHS`
`static String`	`PROPERTY_EXCLUDES`
`static String`	`QUERY`
`static String`	`QUERY_TYPE`
`static String`	`SORTED_PROPERTIES`
`static String`	`SUB_TREE_EXCLUDES`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default Set<String>`	`getExcludedNodeNames()`
`Set<String>`	`getExcludedNodeTypes()`
`Set<String>`	`getExcludedProperties()`
`default Set<String>`	`getExcludedSubTrees()`
`Set<String>`	`getIncludedNodeTypes()` For a node to be checksumable, its primaryType must exists in getIncludedNodesTypes() and not exist in getExcludedNodeTypes().
`Set<String>`	`getSortedProperties()`

- Field Detail
  - DATA
```
static final String DATA
```
    See Also:
    
    Constant Field Values
  - PATHS
```
static final String PATHS
```
    See Also:
    
    Constant Field Values
  - QUERY
```
static final String QUERY
```
    See Also:
    
    Constant Field Values
  - QUERY_TYPE
```
static final String QUERY_TYPE
```
    See Also:
    
    Constant Field Values
  - NODES_TYPES
```
static final String NODES_TYPES
```
    See Also:
    
    Constant Field Values
  - NODE_TYPE_EXCLUDES
```
static final String NODE_TYPE_EXCLUDES
```
    See Also:
    
    Constant Field Values
  - PROPERTY_EXCLUDES
```
static final String PROPERTY_EXCLUDES
```
    See Also:
    
    Constant Field Values
  - SORTED_PROPERTIES
```
static final String SORTED_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - SUB_TREE_EXCLUDES
```
static final String SUB_TREE_EXCLUDES
```
    See Also:
    
    Constant Field Values
  - NODE_NAME_EXCLUDES
```
static final String NODE_NAME_EXCLUDES
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getIncludedNodeTypes
```
Set<String> getIncludedNodeTypes()
```
    For a node to be checksumable, its primaryType must exists in getIncludedNodesTypes() and not exist in getExcludedNodeTypes().
    
    Returns:
    
    the nodes types which are candidates for aggregation.
  - getExcludedNodeTypes
```
Set<String> getExcludedNodeTypes()
```
    Returns:
    
    the node types which are not candidates for aggregation and cannot be aggregated under aggregation candidates.
  - getExcludedProperties
```
Set<String> getExcludedProperties()
```
    Returns:
    
    the property names that should not be included as part of the checksum hash
  - getSortedProperties
```
Set<String> getSortedProperties()
```
    Returns:
    
    the property names whose multi-value order as defined in the JCR should be respected.
  - getExcludedSubTrees
```
default Set<String> getExcludedSubTrees()
```
    Returns:
    
    the named node subTrees to exclude (the matching node and any sub-nodes will NOT be traversed/checksumed)
  - getExcludedNodeNames
```
default Set<String> getExcludedNodeNames()
```
    Returns:
    
    the nodeNames to exclude (sub-nodes WILL be traverse/checksumed)

Interface ChecksumGeneratorOptions

Field Summary

Method Summary

Field Detail

DATA

PATHS

QUERY

QUERY_TYPE

NODES_TYPES

NODE_TYPE_EXCLUDES

PROPERTY_EXCLUDES

SORTED_PROPERTIES

SUB_TREE_EXCLUDES

NODE_NAME_EXCLUDES

Method Detail

getIncludedNodeTypes

getExcludedNodeTypes

getExcludedProperties

getSortedProperties

getExcludedSubTrees

getExcludedNodeNames