Package org.alfresco.service.cmr.audit

Interface AuditInfo

  • public interface AuditInfo
    A single entry in an audit trail
    Author:
    Andy Hind

    • Method Detail

      • getAuditApplication

        String getAuditApplication()
        The identifier for the application that performed the audit. Method interceptors around public services will use the string 'SystemMethodInterceptor'.
        Returns:
        - the application (may not be null).

      • getAuditMethod

        String getAuditMethod()
        The name of the method executed on a public service.
        Returns:
        - the method name - this may be null for external audit entries.

      • getAuditService

        String getAuditService()
        The public service on which a method was invoked.
        Returns:
        - the service name - this may be null for external audit entries.

      • getClientAddress

        String getClientAddress()
        The address for the client. (This will be null in version 1.4)
        Returns:
        - the client address - may be null.

      • getDate

        Date getDate()
        The timestamp for the audit entry.
        Returns:
        Date

      • isFail

        boolean isFail()
        Is this entry recording an error?
        Returns:
        boolean

      • isFiltered

        boolean isFiltered()
        Was this audit entry subject to filtering (which must have been met if an entry is found). Filters are not applied in version 1.4.
        Returns:
        boolean

      • getHostAddress

        String getHostAddress()
        Get the host address of the server machine.
        Returns:
        String

      • getKeyGUID

        String getKeyGUID()
        Get the ID of the key node.
        Returns:
        - the id of the key node - this may be null if there is no key or the key is not a node ref.

      • getKeyPropertiesAfter

        Map<QName,​Serializable> getKeyPropertiesAfter()
        The serialized properties on the key node, if one exists, after the method invocation. Note these values are serialized before the method is called so they are unaffected by the method invocation. In V1.4 these are not stored.
        Returns:
        Map

      • getKeyPropertiesBefore

        Map<QName,​Serializable> getKeyPropertiesBefore()
        The serialized properties on the key node, if one exists, before the method invocation. In V1.4 these are not stored.
        Returns:
        Map

      • getKeyStore

        StoreRef getKeyStore()
        The store ref for the key.
        Returns:
        - the store ref - this may be null if there is no key.

      • getMessage

        String getMessage()
        The message entered for application audit entries.
        Returns:
        - the audit message. This may be null, and will be null for audit entries generated from method invocations.

      • getMethodArguments

        Serializable[] getMethodArguments()
        Get the serailized mehod arguments. These are not stored in V1.4.
        Returns:
        Serializable[]

      • getMethodArgumentsAsStrings

        String[] getMethodArgumentsAsStrings()
        Get the method arguments as strings.
        Returns:
        String[]

      • getPath

        String getPath()
        Get the path to the key node, if one exists.
        Returns:
        - the path or null.

      • getReturnObject

        Serializable getReturnObject()
        The serialized value of the return object. This is not available in V1.4.
        Returns:
        Serializable

      • getReturnObjectAsString

        String getReturnObjectAsString()
        Get the return object string value.
        Returns:
        - the string value of the return object. May be null if the method is of type void or returns null.

      • getSessionId

        String getSessionId()
        Get the session id. This is not stored in V1.4.
        Returns:
        String

      • getThrowable

        Throwable getThrowable()
        Get the deserialized error, if one occurred.
        Returns:
        the throwable or null.

      • getThrowableAsString

        String getThrowableAsString()
        In 1.4, get the error message (no stack trace).
        Returns:
        - the error message

      • getTxId

        String getTxId()
        Get the transaction id which caused the audit.
        Returns:
        the Tx id (not null).

      • getUserIdentifier

        String getUserIdentifier()
        Get the name of the user who caused the audit entry.
        Returns:
        - the user name / user authority (not null)