Package org.forgerock.audit.handlers.jms

Interface Publisher<T>

Type Parameters:

T - The type of object that this publisher will publish as a representive of the audit event.

All Known Implementing Classes:

BatchPublisher

public interface Publisher<T>

Defines a generic interface for audit event publishers.

Method Summary

Modifier and Type	Method	Description
void	publish(T message)	implement this to deliver the audit event representation to the service.
void	shutdown()	Cleanup services that were initialized with startup().
void	startup()	Initialize services that are reused by individual publish calls.

Method Details

startup

void startup()
      throws ResourceException

Initialize services that are reused by individual publish calls.

Throws:

ResourceException - If the publisher cannot be started.

shutdown

void shutdown()
       throws ResourceException

Cleanup services that were initialized with startup().

Throws:

ResourceException - If the publisher cannot be shut down.

publish

void publish(T message)
      throws ResourceException

implement this to deliver the audit event representation to the service.

Parameters:

message - representative object of the audit event

Throws:

ResourceException - If the message cannot be published.