org.alfresco.repo.audit
Class AuditInfo

java.lang.Object
  extended by org.alfresco.repo.audit.AuditInfo

public class AuditInfo
extends java.lang.Object

A class to encapsulate audit information supplied to the DAO layer. Null entries should be stored.


Constructor Summary
AuditInfo(AuditConfiguration auditConfiguration)
          Create the default audit info from the audit configuration.
 
Method Summary
 java.lang.String getAuditApplication()
          Get the name of the audited application.
 AuditConfiguration getAuditConfiguration()
          Get the audit configuration.
 java.lang.String getAuditMethod()
          Get the name of the audited method - if it makes sense in the uadited context.
 java.lang.String getAuditService()
          Get the audit service.
 java.net.InetAddress getClientAddress()
          Get the address o which the client application is running if available
 java.util.Date getDate()
          Get the date for the audit entry/
 java.net.InetAddress getHostAddress()
          Get the host address where the repository is running.
 java.lang.String getKeyGUID()
          Get the GUID for the key node ref
 java.util.Map getKeyPropertiesAfter()
          Get the properies of the key node after the method invoation.
 java.util.Map getKeyPropertiesBefore()
          Get the properies of the key node before the method invoation.
 StoreRef getKeyStore()
           
 java.lang.String getMessage()
           
 java.io.Serializable[] getMethodArguments()
           
 java.lang.String getPath()
           
 java.io.Serializable getReturnObject()
           
 java.lang.String getSessionId()
           
 java.lang.Throwable getThrowable()
           
 java.lang.String getTxId()
           
 java.lang.String getUserIdentifier()
           
 boolean isFail()
          Is this an audit of a failed method invocation?
 boolean isFiltered()
          Could some audit information have been filtered? If true there may have been some unaudited operations of the same type.
 void setAuditApplication(java.lang.String auditApplication)
          Set the name of the audited application.
 void setAuditConfiguration(AuditConfiguration auditConfiguration)
          Set the audit configuration.
 void setAuditMethod(java.lang.String auditMethod)
          Set the name of the audited method.
 void setAuditService(java.lang.String auditService)
          Set the audit service (IOC)
 void setClientAddress(java.net.InetAddress clientAddress)
          Set the client address that casued the audit.
 void setDate(java.util.Date date)
          Set the date for the audit entry
 void setFail(boolean fail)
          Set that this is an audit of a failed method invoation.
 void setFiltered(boolean filtered)
          Set if a filter was present for this audit entry
 void setHostAddress(java.net.InetAddress hostAddress)
          Set the host address where the repository is running.
 void setKeyGUID(java.lang.String keyGUID)
          Set the GUID for the key node ref in the audited method invoation.
 void setKeyPropertiesAfter(java.util.Map keyPropertiesAfter)
          Set the preperties to be stored in the audit trail for the key node ref after the audited method has been invoked.
 void setKeyPropertiesBefore(java.util.Map keyPropertiesBefore)
          Set the preperties to be stored in the audit trail for the key node ref before the audited method has been invoked.
 void setKeyStore(StoreRef keyStore)
           
 void setMessage(java.lang.String message)
           
 void setMethodArguments(java.io.Serializable[] methodArguments)
           
 void setPath(java.lang.String keyPath)
           
 void setReturnObject(java.io.Serializable returnObject)
           
 void setSessionId(java.lang.String sessionId)
           
 void setThrowable(java.lang.Throwable throwable)
           
 void setTxId(java.lang.String txId)
           
 void setUserIdentifier(java.lang.String userIdentifier)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AuditInfo

public AuditInfo(AuditConfiguration auditConfiguration)
Create the default audit info from the audit configuration.

Parameters:
auditConfiguration -
Method Detail

getAuditApplication

public java.lang.String getAuditApplication()
Get the name of the audited application.

Returns:
- the name of the audited application.

setAuditApplication

public void setAuditApplication(java.lang.String auditApplication)
Set the name of the audited application.

Parameters:
auditApplication -

getAuditConfiguration

public AuditConfiguration getAuditConfiguration()
Get the audit configuration.

Returns:
- the audit configuration.

setAuditConfiguration

public void setAuditConfiguration(AuditConfiguration auditConfiguration)
Set the audit configuration.

Parameters:
auditConfiguration -

getAuditMethod

public java.lang.String getAuditMethod()
Get the name of the audited method - if it makes sense in the uadited context.

Returns:
- the name of the audited method or null

setAuditMethod

public void setAuditMethod(java.lang.String auditMethod)
Set the name of the audited method.

Parameters:
auditMethod -

getAuditService

public java.lang.String getAuditService()
Get the audit service.

Returns:
- the audit service.

setAuditService

public void setAuditService(java.lang.String auditService)
Set the audit service (IOC)

Parameters:
auditService -

getClientAddress

public java.net.InetAddress getClientAddress()
Get the address o which the client application is running if available

Returns:
- the address or null.

setClientAddress

public void setClientAddress(java.net.InetAddress clientAddress)
Set the client address that casued the audit.

Parameters:
clientAddress -

getDate

public java.util.Date getDate()
Get the date for the audit entry/

Returns:
- the date for the audit entry.

setDate

public void setDate(java.util.Date date)
Set the date for the audit entry

Parameters:
date -

isFail

public boolean isFail()
Is this an audit of a failed method invocation?

Returns:
- true if the audited methoed threw any kind of exception.

setFail

public void setFail(boolean fail)
Set that this is an audit of a failed method invoation.

Parameters:
fail -

isFiltered

public boolean isFiltered()
Could some audit information have been filtered? If true there may have been some unaudited operations of the same type.

Returns:
- true if there were any filter definitions in the audit model; false otherwise.

setFiltered

public void setFiltered(boolean filtered)
Set if a filter was present for this audit entry

Parameters:
filtered -

getHostAddress

public java.net.InetAddress getHostAddress()
Get the host address where the repository is running.

Returns:
- the host address.

setHostAddress

public void setHostAddress(java.net.InetAddress hostAddress)
Set the host address where the repository is running.

Parameters:
hostAddress -

getKeyGUID

public java.lang.String getKeyGUID()
Get the GUID for the key node ref

Returns:
- the guid part of the node ref

setKeyGUID

public void setKeyGUID(java.lang.String keyGUID)
Set the GUID for the key node ref in the audited method invoation.

Parameters:
keyGUID -

getKeyPropertiesAfter

public java.util.Map getKeyPropertiesAfter()
Get the properies of the key node after the method invoation.

Returns:
- the properties to be stored in the audit trail

setKeyPropertiesAfter

public void setKeyPropertiesAfter(java.util.Map keyPropertiesAfter)
Set the preperties to be stored in the audit trail for the key node ref after the audited method has been invoked.

Parameters:
keyPropertiesAfter -

getKeyPropertiesBefore

public java.util.Map getKeyPropertiesBefore()
Get the properies of the key node before the method invoation.

Returns:
- the properties to be stored in the audit trail

setKeyPropertiesBefore

public void setKeyPropertiesBefore(java.util.Map keyPropertiesBefore)
Set the preperties to be stored in the audit trail for the key node ref before the audited method has been invoked.

Parameters:
keyPropertiesAfter -

getKeyStore

public StoreRef getKeyStore()

setKeyStore

public void setKeyStore(StoreRef keyStore)

getMessage

public java.lang.String getMessage()

setMessage

public void setMessage(java.lang.String message)

getMethodArguments

public java.io.Serializable[] getMethodArguments()

setMethodArguments

public void setMethodArguments(java.io.Serializable[] methodArguments)

getPath

public java.lang.String getPath()

setPath

public void setPath(java.lang.String keyPath)

getReturnObject

public java.io.Serializable getReturnObject()

setReturnObject

public void setReturnObject(java.io.Serializable returnObject)

getSessionId

public java.lang.String getSessionId()

setSessionId

public void setSessionId(java.lang.String sessionId)

getThrowable

public java.lang.Throwable getThrowable()

setThrowable

public void setThrowable(java.lang.Throwable throwable)

getTxId

public java.lang.String getTxId()

setTxId

public void setTxId(java.lang.String txId)

getUserIdentifier

public java.lang.String getUserIdentifier()

setUserIdentifier

public void setUserIdentifier(java.lang.String userIdentifier)


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.