$ A C D E G H I J M N P Q R S Z

$

$status - Variable in class ch.cern.ZKCheckElement

A

ACLAugment - Class in ch.cern

Class that augments ZooKeeper ACL with field checking and comparison functionality.

ACLAugment(ACL) - Constructor for class ch.cern.ACLAugment

Construct ACLAugment from ACL object.

ACLAugment(String) - Constructor for class ch.cern.ACLAugment

Construct ACLAugment from "scheme:id:permissions" string.

ACLAugmentSatisfyEquator - Class in ch.cern

Equator used for logical matching of ACLs.

ACLAugmentSatisfyEquator() - Constructor for class ch.cern.ACLAugmentSatisfyEquator

C

canEqual(Object) - Method in class ch.cern.ACLAugment

canEqual(Object) - Method in class ch.cern.ZKCheckElement

ch.cern - package ch.cern

check(String, List<ZKCheckElement>, Hashtable<Integer, List<String>>) - Method in class ch.cern.ZKCheck

Execute check operations starting recursively from the rootPath.

colorCodeExplanation() - Method in class ch.cern.ZKTree

Return color code explanation for command line output.

configFile - Variable in class ch.cern.ZKPolicyCli

createGlobPatternList(List<String>) - Static method in class ch.cern.ZKPattern

Create a list of Pattern objects from a list of glob expression strings.

createRegexPatternList(List<String>) - Static method in class ch.cern.ZKPattern

Create a list of Pattern objects from a list of regular expression strings.

D

duplicateACL - Variable in class ch.cern.ZKDefaultQuery

E

enforce(ZKEnforcePolicyElement) - Method in class ch.cern.ZKEnforce

Enforce policy ACLs provided to every matching node of the requested query.

enforceDry(ZKEnforcePolicyElement) - Method in class ch.cern.ZKEnforce

Execute the query in dry-run mode returning the znodes to be altered from normal execution.

enforceRollback(ZKClient) - Method in class ch.cern.ZKRollbackSet

Rollback to pre enforce state.

equals(Object) - Method in class ch.cern.ACLAugment

equals(Object) - Method in class ch.cern.ZKCheckElement

equate(ACLAugment, ACLAugment) - Method in class ch.cern.ACLAugmentSatisfyEquator

exactACL - Variable in class ch.cern.ZKDefaultQuery

executionStrategy(CommandLine.ParseResult) - Method in class ch.cern.ZKPolicyCli

export(String, ZKPolicyDefs.ExportFormats, boolean, File) - Method in class ch.cern.ZKExport

Export a znode subtree to certain output format.

exportToYAML() - Method in class ch.cern.ZKRollbackSet

Export RollbackSet to YAML file.

G

generateACLAugmentList(List<ACL>) - Static method in class ch.cern.ACLAugment

Return List of ACLAugment elements from a list from ACL.

generateACLStringList(List<ACL>) - Static method in class ch.cern.ACLAugment

Create String from ACL list.

generateChecksSection() - Method in class ch.cern.ZKAudit

Generate checks result section.

generateDescription() - Method in class ch.cern.ZKCheckElement

Generate a human readable description of the check.

generateDescription() - Method in class ch.cern.ZKQueryElement

Generate a human readable description of the query.

generateQueriesSection() - Method in class ch.cern.ZKAudit

Generate queries result section.

getACL() - Method in class ch.cern.ACLAugment

Get the ACL object.

getAcl() - Method in class ch.cern.ZKRollbackElement

getAcl() - Method in class ch.cern.ZKTreeNode

getACLOverview() - Method in class ch.cern.ZKAudit

Generate a complete list of accessible znodes and their ACL.

getAcls() - Method in class ch.cern.ZKCheckElement

getAcls() - Method in class ch.cern.ZKEnforcePolicyElement

getArgs() - Method in class ch.cern.ZKQueryElement

getChecks() - Method in class ch.cern.ZKAuditSet

getChecksOutputBuffer(List<ZKCheckElement>) - Static method in class ch.cern.ZKPolicyUtils

Construct output buffer for a list of check elements.

getChildren() - Method in class ch.cern.ZKTreeNode

getData() - Method in class ch.cern.ZKTreeNode

getDescription() - Method in interface ch.cern.ZKQuery

getElements() - Method in class ch.cern.ZKRollbackSet

getFourLetterWordOverview() - Method in class ch.cern.ZKAudit

Probe the ZooKeeper Server for whitelisted Four Letter Words.

getHost() - Method in class ch.cern.ZKClient

getId() - Method in class ch.cern.ACLAugment

Get id field of ACL.

getJaas() - Method in class ch.cern.ZKConfig

getMatchColor() - Method in class ch.cern.ZKConfig

getMismatchColor() - Method in class ch.cern.ZKConfig

getName() - Method in class ch.cern.ZKQueryElement

getNegate() - Method in class ch.cern.ZKCheckElement

getPath() - Method in class ch.cern.ZKRollbackElement

getPath() - Method in class ch.cern.ZKTreeNode

getPathPattern() - Method in class ch.cern.ZKCheckElement

getPerms() - Method in class ch.cern.ACLAugment

Get perm field of ACL.

getPolicies() - Method in class ch.cern.ZKEnforcePolicySet

getPort() - Method in class ch.cern.ZKClient

getQueries() - Method in class ch.cern.ZKAuditSet

getQuery() - Method in class ch.cern.ZKEnforcePolicyElement

getQuery() - Method in class ch.cern.ZKQueryElement

getQueryOutputBuffer(List<ZKQueryElement>) - Static method in class ch.cern.ZKPolicyUtils

Construct output buffer for a list of query elements.

getRootPath() - Method in class ch.cern.ZKCheckElement

getRootPath() - Method in class ch.cern.ZKQueryElement

getRootPathCheckKeys() - Method in class ch.cern.ZKAudit

Get a set of unique root paths defined by the user for each check.

getRootPathKeys() - Method in class ch.cern.ZKAudit

Get a set of unique root paths defined by the user for each query.

getScheme() - Method in class ch.cern.ACLAugment

Get scheme field of ACL.

getSections() - Method in class ch.cern.ZKAuditSet

getStat() - Method in class ch.cern.ZKTreeNode

getStringFromACL() - Method in class ch.cern.ACLAugment

Get ACL element in scheme:id:permissions String format.

getTimeout() - Method in class ch.cern.ZKConfig

getTitle() - Method in class ch.cern.ZKCheckElement

getTitle() - Method in class ch.cern.ZKEnforcePolicyElement

getValueOf(String) - Method in class ch.cern.ZKDefaultQuery

Get value of class field using its name.

getZkAuditSet() - Method in class ch.cern.ZKAudit

Return audit configuration object.

getZKPConfig() - Method in class ch.cern.ZKClient

Get config instance for ZooKeeper Policy Auditing Tool.

getZkServers() - Method in class ch.cern.ZKConfig

globMatchACL - Variable in class ch.cern.ZKDefaultQuery

globMatchPath - Variable in class ch.cern.ZKDefaultQuery

groupChecksByRootPath() - Method in class ch.cern.ZKAudit

Group checks based on their root path for optimal performance.

groupQueriesByRootPath() - Method in class ch.cern.ZKAudit

Group queries based on their root path for optimal performance.

H

hasAdmin() - Method in class ch.cern.ACLAugment

Check if this ACL provides ADMIN permission.

hasCreate() - Method in class ch.cern.ACLAugment

Check if this ACL provides CREATE permission.

hasDelete() - Method in class ch.cern.ACLAugment

Check if this ACL provides DELETE permission.

hash(ACLAugment) - Method in class ch.cern.ACLAugmentSatisfyEquator

hashCode() - Method in class ch.cern.ACLAugment

hashCode() - Method in class ch.cern.ZKCheckElement

hasRead() - Method in class ch.cern.ACLAugment

Check if this ACL provides READ permission.

hasWrite() - Method in class ch.cern.ACLAugment

Check if this ACL provides WRITE permission.

I

isAclOverview() - Method in class ch.cern.ZKAuditSet.ZKPolicyReportSections

isAppend() - Method in class ch.cern.ZKEnforcePolicyElement

isCheckResults() - Method in class ch.cern.ZKAuditSet.ZKPolicyReportSections

isFourLetterWordCommands() - Method in class ch.cern.ZKAuditSet.ZKPolicyReportSections

isGeneralInformation() - Method in class ch.cern.ZKAuditSet.ZKPolicyReportSections

isQueryResults() - Method in class ch.cern.ZKAuditSet.ZKPolicyReportSections

J

jaasFile - Variable in class ch.cern.ZKPolicyCli

M

main(String[]) - Static method in class ch.cern.ZKPolicy

Main function of the ZK Policy tool.

N

noACL - Variable in class ch.cern.ZKDefaultQuery

noSatisfyACL - Variable in class ch.cern.ZKDefaultQuery

P

parentYesChildNo - Variable in class ch.cern.ZKDefaultQuery

process(WatchedEvent) - Method in class ch.cern.ZKPolicyUtils.ConnectedWatcher

Q

query(List<ACL>, List<ACL>, String, ZKClient, List<String>) - Method in interface ch.cern.ZKQuery

queryFind(String, List<ZKQueryElement>, Hashtable<Integer, List<String>>) - Method in class ch.cern.ZKTree

Function to return a list of the selected sub-tree with the full path of query matching nodes.

queryTree(String, List<ZKQueryElement>, Hashtable<Integer, List<String>>) - Method in class ch.cern.ZKTree

Function to return a tree view of the selected sub-tree and execute queries.

R

regexMatchACL - Variable in class ch.cern.ZKDefaultQuery

regexMatchPath - Variable in class ch.cern.ZKDefaultQuery

run() - Method in class ch.cern.ZKAuditCli

run() - Method in class ch.cern.ZKCheckCli

run() - Method in class ch.cern.ZKEnforceCli

run() - Method in class ch.cern.ZKExportCli

run() - Method in class ch.cern.ZKPolicyCli

run() - Method in class ch.cern.ZKQueryCli

run() - Method in class ch.cern.ZKRollbackCli

run() - Method in class ch.cern.ZKTreeCli

S

satisfyACL - Variable in class ch.cern.ZKDefaultQuery

setAcl(List<ACL>) - Method in class ch.cern.ZKRollbackElement

setAcl(List<ACL>) - Method in class ch.cern.ZKTreeNode

setAclOverview(boolean) - Method in class ch.cern.ZKAuditSet.ZKPolicyReportSections

setAcls(List<String>) - Method in class ch.cern.ZKCheckElement

setAcls(List<String>) - Method in class ch.cern.ZKEnforcePolicyElement

setAppend(boolean) - Method in class ch.cern.ZKEnforcePolicyElement

setArgs(List<String>) - Method in class ch.cern.ZKQueryElement

setCheckResults(boolean) - Method in class ch.cern.ZKAuditSet.ZKPolicyReportSections

setChecks(List<ZKCheckElement>) - Method in class ch.cern.ZKAuditSet

setChildren(List<ZKTreeNode>) - Method in class ch.cern.ZKTreeNode

setData(List<Byte>) - Method in class ch.cern.ZKTreeNode

setElements(List<ZKRollbackElement>) - Method in class ch.cern.ZKRollbackSet

setFourLetterWordCommands(boolean) - Method in class ch.cern.ZKAuditSet.ZKPolicyReportSections

setGeneralInformation(boolean) - Method in class ch.cern.ZKAuditSet.ZKPolicyReportSections

setJaas(String) - Method in class ch.cern.ZKConfig

setMatchColor(String) - Method in class ch.cern.ZKConfig

setMismatchColor(String) - Method in class ch.cern.ZKConfig

setName(String) - Method in class ch.cern.ZKQueryElement

setNegate(Boolean) - Method in class ch.cern.ZKCheckElement

setOutputFile(File) - Method in class ch.cern.ZKRollbackSet

setPath(String) - Method in class ch.cern.ZKRollbackElement

setPath(String) - Method in class ch.cern.ZKTreeNode

setPathPattern(String) - Method in class ch.cern.ZKCheckElement

setPolicies(List<ZKEnforcePolicyElement>) - Method in class ch.cern.ZKEnforcePolicySet

setPropertyJaas() - Method in class ch.cern.ZKConfig

Set java.security.auth.login.config environment variable Priority: 1.

setQueries(List<ZKQueryElement>) - Method in class ch.cern.ZKAuditSet

setQuery(ZKQueryElement) - Method in class ch.cern.ZKEnforcePolicyElement

setQuery(ZKQuery) - Method in class ch.cern.ZKQueryElement

setQueryResults(boolean) - Method in class ch.cern.ZKAuditSet.ZKPolicyReportSections

setRootPath(String) - Method in class ch.cern.ZKCheckElement

setRootPath(String) - Method in class ch.cern.ZKQueryElement

setSections(ZKAuditSet.ZKPolicyReportSections) - Method in class ch.cern.ZKAuditSet

setStat(Stat) - Method in class ch.cern.ZKTreeNode

setTimeout(int) - Method in class ch.cern.ZKConfig

setTitle(String) - Method in class ch.cern.ZKCheckElement

setTitle(String) - Method in class ch.cern.ZKEnforcePolicyElement

setZkServers(String) - Method in class ch.cern.ZKConfig

Z

ZKAudit - Class in ch.cern

ZKAudit(ZKClient, File) - Constructor for class ch.cern.ZKAudit

Construct ZKAudit object for audit reports generation.

ZKAuditCli - Class in ch.cern

ZKAuditCli() - Constructor for class ch.cern.ZKAuditCli

ZKAuditSet - Class in ch.cern

Class that holds the report scenario description with different steps (queries and checks) to be executed on the ZK tree argument.

ZKAuditSet(File) - Constructor for class ch.cern.ZKAuditSet

ZKAuditSet() - Constructor for class ch.cern.ZKAuditSet

ZKAuditSet(List<ZKQueryElement>, List<ZKCheckElement>, ZKAuditSet.ZKPolicyReportSections) - Constructor for class ch.cern.ZKAuditSet

ZKAuditSet.ZKPolicyReportSections - Class in ch.cern

Structure of report that defines which sections to be included.

ZKCheck - Class in ch.cern

Class that offers check functionality of a znode (or znodes matching a path pattern) against a specific ACL definition.

ZKCheck(ZKClient) - Constructor for class ch.cern.ZKCheck

ZKCheckCli - Class in ch.cern

ZKCheckCli() - Constructor for class ch.cern.ZKCheckCli

ZKCheckElement - Class in ch.cern

Check element as defined in the audit report configuration file.

ZKCheckElement() - Constructor for class ch.cern.ZKCheckElement

ZKCheckElement(String, String, String, Boolean, List<String>) - Constructor for class ch.cern.ZKCheckElement

ZKClient - Class in ch.cern

Class used to establish connectivity with ZooKeeper server.

ZKClient(String, int) - Constructor for class ch.cern.ZKClient

Construct ZKClient by providing just a connect string and timeout.

ZKClient(ZKConfig) - Constructor for class ch.cern.ZKClient

Construct ZKClient based on configuration instance.

ZKConfig - Class in ch.cern

Class that holds configuration parameters as defined in the config.yaml CLI argument.

ZKConfig(File) - Constructor for class ch.cern.ZKConfig

Construct ZKConfig using configuration YAML file.

ZKConfig() - Constructor for class ch.cern.ZKConfig

ZKConfig(String, int, String, String, String) - Constructor for class ch.cern.ZKConfig

ZKDefaultQuery - Class in ch.cern

ZKDefaultQuery Class that provides a basic set of queries for the ZNode tree.

ZKDefaultQuery() - Constructor for class ch.cern.ZKDefaultQuery

ZKEnforce - Class in ch.cern

ZKEnforce(ZKClient) - Constructor for class ch.cern.ZKEnforce

ZKEnforce(ZKClient, File) - Constructor for class ch.cern.ZKEnforce

ZKEnforceCli - Class in ch.cern

ZKEnforceCli() - Constructor for class ch.cern.ZKEnforceCli

ZKEnforcePolicyElement - Class in ch.cern

Class that holds configuration for policies as defined in the enforcing yaml configuration file.

ZKEnforcePolicyElement() - Constructor for class ch.cern.ZKEnforcePolicyElement

ZKEnforcePolicyElement(String, ZKQueryElement, boolean, List<String>) - Constructor for class ch.cern.ZKEnforcePolicyElement

ZKEnforcePolicySet - Class in ch.cern

Class that holds policies for enforcing derived from the respective yaml configuration file.

ZKEnforcePolicySet(File) - Constructor for class ch.cern.ZKEnforcePolicySet

ZKEnforcePolicySet() - Constructor for class ch.cern.ZKEnforcePolicySet

ZKEnforcePolicySet(List<ZKEnforcePolicyElement>) - Constructor for class ch.cern.ZKEnforcePolicySet

ZKExport - Class in ch.cern

Export ZooKeeper tree functionality.

ZKExport(ZKClient) - Constructor for class ch.cern.ZKExport

ZKExportCli - Class in ch.cern

ZKExportCli() - Constructor for class ch.cern.ZKExportCli

ZKPattern - Class in ch.cern

ZKPattern() - Constructor for class ch.cern.ZKPattern

ZKPolicy - Class in ch.cern

ZKPolicy() - Constructor for class ch.cern.ZKPolicy

ZKPolicyCli - Class in ch.cern

Class that handles CLI arguments for the tool.

ZKPolicyCli() - Constructor for class ch.cern.ZKPolicyCli

ZKPolicyDefs - Class in ch.cern

Constants commonly used throughout the ZooKeeper Policy Audit tool codebase.

ZKPolicyDefs() - Constructor for class ch.cern.ZKPolicyDefs

ZKPolicyReportSections() - Constructor for class ch.cern.ZKAuditSet.ZKPolicyReportSections

ZKPolicyReportSections(boolean, boolean, boolean, boolean, boolean) - Constructor for class ch.cern.ZKAuditSet.ZKPolicyReportSections

ZKPolicyUtils - Class in ch.cern

ZKPolicyUtils() - Constructor for class ch.cern.ZKPolicyUtils

ZKPolicyUtils.ConnectedWatcher - Class in ch.cern

Watcher for ZooKeeper client connection that blocks waiting for succesful connection.

ZKQuery - Interface in ch.cern

Interface for query functions.

ZKQueryCli - Class in ch.cern

ZKQueryCli() - Constructor for class ch.cern.ZKQueryCli

ZKQueryElement - Class in ch.cern

Class for query elements to be executed, constructed based on configuration yaml files argument.

ZKQueryElement() - Constructor for class ch.cern.ZKQueryElement

ZKQueryElement(String, String, List<String>, ZKQuery) - Constructor for class ch.cern.ZKQueryElement

ZKRollbackCli - Class in ch.cern

ZKRollbackCli() - Constructor for class ch.cern.ZKRollbackCli

ZKRollbackElement - Class in ch.cern

Class that holds configuration for policies as defined in the enforcing yaml configuration file.

ZKRollbackElement() - Constructor for class ch.cern.ZKRollbackElement

ZKRollbackElement(String, List<ACL>) - Constructor for class ch.cern.ZKRollbackElement

ZKRollbackSet - Class in ch.cern

Class that stores information for rollback to previous state after enforcing.

ZKRollbackSet(File) - Constructor for class ch.cern.ZKRollbackSet

ZKRollbackSet() - Constructor for class ch.cern.ZKRollbackSet

ZKRollbackSet(List<ZKRollbackElement>) - Constructor for class ch.cern.ZKRollbackSet

ZKTree - Class in ch.cern

Class that handles operations on the ZNode tree structure.

ZKTree(ZKClient) - Constructor for class ch.cern.ZKTree

Create a ZKTree instance for traversal and query execution.

ZKTreeCli - Class in ch.cern

ZKTreeCli() - Constructor for class ch.cern.ZKTreeCli

ZKTreeNode - Class in ch.cern

Object that represents a ZooKeeper znode.

ZKTreeNode() - Constructor for class ch.cern.ZKTreeNode

ZKTreeNode(String, List<Byte>, List<ACL>, List<ZKTreeNode>, Stat) - Constructor for class ch.cern.ZKTreeNode

$ A C D E G H I J M N P Q R S Z