org.alfresco.repo.audit.model
Class AuditApplication

java.lang.Object
  extended by org.alfresco.repo.audit.model.AuditApplication

public class AuditApplication
extends java.lang.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

Nested Class Summary
static class AuditApplication.DataExtractorDefinition
          Utility class carrying information around a DataExtractor.
 
Field Summary
static java.lang.String AUDIT_INVALID_PATH_COMP_CHAR_REGEX
           
static java.lang.String AUDIT_KEY_REGEX
           
static java.lang.String AUDIT_PATH_REGEX
           
static java.lang.String AUDIT_PATH_SEPARATOR
           
 
Method Summary
static java.lang.String buildPath(java.lang.String[] pathComponents)
          Compile a path or part of a path into a single string which always starts with the AuditApplication.AUDIT_PATH_SEPARATOR.
 void checkPath(java.lang.String path)
          Helper method to check that a path is correct for this application instance
static void checkPathFormat(java.lang.String path)
          Helper method to check that a path is correct for this application instance
 boolean equals(java.lang.Object obj)
           
 java.lang.Long getApplicationId()
          Get the database ID for this application
 java.lang.String getApplicationKey()
          Get the key (root path) for the application
 java.lang.String getApplicationName()
          Get the application name
 java.util.List getDataExtractors()
          Get all data extractors applicable to this application.
 java.util.Map getDataGenerators(java.util.Set paths)
          Get all data generators applicable to a given path and scope.
 java.util.Map getDataGenerators(java.lang.String path)
          Get all data generators applicable to a given path and scope.
 java.lang.Long getDisabledPathsId()
          Get the property representing the set of disabled paths for the application
static java.lang.String getRootKey(java.lang.String path)
           
 int hashCode()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

AUDIT_PATH_SEPARATOR

public static final java.lang.String AUDIT_PATH_SEPARATOR
See Also:
Constant Field Values

AUDIT_KEY_REGEX

public static final java.lang.String AUDIT_KEY_REGEX
See Also:
Constant Field Values

AUDIT_PATH_REGEX

public static final java.lang.String AUDIT_PATH_REGEX
See Also:
Constant Field Values

AUDIT_INVALID_PATH_COMP_CHAR_REGEX

public static final java.lang.String AUDIT_INVALID_PATH_COMP_CHAR_REGEX
See Also:
Constant Field Values
Method Detail

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getApplicationName

public java.lang.String getApplicationName()
Get the application name


getApplicationKey

public java.lang.String getApplicationKey()
Get the key (root path) for the application


getApplicationId

public java.lang.Long getApplicationId()
Get the database ID for this application


getDisabledPathsId

public java.lang.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(java.lang.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:
AuditApplication.AUDIT_PATH_REGEX

checkPathFormat

public static void checkPathFormat(java.lang.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:
AuditApplication.AUDIT_PATH_REGEX

buildPath

public static java.lang.String buildPath(java.lang.String[] pathComponents)
Compile a path or part of a path into a single string which always starts with the AuditApplication.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 java.lang.String getRootKey(java.lang.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 java.util.List getDataExtractors()
Get all data extractors applicable to this application.

Returns:
Returns all data extractors contained in the application

getDataGenerators

public java.util.Map getDataGenerators(java.lang.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 java.util.Map getDataGenerators(java.util.Set 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


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.