Package org.forgerock.audit.handlers.syslog

Class SyslogAuditEventHandler

java.lang.Object

org.forgerock.audit.events.handlers.AuditEventHandlerBase

org.forgerock.audit.handlers.syslog.SyslogAuditEventHandler

All Implemented Interfaces:

org.forgerock.audit.events.handlers.AuditEventHandler

public class SyslogAuditEventHandler
extends org.forgerock.audit.events.handlers.AuditEventHandlerBase

The handler publishes audit events formatted using SyslogFormatter to a syslog daemon using the configured SyslogPublisher. The publisher is flushed after each write.

Field Summary

Fields inherited from class org.forgerock.audit.events.handlers.AuditEventHandlerBase

eventTopicsMetaData

Constructor Summary

Constructors

Constructor	Description
SyslogAuditEventHandler(SyslogAuditEventHandlerConfiguration configuration, org.forgerock.audit.events.EventTopicsMetaData eventTopicsMetaData, org.forgerock.audit.providers.ProductInfoProvider productInfoProvider, org.forgerock.audit.providers.LocalHostNameProvider localHostNameProvider)	Create a new SyslogAuditEventHandler instance.

Method Summary

Modifier and Type	Method	Description
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>	publishEvent(org.forgerock.services.context.Context context, String topic, org.forgerock.json.JsonValue event)
org.forgerock.util.promise.Promise<org.forgerock.json.resource.QueryResponse,org.forgerock.json.resource.ResourceException>	queryEvents(org.forgerock.services.context.Context context, String topic, org.forgerock.json.resource.QueryRequest queryRequest, org.forgerock.json.resource.QueryResourceHandler queryResourceHandler)
org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>	readEvent(org.forgerock.services.context.Context context, String topic, String resourceId)
void	shutdown()	Closes the connections established by SyslogPublisher.
void	startup()

Methods inherited from class org.forgerock.audit.events.handlers.AuditEventHandlerBase

getHandledTopics, getName, handleAction, isEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

SyslogAuditEventHandler

@Inject
public SyslogAuditEventHandler(SyslogAuditEventHandlerConfiguration configuration,
                               org.forgerock.audit.events.EventTopicsMetaData eventTopicsMetaData,
                               org.forgerock.audit.providers.ProductInfoProvider productInfoProvider,
                               org.forgerock.audit.providers.LocalHostNameProvider localHostNameProvider)

Create a new SyslogAuditEventHandler instance.

Parameters:

configuration - Configuration parameters that can be adjusted by system administrators.

eventTopicsMetaData - Meta-data for all audit event topics.

productInfoProvider - Provides info such as product name.

localHostNameProvider - Provides local host name.

Method Detail

startup

public void startup()

shutdown

public void shutdown()

Closes the connections established by SyslogPublisher.

publishEvent

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> publishEvent(org.forgerock.services.context.Context context,
                                                                                                                                                         String topic,
                                                                                                                                                         org.forgerock.json.JsonValue event)

queryEvents

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.QueryResponse,org.forgerock.json.resource.ResourceException> queryEvents(org.forgerock.services.context.Context context,
                                                                                                                                                     String topic,
                                                                                                                                                     org.forgerock.json.resource.QueryRequest queryRequest,
                                                                                                                                                     org.forgerock.json.resource.QueryResourceHandler queryResourceHandler)

readEvent

public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> readEvent(org.forgerock.services.context.Context context,
                                                                                                                                                      String topic,
                                                                                                                                                      String resourceId)