org.odpi.openmetadata.frameworks.governanceaction.logs

Class AuditLogBase

java.lang.Object

org.odpi.openmetadata.frameworks.governanceaction.logs.AuditLogBase

All Implemented Interfaces:

AuditLog

public class AuditLogBase
extends Object
implements AuditLog

AuditLogBase is a simple audit log capability. An AuditLogBase should be initialized with details of the caller, resource and context before the first call to addLogRecord. The contextId may be changed from time to time as the caller's activity changes.

Constructor Summary

Constructors

Constructor and Description
AuditLogBase(String name, String serverURL) Default constructor

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuditLogBase

public AuditLogBase(String name,
                    String serverURL)

Default constructor

Parameters:

name - - log name

serverURL - - URL of the server to use

Method Detail

setCallerId

public 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.

Specified by:

setCallerId in interface AuditLog

Parameters:

newCallerId - - guid of the caller

getCallerId

public String getCallerId()

Return setting for the callerId.

Specified by:

getCallerId in interface AuditLog

Returns:

callerId - guid of the caller.

setCallerName

public 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.

Specified by:

setCallerName in interface AuditLog

Parameters:

newCallerName - - meaningful name of the caller - such as the name of the application using the Audit log.

getCallerName

public String getCallerName()

Return setting for the callerName.

Specified by:

getCallerName in interface AuditLog

Returns:

callerName - name of the caller

setCallerType

public 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.

Specified by:

setCallerType in interface AuditLog

Parameters:

newCallerType - - meaningful descriptive type name - such as the type of the application using the Audit log.

getCallerType

public String getCallerType()

Return setting of the callerType.

Specified by:

getCallerType in interface AuditLog

Returns:

callerType - type of caller

setResourceId

public 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.

Specified by:

setResourceId in interface AuditLog

Parameters:

newResourceId - - guid of the caller

getResourceId

public String getResourceId()

Return setting for the resourceId.

Specified by:

getResourceId in interface AuditLog

Returns:

resourceId - guid of the resource.

setResourceName

public 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.

Specified by:

setResourceName in interface AuditLog

Parameters:

newResourceName - - meaningful name of the resource - may be class name or (preferably) a name from related metadata entity.

getResourceName

public String getResourceName()

Return setting for the resourceName.

Specified by:

getResourceName in interface AuditLog

Returns:

resourceName - name of the related resource

setResourceType

public 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.

Specified by:

setResourceType in interface AuditLog

Parameters:

newResourceType - - meaningful descriptive type name - such as "connector".

getResourceType

public String getResourceType()

Return setting of the resourceType.

Specified by:

getResourceType in interface AuditLog

Returns:

resourceType - type of related resource

getPropertyNames

public List<String> getPropertyNames()

Request a list of property names stored in the Audit log. This is used in conjunction with get/setProperty.

Specified by:

getPropertyNames in interface AuditLog

Returns:

Enumeration - String - enumeration of property names

setProperty

public 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.

Specified by:

setProperty in interface AuditLog

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

public String getProperty(String propertyName)

Retrieve a property stored in the Audit log. A null is returned if the property is not set.

Specified by:

getProperty in interface AuditLog

Parameters:

propertyName - - name of property to return.

Returns:

propertyValue - associated value.

setContextId

public 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.

Specified by:

setContextId in interface AuditLog

Parameters:

newContextId - - identifier for the current activity.

getContextId

public String getContextId()

Returns the current context id associated with the Audit log.

Specified by:

getContextId in interface AuditLog

Returns:

contextId - id for the activity.

addLogMessage

public 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().

Specified by:

addLogMessage in interface AuditLog

Parameters:

message - - log record content