org.nuxeo.ecm.platform.audit.io
Class IOAuditAdapter

java.lang.Object
  org.nuxeo.ecm.platform.io.api.AbstractIOResourceAdapter
      org.nuxeo.ecm.platform.audit.io.IOAuditAdapter

All Implemented Interfaces:

Serializable, IOResourceAdapter

public class IOAuditAdapter
extends AbstractIOResourceAdapter

Adapter for import/export of audit logs.

Author:

Dragos Mihalache

See Also:

Serialized Form

Constructor Summary

IOAuditAdapter()

Method Summary

IOResources	extractResources(String repo, Collection<DocumentRef> sources) Extract logs involving given documents.
protected CoreSession	getCoreSession(String repo)
protected IOLogEntryBase	getLogEntryHelper() Should be overridden if IOLogEntryBase is subclassed
protected Logs	getLogService()
static NXAuditEvents	getNXAuditEventsService()
void	getResourcesAsXML(OutputStream out, IOResources resources) Export resources as XML.
IOResources	loadResourcesFromXML(InputStream stream) Returns resources built from given stream.
void	setProperties(Map<String,Serializable> properties) Set properties.
void	storeResources(IOResources newResources) Persists resources.
IOResources	translateResources(String repo, IOResources resources, DocumentTranslationMap map) Returns translated resources once copy has been done, passing a correspondence map.

Methods inherited from class org.nuxeo.ecm.platform.io.api.AbstractIOResourceAdapter

getBooleanProperty, getProperties, getStringArrayProperty, getStringProperty, setBooleanProperty, setStringArrayProperty, setStringProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IOAuditAdapter

public IOAuditAdapter()

Method Detail

getLogEntryHelper

protected IOLogEntryBase getLogEntryHelper()

Should be overridden if IOLogEntryBase is subclassed

Returns:

IOLogEntryBase instance that will know how to write and read log entries

setProperties

public void setProperties(Map<String,Serializable> properties)

Description copied from interface: IOResourceAdapter

Set properties.

Specified by:

setProperties in interface IOResourceAdapter

Overrides:

setProperties in class AbstractIOResourceAdapter

getCoreSession

protected CoreSession getCoreSession(String repo)
                              throws Exception

Throws:

Exception

getLogService

protected Logs getLogService()
                      throws Exception

Throws:

Exception

getNXAuditEventsService

public static NXAuditEvents getNXAuditEventsService()

extractResources

public IOResources extractResources(String repo,
                                    Collection<DocumentRef> sources)

Extract logs involving given documents.

The adapter properties will filter which logs must be taken into account.

Specified by:

extractResources in interface IOResourceAdapter

Specified by:

extractResources in class AbstractIOResourceAdapter

Parameters:

repo - TODO

sources - locations of documents to consider. Has to include documents children if needed.

Returns:

a structure holding associated resources.

getResourcesAsXML

public void getResourcesAsXML(OutputStream out,
                              IOResources resources)

Description copied from interface: IOResourceAdapter

Export resources as XML.

Specified by:

getResourcesAsXML in interface IOResourceAdapter

Specified by:

getResourcesAsXML in class AbstractIOResourceAdapter

resources - resources previously extracted thanks to IOResourceAdapter.extractResources(String, Collection) or IOResourceAdapter.translateResources(String, IOResources, DocumentTranslationMap)

loadResourcesFromXML

public IOResources loadResourcesFromXML(InputStream stream)

Description copied from interface: IOResourceAdapter

Returns resources built from given stream.

Specified by:

loadResourcesFromXML in interface IOResourceAdapter

Specified by:

loadResourcesFromXML in class AbstractIOResourceAdapter

storeResources

public void storeResources(IOResources newResources)

Description copied from interface: IOResourceAdapter

Persists resources.

Specified by:

storeResources in interface IOResourceAdapter

Specified by:

storeResources in class AbstractIOResourceAdapter

Parameters:

newResources - resources previously extracted thanks to IOResourceAdapter.extractResources(String, Collection) or IOResourceAdapter.translateResources(String, IOResources, DocumentTranslationMap)

translateResources

public IOResources translateResources(String repo,
                                      IOResources resources,
                                      DocumentTranslationMap map)

Description copied from interface: IOResourceAdapter

Returns translated resources once copy has been done, passing a correspondence map.

Specified by:

translateResources in interface IOResourceAdapter

Specified by:

translateResources in class AbstractIOResourceAdapter

Parameters:

repo - target repository for resources.

resources - resources previously extracted thanks to IOResourceAdapter.extractResources(String, Collection)

map - correspondence map between old locations and new ones.

Returns:

translated resources.