ch.cern

Class ZKAudit

java.lang.Object

ch.cern.ZKAudit

public class ZKAudit
extends Object

Constructor Summary

Constructors

Constructor and Description
ZKAudit(ZKClient zk, File auditConfigFile) Construct ZKAudit object for audit reports generation.

Method Summary

Modifier and Type	Method and Description
String	generateChecksSection() Generate checks result section.
String	generateQueriesSection() Generate queries result section.
String	getACLOverview() Generate a complete list of accessible znodes and their ACL.
String	getFourLetterWordOverview() Probe the ZooKeeper Server for whitelisted Four Letter Words.
Set<String>	getRootPathCheckKeys() Get a set of unique root paths defined by the user for each check.
Set<String>	getRootPathKeys() Get a set of unique root paths defined by the user for each query.
ZKAuditSet	getZkAuditSet() Return audit configuration object.
void	groupChecksByRootPath() Group checks based on their root path for optimal performance.
void	groupQueriesByRootPath() Group queries based on their root path for optimal performance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZKAudit

public ZKAudit(ZKClient zk,
               File auditConfigFile)
        throws com.fasterxml.jackson.core.JsonParseException,
               com.fasterxml.jackson.databind.JsonMappingException,
               IOException

Construct ZKAudit object for audit reports generation.

Parameters:

zk - ZooKeeper Client connected to a ZooKeeper Server

auditConfigFile - File that defines the queries to be executed for this particular audit report

Throws:

com.fasterxml.jackson.core.JsonParseException

com.fasterxml.jackson.databind.JsonMappingException

IOException

Method Detail

getRootPathKeys

public Set<String> getRootPathKeys()

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

Returns:

Query root path set

getRootPathCheckKeys

public Set<String> getRootPathCheckKeys()

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

Returns:

Check root path set

getZkAuditSet

public ZKAuditSet getZkAuditSet()

Return audit configuration object.

Returns:

getACLOverview

public String getACLOverview()
                      throws org.apache.zookeeper.KeeperException,
                             InterruptedException

Generate a complete list of accessible znodes and their ACL.

Returns:

LIst of znodes and their respective ACL

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

getFourLetterWordOverview

public String getFourLetterWordOverview()
                                 throws org.apache.zookeeper.KeeperException,
                                        InterruptedException,
                                        IOException,
                                        org.apache.zookeeper.common.X509Exception.SSLContextException

Probe the ZooKeeper Server for whitelisted Four Letter Words.

Returns:

List of enabled, disabled and unknown four letter words

Throws:

org.apache.zookeeper.KeeperException

InterruptedException

IOException

org.apache.zookeeper.common.X509Exception.SSLContextException

generateQueriesSection

public String generateQueriesSection()
                              throws com.fasterxml.jackson.core.JsonParseException,
                                     com.fasterxml.jackson.databind.JsonMappingException,
                                     IOException,
                                     NoSuchFieldException,
                                     SecurityException,
                                     IllegalArgumentException,
                                     IllegalAccessException,
                                     NoSuchMethodException,
                                     InvocationTargetException,
                                     org.apache.zookeeper.KeeperException,
                                     InterruptedException

Generate queries result section.

Returns:

Audir report section with queries results

Throws:

com.fasterxml.jackson.core.JsonParseException

com.fasterxml.jackson.databind.JsonMappingException

IOException

NoSuchFieldException

SecurityException

IllegalArgumentException

IllegalAccessException

NoSuchMethodException

InvocationTargetException

org.apache.zookeeper.KeeperException

InterruptedException

generateChecksSection

public String generateChecksSection()
                             throws com.fasterxml.jackson.core.JsonParseException,
                                    com.fasterxml.jackson.databind.JsonMappingException,
                                    IOException,
                                    NoSuchFieldException,
                                    SecurityException,
                                    IllegalArgumentException,
                                    IllegalAccessException,
                                    NoSuchMethodException,
                                    InvocationTargetException,
                                    org.apache.zookeeper.KeeperException,
                                    InterruptedException

Generate checks result section.

Returns:

Audit report section with check results

Throws:

com.fasterxml.jackson.core.JsonParseException

com.fasterxml.jackson.databind.JsonMappingException

IOException

NoSuchFieldException

SecurityException

IllegalArgumentException

IllegalAccessException

NoSuchMethodException

InvocationTargetException

org.apache.zookeeper.KeeperException

InterruptedException

groupQueriesByRootPath

public void groupQueriesByRootPath()
                            throws NoSuchFieldException,
                                   SecurityException,
                                   IllegalArgumentException,
                                   IllegalAccessException

Group queries based on their root path for optimal performance.

Throws:

NoSuchFieldException

SecurityException

IllegalArgumentException

IllegalAccessException

groupChecksByRootPath

public void groupChecksByRootPath()
                           throws NoSuchFieldException,
                                  SecurityException,
                                  IllegalArgumentException,
                                  IllegalAccessException

Group checks based on their root path for optimal performance.

Throws:

NoSuchFieldException

SecurityException

IllegalArgumentException

IllegalAccessException