AuditLog (Governance Action Framework (GAF) 1.0 API)

All Known Implementing Classes:

AuditLogBase
```
public interface AuditLog
```
The AuditLog provides a standard interface for writing audit log record during real-time management and use of Assets.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addLogMessage(String message)` Creates an Audit log record for the caller.
`String`	`getCallerId()` Return setting for the callerId.
`String`	`getCallerName()` Return setting for the callerName.
`String`	`getCallerType()` Return setting of the callerType.
`String`	`getContextId()` Returns the current context id associated with the Audit log.
`String`	`getProperty(String propertyName)` Retrieve a property stored in the Audit log.
`List<String>`	`getPropertyNames()` Request a list of property names stored in the Audit log.
`String`	`getResourceId()` Return setting for the resourceId.
`String`	`getResourceName()` Return setting for the resourceName.
`String`	`getResourceType()` Return setting of the resourceType.
`void`	`setCallerId(String newCallerId)` Set up the identifier of the caller.
`void`	`setCallerName(String newCallerName)` Set up a meaningful name for the caller.
`void`	`setCallerType(String newCallerType)` Set up the type of caller.
`void`	`setContextId(String newContextId)` Set a context id for the activity that the Audit log relates to.
`void`	`setProperty(String newPropertyName, String newPropertyValue)` Add or update a property in the Audit log.
`void`	`setResourceId(String newResourceId)` Set up the identifier of the related resource, such as the connector to access data.
`void`	`setResourceName(String newResourceName)` Set up a meaningful name for the related resource.
`void`	`setResourceType(String newResourceType)` Set up the type of the related resource.

- Method Detail
  - setCallerId
```
void setCallerId(String newCallerId)
```
    Set up the identifier of the caller. This is used for correlation of output from the logs with metadata in the metadata repository and other diagnostic information.
    
    Parameters:
    
    newCallerId - - guid of the caller
  - getCallerId
```
String getCallerId()
```
    Return setting for the callerId.
    
    Returns:
    
    callerId - guid of the caller.
  - setCallerName
```
void setCallerName(String newCallerName)
```
    Set up a meaningful name for the caller. This is used for correlation of output from the logs with metadata in the metadata repository and other diagnostic information.
    
    Parameters:
    
    newCallerName - - meaningful name of the caller - such as the name of the application using the Audit log.
  - getCallerName
```
String getCallerName()
```
    Return setting for the callerName.
    
    Returns:
    
    callerName - name of the caller
  - setCallerType
```
void setCallerType(String newCallerType)
```
    Set up the type of caller. This is used for correlation of output from the logs with metadata in the metadata repository and other diagnostic information.
    
    Parameters:
    
    newCallerType - - meaningful descriptive type name - such as the type of the application using the Audit log.
  - getCallerType
```
String getCallerType()
```
    Return setting of the callerType.
    
    Returns:
    
    callerType - type of caller
  - setResourceId
```
void setResourceId(String newResourceId)
```
    Set up the identifier of the related resource, such as the connector to access data. This is used for correlation of output from the logs with metadata in the metadata repository and other diagnostic information.
    
    Parameters:
    
    newResourceId - - guid of the caller
  - getResourceId
```
String getResourceId()
```
    Return setting for the resourceId.
    
    Returns:
    
    resourceId - guid of the resource.
  - setResourceName
```
void setResourceName(String newResourceName)
```
    Set up a meaningful name for the related resource. This is used for correlation of output from the logs with metadata in the metadata repository and other diagnostic information.
    
    Parameters:
    
    newResourceName - - meaningful name of the resource - may be class name or (preferably) a name from related metadata entity.
  - getResourceName
```
String getResourceName()
```
    Return setting for the resourceName.
    
    Returns:
    
    resourceName - name of the related resource
  - setResourceType
```
void setResourceType(String newResourceType)
```
    Set up the type of the related resource. This is used for correlation of output from the logs with metadata in the metadata repository and other diagnostic information.
    
    Parameters:
    
    newResourceType - - meaningful descriptive type name - such as "connector".
  - getResourceType
```
String getResourceType()
```
    Return setting of the resourceType.
    
    Returns:
    
    resourceType - type of related resource
  - getPropertyNames
```
List<String> getPropertyNames()
```
    Request a list of property names stored in the Audit log. This is used in conjunction with get/setProperty.
    
    Returns:
    
    List - String - list of property names
  - setProperty
```
void setProperty(String newPropertyName,
                 String newPropertyValue)
```
    Add or update a property in the Audit log. Properties are used to record additional information about the caller of the Audit log and their activity.
    
    Parameters:
    
    newPropertyName - - name of the property - if the property exists, it will update; otherwise add a new property
    
    newPropertyValue - - value to associate with the property name. If null is passed the property is deleted.
  - getProperty
```
String getProperty(String propertyName)
```
    Retrieve a property stored in the Audit log. A null is returned if the property is not set.
    
    Parameters:
    
    propertyName - - name of property to return.
    
    Returns:
    
    propertyValue - associated value.
  - setContextId
```
void setContextId(String newContextId)
```
    Set a context id for the activity that the Audit log relates to. This may change over time and its current value will be added to each log record as it is created. Examples of contextIds may be the function name, or processId of the activity.
    
    Parameters:
    
    newContextId - - identifier for the current activity.
  - getContextId
```
String getContextId()
```
    Returns the current context id associated with the Audit log.
    
    Returns:
    
    contextId - id for the activity.
  - addLogMessage
```
void addLogMessage(String message)
```
    Creates an Audit log record for the caller. This log record will be augmented with details of the caller and context and then pushed to disk for later study. The caller may also make use of the properties stored in the Audit log to augment the content of the log record before calling addLogMessage().
    
    Parameters:
    
    message - - log record content

Interface AuditLog

Method Summary

Method Detail

setCallerId

getCallerId

setCallerName

getCallerName

setCallerType

getCallerType

setResourceId

getResourceId

setResourceName

getResourceName

setResourceType

getResourceType

getPropertyNames

setProperty

getProperty

setContextId

getContextId

addLogMessage