Package 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
- Author:
- Derek Hulley
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionGet the application model for the given root key (as defined on the application)getAuditApplicationByName(String applicationName) Get the application model for the given application nameGet a map of all audit applications key by nameGet the path mapper.booleanDetermines whether audit is globally enabled or disabled.booleanDetermines whether audit values should be stored in audit storage.booleanDetermines whether audit values should be stored in database.voidMethod to load audit models into memory.
-
Field Details
-
AUDIT_PROPERTY_AUDIT_ENABLED
The name of the global enablement property.- See Also:
-
AUDIT_SCHEMA_LOCATION
- See Also:
-
AUDIT_RESERVED_KEY_USERNAME
- See Also:
-
AUDIT_RESERVED_KEY_SYSTEMTIME
- See Also:
-
-
Method Details
-
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:
trueif audit is enabled
-
isAuditingToDatabaseEnabled
boolean isAuditingToDatabaseEnabled()Determines whether audit values should be stored in database.Trueby default if not changed by property.- Returns:
trueif audit is enabled.
-
isAuditingToAuditStorageEnabled
boolean isAuditingToAuditStorageEnabled()Determines whether audit values should be stored in audit storage.- Returns:
trueif auditing to Audit Storage is enabled.
-
getAuditApplications
Map<String,AuditApplication> getAuditApplications()Get a map of all audit applications key by name- Returns:
- the audit applications
- Since:
- 3.4
-
getAuditApplicationByKey
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
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
PathMapper getAuditPathMapper()Get the path mapper.- Returns:
- the path mapper
-