com.goldencode.p2j.util

Class AuditControlManager

java.lang.Object

com.goldencode.p2j.util.AuditControlManager

public class AuditControlManager
extends java.lang.Object

Provides static methods implementing support for the AUDIT-CONTROL system handle attributes and methods See CommonAuditControl

Constructor Summary

Constructors

Constructor and Description
AuditControlManager()

Method Summary

Modifier and Type	Method and Description
static handle	asHandle() Get a the instance for the AUDIT-CONTROL system handle.
static character	beginEventGroup(character eventContext) Implementation of AUDIT-CONTROL:BEGIN-EVENT-GROUP method.
static character	beginEventGroup(character eventContext, character eventDetail) Implementation of AUDIT-CONTROL:BEGIN-EVENT-GROUP method.
static character	beginEventGroup(character eventContext, character eventDetail, character auditCustomDetail) Implementation of AUDIT-CONTROL:BEGIN-EVENT-GROUP method.
static logical	clearApplContext() Implementation of AUDIT-CONTROL:CLEAR-APPL-CONTEXT method.
static logical	endEventGroup() Implementation of AUDIT-CONTROL:END-EVENT-GROUP method.
static character	getApplContextId() Implementation of APPL-CONTEXT-ID attribute getter.
static character	getEventGroupId() Implementation of EVENT-GROUP-ID attribute getter.
static character	logAuditEvent(integer eventId, character eventContext) Implementation of AUDIT-CONTROL:LOG-AUDIT-EVENT method.
static character	logAuditEvent(integer eventId, character eventContext, character eventDetail) Implementation of AUDIT-CONTROL:LOG-AUDIT-EVENT method.
static character	logAuditEvent(integer eventId, character eventContext, character eventDetail, character auditCustomDetail) Implementation of AUDIT-CONTROL:LOG-AUDIT-EVENT method.
static character	setApplContext(character eventContext) Implementation of AUDIT-CONTROL:SET-APPL-CONTEXT method.
static character	setApplContext(character eventContext, character eventDetail) Implementation of AUDIT-CONTROL:SET-APPL-CONTEXT method.
static character	setApplContext(character eventContext, character eventDetail, character auditCustomDetail) Implementation of AUDIT-CONTROL:SET-APPL-CONTEXT method.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditControlManager

public AuditControlManager()

Method Detail

asHandle

public static handle asHandle()

Get a the instance for the AUDIT-CONTROL system handle. Is obtained using a call to the StaticProxy.obtain(Class, Class[]), using the CommonAuditControl interface and its methods implemented by these classes: AuditPolicyManager.

Returns:

See above.

getApplContextId

public static character getApplContextId()

Implementation of APPL-CONTEXT-ID attribute getter. Returns the universally unique identifier (UUID) for the application context in effect for the current session, as a Base64 character string.

Returns:

The universally unique identifier (UUID) for the application context.

getEventGroupId

public static character getEventGroupId()

Implementation of EVENT-GROUP-ID attribute getter. Returns the universally unique identifier (UUID) for the audit event group in effect for the current session, as a Base64 character string

Returns:

The universally unique identifier (UUID) for the audit event group in effect.

beginEventGroup

public static character beginEventGroup(character eventContext)

Implementation of AUDIT-CONTROL:BEGIN-EVENT-GROUP method. Indicates (and records) the beginning of a group of related audit events in the current session.

Parameters:

eventContext - A character expression that specifies the context for the audit event.

Returns:

This method returns a Base64 character string that specifies the universally unique identifier (UUID) of the primary index for all audit event records generated by this method for this application context.

beginEventGroup

public static character beginEventGroup(character eventContext,
                                        character eventDetail)

Implementation of AUDIT-CONTROL:BEGIN-EVENT-GROUP method. Indicates (and records) the beginning of a group of related audit events in the current session.

Parameters:

eventContext - A character expression that specifies the context for the audit event.

eventDetail - An optional character expression that specifies additional audit detail.

Returns:

This method returns a Base64 character string that specifies the universally unique identifier (UUID) of the primary index for all audit event records generated by this method for this application context.

beginEventGroup

public static character beginEventGroup(character eventContext,
                                        character eventDetail,
                                        character auditCustomDetail)

Implementation of AUDIT-CONTROL:BEGIN-EVENT-GROUP method. Indicates (and records) the beginning of a group of related audit events in the current session.

Parameters:

eventContext - A character expression that specifies the context for the audit event.

eventDetail - An optional character expression that specifies additional audit detail.

auditCustomDetail - An optional character expression that specifies additional user detail.

Returns:

This method returns a Base64 character string that specifies the universally unique identifier (UUID) of the primary index for all audit event records generated by this method for this application context.

endEventGroup

public static logical endEventGroup()

Implementation of AUDIT-CONTROL:END-EVENT-GROUP method. Indicates the end of a group of related events in the current session.

Returns:

true if operation succeeded or false otherwise

setApplContext

public static character setApplContext(character eventContext)

Implementation of AUDIT-CONTROL:SET-APPL-CONTEXT method. Sets (and records) the application context for the current session in each connected audit-enabled database whose current audit policy has this audit event enabled.

Parameters:

eventContext - A character expression that specifies the context for the audit event.

Returns:

This method returns a Base64 character string that specifies the universally unique identifier (UUID) of the primary index for all audit event records generated by this method for this application context.

setApplContext

public static character setApplContext(character eventContext,
                                       character eventDetail)

Implementation of AUDIT-CONTROL:SET-APPL-CONTEXT method. Sets (and records) the application context for the current session in each connected audit-enabled database whose current audit policy has this audit event enabled.

Parameters:

eventContext - A character expression that specifies the context for the audit event.

eventDetail - An optional character expression that specifies additional audit detail.

Returns:

This method returns a Base64 character string that specifies the universally unique identifier (UUID) of the primary index for all audit event records generated by this method for this application context.

setApplContext

public static character setApplContext(character eventContext,
                                       character eventDetail,
                                       character auditCustomDetail)

Implementation of AUDIT-CONTROL:SET-APPL-CONTEXT method. Sets (and records) the application context for the current session in each connected audit-enabled database whose current audit policy has this audit event enabled.

Parameters:

eventContext - A character expression that specifies the context for the audit event.

eventDetail - An optional character expression that specifies additional audit detail.

auditCustomDetail - An optional character expression that specifies additional user detail.

Returns:

This method returns a Base64 character string that specifies the universally unique identifier (UUID) of the primary index for all audit event records generated by this method for this application context.

clearApplContext

public static logical clearApplContext()

Implementation of AUDIT-CONTROL:CLEAR-APPL-CONTEXT method. Clears the application context for the current session.

Returns:

true if operation succeeded or false otherwise

logAuditEvent

public static character logAuditEvent(integer eventId,
                                      character eventContext)

Implementation of AUDIT-CONTROL:LOG-AUDIT-EVENT method. Creates an audit record for the specified application-defined audit event in each connected audit-enabled database whose current audit policy has this audit event enabled.

Parameters:

eventId - An integer value that specifies an identifier for an application-defined audit event.

eventContext - A character expression that specifies the context for the audit event.

Returns:

A Base64 character string that specifies a universally unique identifier (UUID) as the primary index for the generated audit event record.

logAuditEvent

public static character logAuditEvent(integer eventId,
                                      character eventContext,
                                      character eventDetail)

Implementation of AUDIT-CONTROL:LOG-AUDIT-EVENT method. Creates an audit record for the specified application-defined audit event in each connected audit-enabled database whose current audit policy has this audit event enabled.

Parameters:

eventId - An integer value that specifies an identifier for an application-defined audit event.

eventContext - A character expression that specifies the context for the audit event.

eventDetail - An optional character expression that specifies additional audit detail.

Returns:

A Base64 character string that specifies a universally unique identifier (UUID) as the primary index for the generated audit event record.

logAuditEvent

public static character logAuditEvent(integer eventId,
                                      character eventContext,
                                      character eventDetail,
                                      character auditCustomDetail)

Implementation of AUDIT-CONTROL:LOG-AUDIT-EVENT method. Creates an audit record for the specified application-defined audit event in each connected audit-enabled database whose current audit policy has this audit event enabled.

Parameters:

eventId - An integer value that specifies an identifier for an application-defined audit event.

eventContext - A character expression that specifies the context for the audit event.

eventDetail - An optional character expression that specifies additional audit detail.

auditCustomDetail - An optional character expression that specifies additional user detail.

Returns:

A Base64 character string that specifies a universally unique identifier (UUID) as the primary index for the generated audit event record.