org.alfresco.repo.audit.model
Interface AuditModelRegistry

All Known Implementing Classes:
AuditModelRegistryImpl

public interface AuditModelRegistry

Interface for component used to store audit model definitions.

Since:
3.3

Field Summary
static java.lang.String AUDIT_PROPERTY_AUDIT_ENABLED
          The name of the global enablement property.
static java.lang.String AUDIT_RESERVED_KEY_SYSTEMTIME
           
static java.lang.String AUDIT_RESERVED_KEY_USERNAME
           
static java.lang.String AUDIT_SCHEMA_LOCATION
           
 
Method Summary
 AuditApplication getAuditApplicationByKey(java.lang.String key)
          Get the application model for the given root key (as defined on the application)
 AuditApplication getAuditApplicationByName(java.lang.String applicationName)
          Get the application model for the given application name
 java.util.Map getAuditApplications()
          Get a map of all audit applications key by name
 org.alfresco.util.PathMapper getAuditPathMapper()
          Get the path mapper.
 boolean isAuditEnabled()
          Determines whether audit is globally enabled or disabled.
 void loadAuditModels()
          Method to load audit models into memory.
 

Field Detail

AUDIT_PROPERTY_AUDIT_ENABLED

static final java.lang.String AUDIT_PROPERTY_AUDIT_ENABLED
The name of the global enablement property.

See Also:
Constant Field Values

AUDIT_SCHEMA_LOCATION

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

AUDIT_RESERVED_KEY_USERNAME

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

AUDIT_RESERVED_KEY_SYSTEMTIME

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

loadAuditModels

void loadAuditModels()
Method to load audit models into memory. This method is also responsible for persisting the audit models for later retrieval.

Note, the models are loaded in a new transaction, so this method can be called by any code at any time.


isAuditEnabled

boolean isAuditEnabled()
Determines whether audit is globally enabled or disabled.

Returns:
true if audit is enabled

getAuditApplications

java.util.Map getAuditApplications()
Get a map of all audit applications key by name

Returns:
the audit applications
Since:
3.4

getAuditApplicationByKey

AuditApplication getAuditApplicationByKey(java.lang.String key)
Get the application model for the given root key (as defined on the application)

Parameters:
key - the key defined on the application
Returns:
the java model (null if not found)

getAuditApplicationByName

AuditApplication getAuditApplicationByName(java.lang.String applicationName)
Get the application model for the given application name

Parameters:
applicationName - the name of the audited application
Returns:
the java model (null if not found)

getAuditPathMapper

org.alfresco.util.PathMapper getAuditPathMapper()
Get the path mapper.

Returns:
the path mapper


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