Files
alfresco-community-repo/source/java/org/alfresco/repo/audit/model/AuditModelRegistry.java
Raluca Munteanu 94228f57a2 Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
125515 slanglois: MNT-16155 Update source headers - add new Copyrights for Java and JSP source files + automatic check in the build


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.1.N/root@125606 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2016-04-20 10:55:49 +00:00

93 lines
3.2 KiB
Java

/*
* #%L
* Alfresco Repository
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
* #L%
*/
package org.alfresco.repo.audit.model;
import java.util.Map;
import org.alfresco.util.PathMapper;
/**
* Interface for component used to store audit model definitions.
*
* @author Derek Hulley
* @since 3.3
*/
public interface AuditModelRegistry
{
/** The name of the global enablement property. */
public static final String AUDIT_PROPERTY_AUDIT_ENABLED = "audit.enabled";
public static final String AUDIT_SCHEMA_LOCATION = "classpath:alfresco/audit/alfresco-audit-3.2.xsd";
public static final String AUDIT_RESERVED_KEY_USERNAME = "username";
public static final String AUDIT_RESERVED_KEY_SYSTEMTIME = "systemTime";
/**
* Method to load audit models into memory. This method is also responsible for persisting
* the audit models for later retrieval.
* <p/>
* Note, the models are loaded in a new transaction, so this method can be called by any code
* at any time.
*/
public void loadAuditModels();
/**
* Determines whether audit is globally enabled or disabled.
*
* @return <code>true</code> if audit is enabled
*/
public boolean isAuditEnabled();
/**
* Get a map of all audit applications key by name
*
* @return the audit applications
*
* @since 3.4
*/
public Map<String, AuditApplication> getAuditApplications();
/**
* Get the application model for the given root key (as defined on the application)
*
* @param key the key defined on the application
* @return the java model (<tt>null</tt> if not found)
*/
public AuditApplication getAuditApplicationByKey(String key);
/**
* Get the application model for the given application name
*
* @param applicationName the name of the audited application
* @return the java model (<tt>null</tt> if not found)
*/
public AuditApplication getAuditApplicationByName(String applicationName);
/**
* Get the path mapper.
* @return the path mapper
*/
public PathMapper getAuditPathMapper();
}