mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-06-30 18:15:39 +00:00
d2be2015e4
- Fixed up some file formatting - Added List-based audit results for RM git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@16146 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
145 lines
6.5 KiB
Java
145 lines
6.5 KiB
Java
/*
|
|
* Copyright (C) 2005-2007 Alfresco Software Limited.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
|
|
* This program 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 General Public License for more details.
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
* As a special exception to the terms and conditions of version 2.0 of
|
|
* the GPL, you may redistribute this Program in connection with Free/Libre
|
|
* and Open Source Software ("FLOSS") applications as described in Alfresco's
|
|
* FLOSS exception. You should have recieved a copy of the text describing
|
|
* the FLOSS exception, and it is also available here:
|
|
* http://www.alfresco.com/legal/licensing"
|
|
*/
|
|
package org.alfresco.repo.audit;
|
|
|
|
import java.io.Serializable;
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
|
|
import org.alfresco.repo.audit.model.AuditApplication;
|
|
import org.alfresco.repo.audit.model._3.AuditPath;
|
|
import org.alfresco.service.cmr.audit.AuditInfo;
|
|
import org.alfresco.service.cmr.audit.AuditService.AuditQueryCallback;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.aopalliance.intercept.MethodInvocation;
|
|
|
|
/**
|
|
* The audit component. Used by the AuditService and AuditMethodInterceptor to insert audit entries.
|
|
* <p/>
|
|
* The V3.2 audit functionality is contained within the same component. When the newer audit
|
|
* implementation has been tested and approved, then older ones will be deprecated as necessary.
|
|
*
|
|
* @author Andy Hind
|
|
* @author Derek Hulley
|
|
*/
|
|
public interface AuditComponent
|
|
{
|
|
/**
|
|
* Audit entry point for method interceptors.
|
|
*
|
|
* @return - the return onbject from the normal invocation of the audited method.
|
|
*
|
|
* @since 2.1
|
|
*/
|
|
public Object audit(MethodInvocation methodInvocation) throws Throwable;
|
|
|
|
/**
|
|
* @param source -
|
|
* a string that represents the application
|
|
* @param description -
|
|
* the audit entry *
|
|
* @param key -
|
|
* a node ref to use as the key for filtering etc
|
|
* @param args -
|
|
* an arbitrary list of parameters
|
|
*
|
|
* @since 2.1
|
|
*/
|
|
public void audit(String source, String description, NodeRef key, Object... args);
|
|
|
|
/**
|
|
* Get the audit trail for a node.
|
|
*
|
|
* @param nodeRef -
|
|
* the node ref for which we want the audit trail
|
|
* @return - a list of AuditInfo objects that represent the audit trail for the given node reference.
|
|
*
|
|
* @since 2.1
|
|
*/
|
|
public List<AuditInfo> getAuditTrail(NodeRef nodeRef);
|
|
|
|
/*
|
|
* V3.2 from here on. Put all fixes to the older audit code before this point, please.
|
|
*/
|
|
|
|
/**
|
|
* Record a set of values against the given session. The map is a path - starting with '/'
|
|
* ({@link AuditApplication#AUDIT_PATH_SEPARATOR}), relative to the root path given when
|
|
* {@link #startAuditSession(String, String) starting the session}. All resulting path values
|
|
* (session root path + map entry paths) must have data recorder entries and be enabled for data to be recorded.
|
|
* <p/>
|
|
* The return values reflect what was actually persisted and is controlled by the data extractors
|
|
* defined in the audit configuration.
|
|
* <p/>
|
|
* This is a read-write method. Client code must wrap calls in the appropriate transactional wrappers.
|
|
*
|
|
* @param applicationName the name of the application to log against
|
|
* @param rootPath a base path of {@link AuditPath} key entries concatenated with the path separator
|
|
* '/' ({@link AuditApplication#AUDIT_PATH_SEPARATOR})
|
|
* @param values the values to audit mapped by {@link AuditPath} key relative to root path
|
|
* (may be <tt>null</tt>)
|
|
* @return Returns the values that were actually persisted, keyed by their full path.
|
|
* @throws IllegalStateException if there is not a writable transaction present
|
|
*
|
|
* @see #startAuditSession()
|
|
*
|
|
* @since 3.2
|
|
*/
|
|
Map<String, Serializable> audit(String applicationName, String rootPath, Map<String, Serializable> values);
|
|
|
|
/**
|
|
* Get the audit entries that match the given criteria.
|
|
*
|
|
* @param callback the callback that will handle results
|
|
* @param applicationName if not <tt>null</tt>, find entries logged against this application
|
|
* @param user if not <tt>null</tt>, find entries logged against this user
|
|
* @param from the start search time (<tt>null</tt> to start at the beginning)
|
|
* @param to the end search time (<tt>null</tt> for no limit)
|
|
* @param maxResults the maximum number of results to retrieve (zero or negative to ignore)
|
|
*/
|
|
void auditQuery(
|
|
AuditQueryCallback callback,
|
|
String applicationName, String user, Long from, Long to,
|
|
int maxResults);
|
|
|
|
/**
|
|
* Get the audit entries that match the given criteria.
|
|
*
|
|
* @param callback the callback that will handle results
|
|
* @param applicationName if not <tt>null</tt>, find entries logged against this application
|
|
* @param user if not <tt>null</tt>, find entries logged against this user
|
|
* @param from the start search time (<tt>null</tt> to start at the beginning)
|
|
* @param to the end search time (<tt>null</tt> for no limit)
|
|
* @param searchKey the audit key path that must exist (<tt>null</tt> to ignore)
|
|
* @param searchString an audit value string that must exist (<tt>null</tt> to ignore)
|
|
* @param maxResults the maximum number of results to retrieve (zero or negative to ignore)
|
|
*/
|
|
void auditQuery(
|
|
AuditQueryCallback callback,
|
|
String applicationName, String user, Long from, Long to,
|
|
String searchKey, String searchString,
|
|
int maxResults);
|
|
}
|