inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-07-31 17:39:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Audit session and bootstrap support

Browse Source 
- Sessions are created using an application name (shared prop) and a persisted model ID
 - Added a bootstrap bean for audit that unmarshalls the models
 - Added hook points for repo-loading models, but won't implement yet


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@15863 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Derek Hulley
2009-08-21 17:50:36 +00:00
parent 99395b7ed2
commit 00dfb8ee66
19 changed files with 877 additions and 280 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
config/alfresco/audit-services-context.xml
View File

@@ -76,14 +76,15 @@
<!-- Audit V3.2 implementation -->
<!-- -->
<bean id="auditConfiguration.registry" class="org.alfresco.repo.audit.model.AuditModelRegistry">
<bean id="auditModel.registry" class="org.alfresco.repo.audit.model.AuditModelRegistry">
<property name="auditDAO" ref="auditDAO"/>
</bean>
<bean id="auditConfiguration.repository" class="org.alfresco.repo.audit.model.AuditModelReader">
<property name="configUrl">
<bean id="auditModel.repository" class="org.alfresco.repo.audit.model.AuditModelReader">
<property name="auditModelUrl">
<value>classpath:alfresco/audit/alfresco-audit-repository.xml</value>
</property>
<property name="auditModelRegistry" ref="auditConfiguration.registry"/>
<property name="auditModelRegistry" ref="auditModel.registry"/>
</bean>
</beans>

6
config/alfresco/bootstrap-context.xml
View File

@@ -494,6 +494,12 @@
</property>
</bean>
<!-- Start Auditing -->
<bean id="audit.bootstrap" class="org.alfresco.repo.audit.AuditBootstrap">
<property name="transactionService" ref="transactionService"/>
<property name="auditModelRegistry" ref="auditModel.registry"/>
</bean>
<!-- Repository helper class -->
<bean id="repositoryHelper" class="org.alfresco.repo.model.Repository">
<property name="transactionHelper" ref="retryingTransactionHelper" />

1
config/alfresco/dao/dao-context.xml
View File

@@ -59,6 +59,7 @@
<property name="sqlMapClientTemplate" ref="auditSqlMapClientTemplate"/>
<property name="contentService" ref="contentService"/>
<property name="contentDataDAO" ref="contentDataDAO"/>
<property name="propertyValueDAO" ref="propertyValueDAO"/>
</bean>
</beans>

14
config/alfresco/dbscripts/create/3.2/org.hibernate.dialect.MySQLInnoDBDialect/AlfrescoPostCreate-3.2-AuditTables.sql
View File

@@ -7,13 +7,23 @@
-- Please contact support@alfresco.com if you need assistance with the upgrade.
--
CREATE TABLE alf_audit_cfg
CREATE TABLE alf_audit_model
(
id BIGINT NOT NULL AUTO_INCREMENT,
content_data_id BIGINT NOT NULL,
content_crc BIGINT NOT NULL,
UNIQUE INDEX idx_alf_audit_cfg_crc (content_crc),
CONSTRAINT fk_alf_audit_cfg_cd FOREIGN KEY (content_data_id) REFERENCES alf_content_data (id),
CONSTRAINT fk_alf_audit_model_cd FOREIGN KEY (content_data_id) REFERENCES alf_content_data (id),
PRIMARY KEY (id)
) ENGINE=InnoDB;
CREATE TABLE alf_audit_session
(
id BIGINT NOT NULL AUTO_INCREMENT,
audit_model_id BIGINT NOT NULL,
app_name_id BIGINT NOT NULL,
CONSTRAINT fk_alf_audit_sess_model FOREIGN KEY (audit_model_id) REFERENCES alf_audit_model (id),
CONSTRAINT fk_alf_audit_sess_app FOREIGN KEY (app_name_id) REFERENCES alf_prop_value (id),
PRIMARY KEY (id)
) ENGINE=InnoDB;

25
config/alfresco/ibatis/org.hibernate.dialect.Dialect/audit-common-SqlMap.xml
View File

@@ -10,17 +10,23 @@
<!-- Type Defs -->
<!-- -->
<typeAlias alias="AuditConfig" type="org.alfresco.repo.domain.audit.AuditConfigEntity"/>
<typeAlias alias="AuditModel" type="org.alfresco.repo.domain.audit.AuditModelEntity"/>
<typeAlias alias="AuditSession" type="org.alfresco.repo.domain.audit.AuditSessionEntity"/>
<!-- -->
<!-- Result Maps -->
<!-- -->
<resultMap id="result.AuditConfig" class="AuditConfig">
<resultMap id="result.AuditModel" class="AuditModel">
<result property="id" column="id" jdbcType="BIGINT" javaType="java.lang.Long"/>
<result property="contentDataId" column="content_data_id" jdbcType="BIGINT" javaType="java.lang.Long"/>
<result property="contentCrc" column="content_crc" jdbcType="BIGINT" javaType="long"/>
</resultMap>
<resultMap id="result.AuditSession" class="AuditSession">
<result property="id" column="id" jdbcType="BIGINT" javaType="java.lang.Long"/>
<result property="auditModelId" column="audit_model_id" jdbcType="BIGINT" javaType="java.lang.Long"/>
<result property="applicationNameId" column="app_name_id" jdbcType="BIGINT" javaType="java.lang.Long"/>
</resultMap>
<!-- -->
<!-- Parameter Maps -->
@@ -34,21 +40,26 @@
<!-- SQL Snippets -->
<!-- -->
<sql id="insert.AuditConfig.AutoIncrement">
insert into alf_audit_cfg (content_data_id, content_crc)
<sql id="insert.AuditModel.AutoIncrement">
insert into alf_audit_model (content_data_id, content_crc)
values (#contentDataId#, #contentCrc#)
</sql>
<sql id="insert.AuditSession.AutoIncrement">
insert into alf_audit_session (audit_model_id, app_name_id)
values (#auditModelId#, #applicationNameId#)
</sql>
<!-- -->
<!-- Statements -->
<!-- -->
<!-- Get the mimetype entity by mimetype -->
<select id="select.AuditConfigByCrc" parameterClass="AuditConfig" resultMap="result.AuditConfig">
<!-- Get the audit model by the CRC value -->
<select id="select.AuditModelByCrc" parameterClass="AuditModel" resultMap="result.AuditModel">
select
*
from
alf_audit_cfg
alf_audit_model
where
content_crc = #contentCrc#
</select>

11
config/alfresco/ibatis/org.hibernate.dialect.MySQLInnoDBDialect/audit-insert-SqlMap.xml
View File

@@ -6,8 +6,15 @@
<sqlMap namespace="alfresco.audit">
<insert id="insert.AuditConfig" parameterClass="AuditConfig" >
<include refid="insert.AuditConfig.AutoIncrement"/>
<insert id="insert.AuditModel" parameterClass="AuditModel" >
<include refid="insert.AuditModel.AutoIncrement"/>
<selectKey resultClass="long" keyProperty="id" type="post">
KEY_COLUMN:GENERATED_KEY
</selectKey>
</insert>
<insert id="insert.AuditSession" parameterClass="AuditSession" >
<include refid="insert.AuditSession.AutoIncrement"/>
<selectKey resultClass="long" keyProperty="id" type="post">
KEY_COLUMN:GENERATED_KEY
</selectKey>

78
source/java/org/alfresco/repo/audit/AuditBootstrap.java Normal file
View File

@@ -0,0 +1,78 @@
/*
* Copyright (C) 2005-2009 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 org.alfresco.repo.audit.model.AuditModelRegistry;
import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
import org.alfresco.service.transaction.TransactionService;
import org.alfresco.util.AbstractLifecycleBean;
import org.springframework.context.ApplicationEvent;
/**
* Starts all the necessary audit functionality once the repository has started.
*
* @author Derek Hulley
* @since 3.2
*/
public class AuditBootstrap extends AbstractLifecycleBean
{
private TransactionService transactionService;
private AuditModelRegistry auditModelRegistry;
public void setTransactionService(TransactionService transactionService)
{
this.transactionService = transactionService;
}
public void setAuditModelRegistry(AuditModelRegistry registry)
{
this.auditModelRegistry = registry;
}
/**
* @see AuditModelRegistry#loadAuditModels()
*/
@Override
protected void onBootstrap(ApplicationEvent event)
{
RetryingTransactionCallback<Void> callback = new RetryingTransactionCallback<Void>()
{
public Void execute() throws Throwable
{
auditModelRegistry.loadAuditModels();
return null;
}
};
transactionService.getRetryingTransactionHelper().doInTransaction(callback);
}
/**
* No-op
*/
@Override
protected void onShutdown(ApplicationEvent event)
{
}
}

65
source/java/org/alfresco/repo/audit/AuditBootstrapTest.java Normal file
View File

@@ -0,0 +1,65 @@
/*
* Copyright (C) 2005-2009 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 junit.framework.TestCase;
import org.alfresco.repo.audit.model.AuditModelRegistry;
import org.alfresco.util.ApplicationContextHelper;
import org.springframework.context.ApplicationContext;
/**
* Tests that auditing is loaded properly on repository startup.
*
* @see AuditBootstrap
*
* @author Derek Hulley
* @since 3.2
*/
public class AuditBootstrapTest extends TestCase
{
private static final String APPLICATION_REPOSITORY = "Alfresco Repository";
private static ApplicationContext ctx = ApplicationContextHelper.getApplicationContext();
private AuditModelRegistry auditModelRegistry;
@Override
public void setUp() throws Exception
{
auditModelRegistry = (AuditModelRegistry) ctx.getBean("auditModel.registry");
}
public void testSetUp()
{
// Just here to fail if the basic startup fails
}
public void testGetModelId()
{
Long repoId = auditModelRegistry.getAuditModelId(APPLICATION_REPOSITORY);
assertNotNull("No audit model ID for " + APPLICATION_REPOSITORY, repoId);
}
}

11
source/java/org/alfresco/repo/audit/AuditComponent.java
View File

@@ -77,14 +77,23 @@ public interface AuditComponent
*/
public List<AuditInfo> getAuditTrail(NodeRef nodeRef);
/*
* V3.2 from here on. Put all fixes to the older audit code before this point, please.
*/
/**
* Start an audit session for the given root path. All later audit operations on the resulting
* session will be relative to this root path.
* <p/>
* The name of the application controls part of the audit model will be used. The root path must
* start with the matching <b>key</b> attribute that was declared for the matching
* <b>Application</b> element in the audit configuration.
*
* @param application the name of the application to log against
* @param rootPath a base path of {@link AuditPath} key entries concatenated with <b>.</b> (period)
* @return Returns the unique session identifier
*/
public Long startAuditSession(String rootPath);
public Long startAuditSession(String application, String rootPath);
/**
* Record a set of values against the given session.

2
source/java/org/alfresco/repo/audit/AuditComponentImpl.java
View File

@@ -761,7 +761,7 @@ public class AuditComponentImpl implements AuditComponent
* V3.2 from here on. Put all fixes to the older audit code before this point, please.
*/
public Long startAuditSession(String rootPath)
public Long startAuditSession(String application, String rootPath)
{
throw new UnsupportedOperationException();
}

95
source/java/org/alfresco/repo/audit/AuditSession.java Normal file
View File

@@ -0,0 +1,95 @@
/*
* Copyright (C) 2005-2009 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 org.alfresco.repo.audit.model._3.Application;
import org.alfresco.util.ParameterCheck;
/**
* Entity bean for <b>alf_audit_session</b> table.
*
* @author Derek Hulley
* @since 3.2
*/
public class AuditSession
{
private final Application application;
private final String rootPath;
public AuditSession(Application application, String rootPath)
{
ParameterCheck.mandatory("application", application);
ParameterCheck.mandatoryString("rootPath", rootPath);
this.application = application;
this.rootPath = rootPath;
}
@Override
public int hashCode()
{
return (application.getName().hashCode() + rootPath.hashCode());
}
@Override
public boolean equals(Object obj)
{
if (this == obj)
{
return true;
}
else if (obj instanceof AuditSession)
{
AuditSession that = (AuditSession) obj;
return this.application.getName().equals(that.application.getName()) &&
this.rootPath.equals(that.rootPath);
}
else
{
return false;
}
}
@Override
public String toString()
{
StringBuilder sb = new StringBuilder(512);
sb.append("AuditSession")
.append("[ application=").append(application.getName())
.append(", rootPath=").append(rootPath)
.append("]");
return sb.toString();
}
public Application getApplication()
{
return application;
}
public String getRootPath()
{
return rootPath;
}
}

45
source/java/org/alfresco/repo/audit/model/AuditModelReader.java
View File

@@ -24,40 +24,32 @@
*/
package org.alfresco.repo.audit.model;
import java.io.File;
import java.net.URL;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBElement;
import javax.xml.bind.UnmarshalException;
import javax.xml.bind.Unmarshaller;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.repo.audit.model._3.Audit;
import org.alfresco.util.PropertyCheck;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.util.ResourceUtils;
/**
* A component used to load Audit configuration XML documents.
* A component used to load Audit model XML documents.
*
* @author Derek Hulley
* @since 3.2
*/
public class AuditModelReader implements InitializingBean
{
private URL configUrl;
private URL auditModelUrl;
private AuditModelRegistry auditModelRegistry;
/**
* Set the XML location using <b>file:</b>, <b>classpath:</b> or any of the
* {@link ResourceUtils Spring-supported} formats.
*
* @param configUrl the location of the XML file
* @param auditModelUrl the location of the XML file
*/
public void setConfigUrl(URL configUrl)
public void setAuditModelUrl(URL auditModelUrl)
{
this.configUrl = configUrl;
this.auditModelUrl = auditModelUrl;
}
/**
@@ -74,32 +66,9 @@ public class AuditModelReader implements InitializingBean
*/
public void afterPropertiesSet() throws Exception
{
PropertyCheck.mandatory(this, "configUrl", configUrl);
PropertyCheck.mandatory(this, "configUrl", auditModelUrl);
PropertyCheck.mandatory(this, "auditModelRegistry", auditModelRegistry);
File file = new File(configUrl.getFile());
if (!file.exists())
{
throw new AlfrescoRuntimeException("The Audit configuration XML was not found: " + configUrl);
}
// Load it
JAXBContext jaxbCtx = JAXBContext.newInstance("org.alfresco.repo.audit.model._3");
Unmarshaller jaxbUnmarshaller = jaxbCtx.createUnmarshaller();
try
{
@SuppressWarnings("unchecked")
JAXBElement<Audit> auditElement = (JAXBElement<Audit>) jaxbUnmarshaller.unmarshal(configUrl);
Audit audit = auditElement.getValue();
// Now register it
auditModelRegistry.registerModel(configUrl, audit);
}
catch (UnmarshalException e)
{
throw new AlfrescoRuntimeException(
"Failed to read Audit configuration XML: \n" +
" URL: " + configUrl + "\n" +
" Error: " + e.getMessage());
}
auditModelRegistry.registerModel(auditModelUrl);
}
}

200
source/java/org/alfresco/repo/audit/model/AuditModelRegistry.java
View File

@@ -24,17 +24,33 @@
*/
package org.alfresco.repo.audit.model;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBElement;
import javax.xml.bind.Unmarshaller;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.repo.audit.extractor.DataExtractor;
import org.alfresco.repo.audit.generator.DataGenerator;
import org.alfresco.repo.audit.model._3.Application;
import org.alfresco.repo.audit.model._3.Audit;
import org.alfresco.repo.audit.model._3.DataExtractors;
import org.alfresco.repo.audit.model._3.DataGenerators;
import org.alfresco.repo.domain.audit.AuditDAO;
import org.alfresco.service.cmr.repository.NodeRef;
/**
* Component used to store audit model definitions. It ensures that duplicate application and converter
@@ -45,26 +61,191 @@ import org.alfresco.repo.audit.model._3.DataGenerators;
*/
public class AuditModelRegistry
{
private final Map<URL, Audit> auditModelsByUrl;
private AuditDAO auditDAO;
private final ReentrantReadWriteLock.ReadLock readLock;
private final ReentrantReadWriteLock.WriteLock writeLock;
private final Set<URL> auditModelUrls;
private final List<Audit> auditModels;
private final Map<String, DataExtractor> dataExtractorsByName;
private final Map<String, DataGenerator> dataGeneratorsByName;
/**
* Used to lookup the audit application java hierarchy
*/
private final Map<String, Application> auditApplicationsByName;
/**
* Used to lookup a reference to the persisted config binary for an application
*/
private final Map<String, Long> auditModelIdsByApplicationsName;
/**
* Default constructor
*/
public AuditModelRegistry()
{
auditModelsByUrl = new HashMap<URL, Audit>(7);
ReentrantReadWriteLock lock = new ReentrantReadWriteLock();
readLock = lock.readLock();
writeLock = lock.writeLock();
auditModelUrls = new HashSet<URL>(7);
auditModels = new ArrayList<Audit>(7);
dataExtractorsByName = new HashMap<String, DataExtractor>(13);
dataGeneratorsByName = new HashMap<String, DataGenerator>(13);
auditApplicationsByName = new HashMap<String, Application>(7);
auditModelIdsByApplicationsName = new HashMap<String, Long>(7);
}
/**
* Register an audit model.
*
* @param configurationUrl the source of the configuration
* @param audit the unmarshalled instance tree
* Set the DAO used to persisted the registered audit models
*/
public void registerModel(URL configurationUrl, Audit audit)
public void setAuditDAO(AuditDAO auditDAO)
{
this.auditDAO = auditDAO;
}
/**
* Register an audit model at a given URL.
*
* @param auditModelUrl the source of the model
*/
public void registerModel(URL auditModelUrl)
{
writeLock.lock();
try
{
if (auditModelUrls.contains(auditModelUrl))
{
throw new AlfrescoRuntimeException(
"An audit model has already been registered at URL " + auditModelUrl);
}
auditModelUrls.add(auditModelUrl);
}
finally
{
writeLock.unlock();
}
}
/**
* Register an audit model at a given node reference.
*
* @param auditModelNodeRef the source of the audit model
*/
public void registerModel(NodeRef auditModelNodeRef)
{
writeLock.lock();
try
{
throw new UnsupportedOperationException();
}
finally
{
writeLock.unlock();
}
}
/**
* Method to load audit models into memory. This method is also responsible for persisting
* the audit models for later retrieval. Models are loaded from the locations given by the
* {@link #registerModel(URL) register} methods.
*/
public void loadAuditModels()
{
writeLock.lock();
try
{
// Load models from the URLs
for (URL auditModelUrl : auditModelUrls)
{
Audit audit = AuditModelRegistry.unmarshallModel(auditModelUrl);
// That worked, so now get an input stream and write the model
Long auditModelId = auditDAO.getOrCreateAuditModel(auditModelUrl).getFirst();
// Now cache it (eagerly)
cacheAuditElements(auditModelId, audit);
}
// NOTE: If we support other types of loading, then that will have to go here, too
}
finally
{
writeLock.unlock();
}
}
/**
* Get the ID of the persisted audit model for the given application name
*
* @param application the name of the audited application
* @return the unique ID of the persisted model (<tt>null</tt> if not found)
*/
public Long getAuditModelId(String application)
{
readLock.lock();
try
{
return auditModelIdsByApplicationsName.get(application);
}
finally
{
readLock.unlock();
}
}
/**
* Unmarshalls the Audit model from the URL.
*
* @throws AlfrescoRuntimeException if an IOException occurs
*/
public static Audit unmarshallModel(URL configUrl)
{
try
{
File file = new File(configUrl.getFile());
if (!file.exists())
{
throw new AlfrescoRuntimeException("The Audit model XML was not found: " + configUrl);
}
// Load it
InputStream is = new BufferedInputStream(new FileInputStream(file));
return unmarshallModel(is, configUrl.toString());
}
catch (IOException e)
{
throw new AlfrescoRuntimeException("The Audit model XML failed to load: " + configUrl, e);
}
}
/**
* Unmarshalls the Audit model from a stream
*/
private static Audit unmarshallModel(InputStream is, String source)
{
try
{
JAXBContext jaxbCtx = JAXBContext.newInstance("org.alfresco.repo.audit.model._3");
Unmarshaller jaxbUnmarshaller = jaxbCtx.createUnmarshaller();
@SuppressWarnings("unchecked")
JAXBElement<Audit> auditElement = (JAXBElement<Audit>) jaxbUnmarshaller.unmarshal(is);
Audit audit = auditElement.getValue();
// Done
return audit;
}
catch (Throwable e)
{
throw new AlfrescoRuntimeException(
"Failed to read Audit model XML: \n" +
" Source: " + source + "\n" +
" Error: " + e.getMessage(),
e);
}
finally
{
try { is.close(); } catch (IOException e) {}
}
}
private void cacheAuditElements(Long auditModelId, Audit audit)
{
// Get the data extractors and check for duplicates
DataExtractors extractorsElement = audit.getDataExtractors();
@@ -134,8 +315,9 @@ public class AuditModelRegistry
throw new AuditModelException("Audit application '" + name + "' has already been defined.");
}
auditApplicationsByName.put(name, application);
auditModelIdsByApplicationsName.put(name, auditModelId);
}
// Store the model
auditModelsByUrl.put(configurationUrl, audit);
// Store the model itself
auditModels.add(audit);
}
}

44
source/java/org/alfresco/repo/domain/audit/AbstractAuditDAOImpl.java
View File

@@ -32,6 +32,7 @@ import java.util.zip.CRC32;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.repo.content.MimetypeMap;
import org.alfresco.repo.domain.contentdata.ContentDataDAO;
import org.alfresco.repo.domain.propval.PropertyValueDAO;
import org.alfresco.service.cmr.repository.ContentData;
import org.alfresco.service.cmr.repository.ContentService;
import org.alfresco.service.cmr.repository.ContentWriter;
@@ -51,6 +52,7 @@ public abstract class AbstractAuditDAOImpl implements AuditDAO
private ContentService contentService;
private ContentDataDAO contentDataDAO;
private PropertyValueDAO propertyValueDAO;
public void setContentService(ContentService contentService)
{
@@ -62,10 +64,20 @@ public abstract class AbstractAuditDAOImpl implements AuditDAO
this.contentDataDAO = contentDataDAO;
}
public void setPropertyValueDAO(PropertyValueDAO propertyValueDAO)
{
this.propertyValueDAO = propertyValueDAO;
}
/*
* alf_audit_model
*/
/**
* {@inheritDoc}
*/
public Pair<Long, ContentData> getOrCreateAuditConfig(URL url)
public Pair<Long, ContentData> getOrCreateAuditModel(URL url)
{
InputStream is = null;
try
@@ -87,7 +99,7 @@ public abstract class AbstractAuditDAOImpl implements AuditDAO
while (true);
long crc = crcCalc.getValue();
// Find an existing entry
AuditConfigEntity existingEntity = getAuditConfigByCrc(crc);
AuditModelEntity existingEntity = getAuditModelByCrc(crc);
if (existingEntity != null)
{
Long existingEntityId = existingEntity.getId();
@@ -100,7 +112,7 @@ public abstract class AbstractAuditDAOImpl implements AuditDAO
if (logger.isDebugEnabled())
{
logger.debug(
"Found existing configuration with same CRC: \n" +
"Found existing model with same CRC: \n" +
" URL: " + url + "\n" +
" CRC: " + crc + "\n" +
" Result: " + result);
@@ -118,13 +130,13 @@ public abstract class AbstractAuditDAOImpl implements AuditDAO
writer.putContent(is);
ContentData newContentData = writer.getContentData();
Long newContentDataId = contentDataDAO.createContentData(newContentData).getFirst();
AuditConfigEntity newEntity = createAuditConfig(newContentDataId, crc);
AuditModelEntity newEntity = createAuditModel(newContentDataId, crc);
Pair<Long, ContentData> result = new Pair<Long, ContentData>(newEntity.getId(), newContentData);
// Done
if (logger.isDebugEnabled())
{
logger.debug(
"Created new audit config: \n" +
"Created new audit model: \n" +
" URL: " + url + "\n" +
" CRC: " + crc + "\n" +
" Result: " + result);
@@ -134,7 +146,7 @@ public abstract class AbstractAuditDAOImpl implements AuditDAO
}
catch (IOException e)
{
throw new AlfrescoRuntimeException("Failed to read Audit configuration: " + url);
throw new AlfrescoRuntimeException("Failed to read Audit model: " + url);
}
finally
{
@@ -145,6 +157,22 @@ public abstract class AbstractAuditDAOImpl implements AuditDAO
}
}
protected abstract AuditConfigEntity getAuditConfigByCrc(long crc);
protected abstract AuditConfigEntity createAuditConfig(Long contentDataId, long crc);
protected abstract AuditModelEntity getAuditModelByCrc(long crc);
protected abstract AuditModelEntity createAuditModel(Long contentDataId, long crc);
/*
* alf_audit_model
*/
public Long createAuditSession(Long modelId, String application)
{
// Persist the string
Long appNameId = propertyValueDAO.getOrCreatePropertyValue(application).getFirst();
// Create the audit session
AuditSessionEntity entity = createAuditSession(appNameId, modelId);
// Done
return entity.getId();
}
protected abstract AuditSessionEntity createAuditSession(Long appNameId, Long modelId);
}

6
source/java/org/alfresco/repo/domain/audit/AuditDAO.java
View File

@@ -38,11 +38,13 @@ import org.alfresco.util.Pair;
public interface AuditDAO
{
/**
* Creates a new audit config entry or finds an existing one
* Creates a new audit model entry or finds an existing one
*
* @param the URL of the configuration
* @return Returns the ID of the config matching the input stream and the
* content storage details
*/
Pair<Long, ContentData> getOrCreateAuditConfig(URL url);
Pair<Long, ContentData> getOrCreateAuditModel(URL url);
Long createAuditSession(Long modelId, String application);
}

41
source/java/org/alfresco/repo/domain/audit/AuditDAOTest.java
View File

@@ -64,7 +64,7 @@ public class AuditDAOTest extends TestCase
auditDAO = (AuditDAO) ctx.getBean("auditDAO");
}
public void testAuditConfig() throws Exception
public void testAuditModel() throws Exception
{
final File file = AbstractContentTransformerTest.loadQuickTestFile("pdf");
assertNotNull(file);
@@ -73,8 +73,8 @@ public class AuditDAOTest extends TestCase
{
public Pair<Long, ContentData> execute() throws Throwable
{
Pair<Long, ContentData> contentDataPair = auditDAO.getOrCreateAuditConfig(url);
return contentDataPair;
Pair<Long, ContentData> auditModelPair = auditDAO.getOrCreateAuditModel(url);
return auditModelPair;
}
};
Pair<Long, ContentData> configPair = txnHelper.doInTransaction(callback);
@@ -84,4 +84,39 @@ public class AuditDAOTest extends TestCase
assertNotNull(configPairCheck);
assertEquals(configPair, configPairCheck);
}
public void testAuditSession() throws Exception
{
final File file = AbstractContentTransformerTest.loadQuickTestFile("pdf");
assertNotNull(file);
final URL url = new URL("file:" + file.getAbsolutePath());
RetryingTransactionCallback<Long> createModelCallback = new RetryingTransactionCallback<Long>()
{
public Long execute() throws Throwable
{
return auditDAO.getOrCreateAuditModel(url).getFirst();
}
};
final Long modelId = txnHelper.doInTransaction(createModelCallback);
final String appName = getName() + "." + System.currentTimeMillis();
final int count = 1000;
RetryingTransactionCallback<Void> createSessionCallback = new RetryingTransactionCallback<Void>()
{
public Void execute() throws Throwable
{
for (int i = 0; i < count; i++)
{
auditDAO.createAuditSession(modelId, appName);
}
return null;
}
};
long before = System.nanoTime();
txnHelper.doInTransaction(createSessionCallback);
long after = System.nanoTime();
System.out.println(
"Time for " + count + " session creations was " +
((double)(after - before)/(10E6)) + "ms");
}
}

12
source/java/org/alfresco/repo/domain/audit/AuditConfigEntity.java → source/java/org/alfresco/repo/domain/audit/AuditModelEntity.java
View File

@@ -27,18 +27,18 @@ package org.alfresco.repo.domain.audit;
import org.alfresco.util.EqualsHelper;
/**
* Entity bean for <b>alf_audit_cfg</b> table.
* Entity bean for <b>alf_audit_model</b> table.
*
* @author Derek Hulley
* @since 3.2
*/
public class AuditConfigEntity
public class AuditModelEntity
{
private Long id;
private Long contentDataId;
private long contentCrc;
public AuditConfigEntity()
public AuditModelEntity()
{
}
@@ -55,9 +55,9 @@ public class AuditConfigEntity
{
return true;
}
else if (obj instanceof AuditConfigEntity)
else if (obj instanceof AuditModelEntity)
{
AuditConfigEntity that = (AuditConfigEntity) obj;
AuditModelEntity that = (AuditModelEntity) obj;
return EqualsHelper.nullSafeEquals(this.id, that.id);
}
else
@@ -70,7 +70,7 @@ public class AuditConfigEntity
public String toString()
{
StringBuilder sb = new StringBuilder(512);
sb.append("AuditConfigEntity")
sb.append("AuditModelEntity")
.append("[ ID=").append(id)
.append(", contentDataId=").append(contentDataId)
.append(", contentCrc=").append(contentCrc)

84
source/java/org/alfresco/repo/domain/audit/AuditSessionEntity.java Normal file
View File

@@ -0,0 +1,84 @@
/*
* Copyright (C) 2005-2009 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.domain.audit;
/**
* Entity bean for <b>alf_audit_session</b> table.
*
* @author Derek Hulley
* @since 3.2
*/
public class AuditSessionEntity
{
private Long id;
private Long applicationNameId;
private Long auditModelId;
public AuditSessionEntity()
{
}
@Override
public String toString()
{
StringBuilder sb = new StringBuilder(512);
sb.append("AuditSessionEntity")
.append("[ ID=").append(id)
.append(", applicationNameId=").append(applicationNameId)
.append(", auditModelId=").append(auditModelId)
.append("]");
return sb.toString();
}
public Long getId()
{
return id;
}
public void setId(Long id)
{
this.id = id;
}
public Long getAuditModelId()
{
return auditModelId;
}
public void setAuditModelId(Long auditModelId)
{
this.auditModelId = auditModelId;
}
public Long getApplicationNameId()
{
return applicationNameId;
}
public void setApplicationNameId(Long applicationNameId)
{
this.applicationNameId = applicationNameId;
}
}

34
source/java/org/alfresco/repo/domain/audit/ibatis/AuditDAOImpl.java
View File

@@ -25,7 +25,8 @@
package org.alfresco.repo.domain.audit.ibatis;
import org.alfresco.repo.domain.audit.AbstractAuditDAOImpl;
import org.alfresco.repo.domain.audit.AuditConfigEntity;
import org.alfresco.repo.domain.audit.AuditModelEntity;
import org.alfresco.repo.domain.audit.AuditSessionEntity;
import org.springframework.orm.ibatis.SqlMapClientTemplate;
/**
@@ -36,8 +37,10 @@ import org.springframework.orm.ibatis.SqlMapClientTemplate;
*/
public class AuditDAOImpl extends AbstractAuditDAOImpl
{
private static final String SELECT_CONFIG_BY_CRC = "select.AuditConfigByCrc";
private static final String INSERT_CONFIG = "insert.AuditConfig";
private static final String SELECT_MODEL_BY_CRC = "select.AuditModelByCrc";
private static final String INSERT_MODEL = "insert.AuditModel";
private static final String INSERT_SESSION = "insert.AuditSession";
private SqlMapClientTemplate template;
@@ -47,24 +50,35 @@ public class AuditDAOImpl extends AbstractAuditDAOImpl
}
@Override
protected AuditConfigEntity getAuditConfigByCrc(long crc)
protected AuditModelEntity getAuditModelByCrc(long crc)
{
AuditConfigEntity entity = new AuditConfigEntity();
AuditModelEntity entity = new AuditModelEntity();
entity.setContentCrc(crc);
entity = (AuditConfigEntity) template.queryForObject(
SELECT_CONFIG_BY_CRC,
entity = (AuditModelEntity) template.queryForObject(
SELECT_MODEL_BY_CRC,
entity);
// Done
return entity;
}
@Override
protected AuditConfigEntity createAuditConfig(Long contentDataId, long crc)
protected AuditModelEntity createAuditModel(Long contentDataId, long crc)
{
AuditConfigEntity entity = new AuditConfigEntity();
AuditModelEntity entity = new AuditModelEntity();
entity.setContentDataId(contentDataId);
entity.setContentCrc(crc);
Long id = (Long) template.insert(INSERT_CONFIG, entity);
Long id = (Long) template.insert(INSERT_MODEL, entity);
entity.setId(id);
return entity;
}
@Override
protected AuditSessionEntity createAuditSession(Long appNameId, Long modelId)
{
AuditSessionEntity entity = new AuditSessionEntity();
entity.setApplicationNameId(appNameId);
entity.setAuditModelId(modelId);
Long id = (Long) template.insert(INSERT_SESSION, entity);
entity.setId(id);
return entity;
}