Package org.alfresco.repo.audit.extractor

Interface DataExtractor

All Known Implementing Classes:
AbstractDataExtractor, CMISChangeLogDataExtractor, NodeNameDataExtractor, NodeTypeDataExtractor, NullValueDataExtractor, SimpleValueDataExtractor
@AlfrescoPublicApi 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
Author:
Derek Hulley

  • Method Summary

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

  • Method Details

    • isSupported

      boolean isSupported(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

      Serializable extractData(Serializable value) throws 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:
      Throwable - All errors will be handled by the calling framework