org.alfresco.repo.audit.extractor

Interface DataExtractor

All Known Implementing Classes:

AbstractDataExtractor, CMISChangeLogDataExtractor, CMISChangeLogDataExtractor, NodeNameDataExtractor, NodeTypeDataExtractor, NullValueDataExtractor, SimpleValueDataExtractor

public interface DataExtractor

Interface for Audit data value extractors. These are used to extract auditable values from those arguments, return values, exceptions and any other value passed into the audit components for recording.

The framework will first determine if data passed into the instance is supported and will then pass it in for conversion to the type that will be recorded.

Since:

3.2

Method Summary

Methods

Modifier and Type	Method and Description
java.io.Serializable	extractData(java.io.Serializable value) Convert an value passed into the audit components into a value to be recorded.
boolean	isSupported(java.io.Serializable data) Determines if the extractor will be able to pull any data from the given value.

Method Detail

isSupported

boolean isSupported(java.io.Serializable data)

Determines if the extractor will be able to pull any data from the given value.

Parameters:

data - the data that might be useful to this extractor (could be null)

Returns:

Returns true if the data is meaningful to this extractor

extractData

java.io.Serializable extractData(java.io.Serializable value)
                                 throws java.lang.Throwable

Convert an value passed into the audit components into a value to be recorded.

Parameters:

value - the source data

Returns:

the extracted data including null

Throws:

java.lang.Throwable - All errors will be handled by the calling framework