org.alfresco.repo.audit.model

Class AuditApplication

java.lang.Object

org.alfresco.repo.audit.model.AuditApplication

public class AuditApplication
extends Object

Helper class that wraps the audit application. Once wrapped, client code doesn't need access to any of the generated model-driven classes.

Since:

3.2

Author:

Derek Hulley

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuditApplication.DataExtractorDefinition Utility class carrying information around a DataExtractor.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUDIT_APPLICATION_PREFIX_FOR_PRE_DATA
static Pattern	AUDIT_INVALID_PATH_COMP_CHAR_PATTERN
static Pattern	AUDIT_KEY_PATTERN
static Pattern	AUDIT_PATH_PATTERN
static String	AUDIT_PATH_SEPARATOR

Method Summary

Methods

Modifier and Type	Method and Description
static String	buildPath(String... pathComponents) Compile a path or part of a path into a single string which always starts with the AUDIT_PATH_SEPARATOR.
void	checkPath(String path) Helper method to check that a path is correct for this application instance
static void	checkPathFormat(String path) Helper method to check that a path is correct for this application instance
boolean	equals(Object obj)
Long	getApplicationId() Get the database ID for this application
String	getApplicationKey() Get the key (root path) for the application
String	getApplicationName() Get the application name
List<AuditApplication.DataExtractorDefinition>	getDataExtractors() Get all data extractors applicable to this application.
Map<String,DataGenerator>	getDataGenerators(Set<String> paths) Get all data generators applicable to a given path and scope.
Map<String,DataGenerator>	getDataGenerators(String path) Get all data generators applicable to a given path and scope.
Long	getDisabledPathsId() Get the property representing the set of disabled paths for the application
static String	getRootKey(String path)
int	hashCode()
boolean	isApplicationJustGeneratingPreCallData() Returns true if the application name has a prefix of "PreCallData" that indicates that the only purpose of the Application is to generate data to be passed to a post call audit application.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

AUDIT_APPLICATION_PREFIX_FOR_PRE_DATA

public static final String AUDIT_APPLICATION_PREFIX_FOR_PRE_DATA

See Also:

Constant Field Values

AUDIT_PATH_SEPARATOR

public static final String AUDIT_PATH_SEPARATOR

See Also:

Constant Field Values

AUDIT_KEY_PATTERN

public static final Pattern AUDIT_KEY_PATTERN

AUDIT_PATH_PATTERN

public static final Pattern AUDIT_PATH_PATTERN

AUDIT_INVALID_PATH_COMP_CHAR_PATTERN

public static final Pattern AUDIT_INVALID_PATH_COMP_CHAR_PATTERN

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getApplicationName

public String getApplicationName()

Get the application name

getApplicationKey

public String getApplicationKey()

Get the key (root path) for the application

getApplicationId

public Long getApplicationId()

Get the database ID for this application

getDisabledPathsId

public Long getDisabledPathsId()

Get the property representing the set of disabled paths for the application

Returns:

Returns an ID Set of disabled paths

checkPath

public void checkPath(String path)

Helper method to check that a path is correct for this application instance

Parameters:

path - the path in format /app-key/x/y/z

Throws:

AuditModelException - if the path is invalid

See Also:

#AUDIT_PATH_REGEX

checkPathFormat

public static void checkPathFormat(String path)

Helper method to check that a path is correct for this application instance

Parameters:

path - the path in format /app-key/x/y/z

Throws:

AuditModelException - if the path is invalid

See Also:

#AUDIT_PATH_REGEX

buildPath

public static String buildPath(String... pathComponents)

Compile a path or part of a path into a single string which always starts with the AUDIT_PATH_SEPARATOR. This can be a relative path so need not always start with the application root key.

If the path separator is present at the beginning of a path component, then it is not added, so "/a", "b", "/c" becomes "/a/b/c" allowing path to be appended to other paths.

The final result is checked against a regular expression to ensure it is valid.

Parameters:

pathElements - the elements of the path e.g. "a", "b", "c".

Returns:

Returns the compiled path e.g "/a/b/c".

getRootKey

public static String getRootKey(String path)

Parameters:

path - the audit path for form /abc/def

Returns:

the root key of form abc

See Also:

#AUDIT_ROOT_KEY_REGEX

getDataExtractors

public List<AuditApplication.DataExtractorDefinition> getDataExtractors()

Get all data extractors applicable to this application.

Returns:

Returns all data extractors contained in the application

getDataGenerators

public Map<String,DataGenerator> getDataGenerators(String path)

Get all data generators applicable to a given path and scope.

Parameters:

path - the audit path

Returns:

Returns all data generators mapped to their key-path

getDataGenerators

public Map<String,DataGenerator> getDataGenerators(Set<String> paths)

Get all data generators applicable to a given path and scope.

Parameters:

paths - the audit paths

Returns:

Returns all data generators mapped to their key-path

isApplicationJustGeneratingPreCallData

public boolean isApplicationJustGeneratingPreCallData()

Returns true if the application name has a prefix of "PreCallData" that indicates that the only purpose of the Application is to generate data to be passed to a post call audit application. In this situation the application's audit data is not audited. This allows the post audit application to have access to 'before' values including those created by extractors and generators. Some of which will not be available (for example the node has been deleted) or will have changed as a result of the call.