com.pega.pegarules.pub.context

Interface ISecurityEventLogger

All Superinterfaces:

ICustomEventLogger

public interface ISecurityEventLogger
extends ICustomEventLogger

ISecurityEventLogger

Field Summary

Fields inherited from interface com.pega.pegarules.pub.context.ICustomEventLogger

VERSION

Method Summary

Modifier and Type	Method and Description
void	initializeCache(PRThread thread, java.lang.String tenantName) API to initialize configuration cache.
boolean	isEventLoggable(PublicAPI tools, java.lang.String eventType, java.lang.Boolean evntOutCome) API to intimate whether event is configured to be logged or not.
void	loadSecEventLogSettings(PRThread prThread, ClipboardPage page) API to update the configuration changes across the cluster.
void	logAuthenticationEvent(PublicAPI tools, java.lang.String eventType, java.lang.String outcome, java.lang.String message, java.util.Map<java.lang.String,java.lang.String> customFlds) API to log authentication events.
void	logDataAccessEvent(PublicAPI tools, java.lang.String eventType, java.lang.String outcome, java.lang.String message, java.util.Map<java.lang.String,java.lang.String> customFlds) API to log DataAccess events.
void	logDefaultEvent(PublicAPI tools, java.lang.String eventCategory, java.lang.String eventType, java.lang.String outcome, java.lang.String message, java.util.Map<java.lang.String,java.lang.String> customFlds) API to log default events.
void	logSecurityAdministrationEvent(PublicAPI tools, java.lang.String eventType, java.lang.String outcome, java.lang.String message, java.util.Map<java.lang.String,java.lang.String> customFlds) API to log SecurityAdministration events.

Methods inherited from interface com.pega.pegarules.pub.context.ICustomEventLogger

logCustomEvent

Method Detail

logAuthenticationEvent

void logAuthenticationEvent(PublicAPI tools,
                            java.lang.String eventType,
                            java.lang.String outcome,
                            java.lang.String message,
                            java.util.Map<java.lang.String,java.lang.String> customFlds)

API to log authentication events. Check the SecurityEventConstants for the event types that fall under authentication category.

Parameters:

tools - instance of Executable.

eventType - SecurityEventConstant that describes the eventType.

outcome - SecurityEventConstant that describes the outcome, whether success/failure.

message - Any information related to the event to be logged.

customFlds - Any custom fields relevant to the event to be logged.This can be a java HashMap or can be a clipboardpage.

logDataAccessEvent

void logDataAccessEvent(PublicAPI tools,
                        java.lang.String eventType,
                        java.lang.String outcome,
                        java.lang.String message,
                        java.util.Map<java.lang.String,java.lang.String> customFlds)

API to log DataAccess events. Check the SecurityEventConstants for the event types that fall under DataAccess category.

Parameters:

tools - instance of Executable.

eventType - SecurityEventConstant that describes the eventType.

outcome - SecurityEventConstant that describes the outcome, whether success/failure.

message - Any information related to the event to be logged.

customFlds - Any custom fields relevant to the event to be logged.This can be a java HashMap or can be a clipboardpage.

logSecurityAdministrationEvent

void logSecurityAdministrationEvent(PublicAPI tools,
                                    java.lang.String eventType,
                                    java.lang.String outcome,
                                    java.lang.String message,
                                    java.util.Map<java.lang.String,java.lang.String> customFlds)

API to log SecurityAdministration events. Check the SecurityEventConstants for the event types that fall under SecurityAdministration category.

Parameters:

tools - instance of Executable.

eventType - SecurityEventConstant that describes the eventType.

outcome - SecurityEventConstant that describes the outcome, whether success/failure.

message - Any information related to the event to be logged.

customFlds - Any custom fields relevant to the event to be logged.This can be a java HashMap or can be a clipboardpage.

logDefaultEvent

void logDefaultEvent(PublicAPI tools,
                     java.lang.String eventCategory,
                     java.lang.String eventType,
                     java.lang.String outcome,
                     java.lang.String message,
                     java.util.Map<java.lang.String,java.lang.String> customFlds)

API to log default events. These are the events that must be logged for security audit

Parameters:

tools - instance of Executable.

eventCategory - SecurityEventConstant that describes the eventCategory.

eventType - SecurityEventConstant that describes the eventType.

outcome - SecurityEventConstant that describes the outcome, whether success/failure.

message - Any information related to the event to be logged.

customFlds - Any custom fields relevant to the event to be logged.This can be a java HashMap or can be a clipboardpage.

loadSecEventLogSettings

void loadSecEventLogSettings(PRThread prThread,
                             ClipboardPage page)

API to update the configuration changes across the cluster.

Parameters:

prThread - thread information.

page - ClipboardPage with data on note change.

isEventLoggable

boolean isEventLoggable(PublicAPI tools,
                        java.lang.String eventType,
                        java.lang.Boolean evntOutCome)

API to intimate whether event is configured to be logged or not.

Parameters:

tools - instance of Executable.

eventType - SecurityEventConstant that describes the eventType.

evntOutCome - Boolean value that describes the outcome true on success false on failure. if outcome is not applicable for the event set the outcome value to null.

Returns:

true, if loggable otherwise false.

initializeCache

void initializeCache(PRThread thread,
                     java.lang.String tenantName)

API to initialize configuration cache.

Parameters:

thread - requestor thread.

tenantName - tenant for which cache has to be initialized.