com.goldencode.p2j.util

Interface CommonAuditControl

All Superinterfaces:

CommonHandle, PseudoWidget, WrappedResource

All Known Subinterfaces:

HandleCommon

public interface CommonAuditControl
extends CommonHandle, PseudoWidget

Exposes the following methods or attributes from the AUDIT-POLICY handle:

APPL-CONTEXT-ID	getApplContextId()
EVENT-GROUP-ID	getEventGroupId()
BEGIN-EVENT-GROUP	beginEventGroup(character), beginEventGroup(character, character), beginEventGroup(character, character, character)
END-EVENT-GROUP	endEventGroup()
SET-APPL-CONTEXT	setApplContext(character), setApplContext(character, character), setApplContext(character, character, character)
CLEAR-APPL-CONTEXT	clearApplContext()
LOG-AUDIT-EVENT	logAuditEvent(integer, character), logAuditEvent(integer, character, character), logAuditEvent(integer, character, character, character)

This interface is used as a returned type by the handle.unwrapAuditPolicy() API, which, depending on the handle's state, it either returns an AuditPolicyManager.asHandle() instance or an dynamic proxy using handle.invalidAttrAccessProxy

Method Summary

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

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

readOnlyError, readOnlyError, resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown, valid

Method Detail

getApplContextId

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

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

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

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

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

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

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

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

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

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

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

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

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.