Package hudson.plugins.audit_trail

Class AuditLogger

java.lang.Object

hudson.plugins.audit_trail.AuditLogger

All Implemented Interfaces:

ExtensionPoint, Describable<AuditLogger>

Direct Known Subclasses:

AbstractLogFileAuditLogger, ConsoleAuditLogger, ElasticSearchAuditLogger, SyslogAuditLogger

public abstract class AuditLogger
extends Object
implements Describable<AuditLogger>, ExtensionPoint

Author:

Nicolas De Loof, Pierre Beitz

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
AuditLogger()

Method Summary

Modifier and Type	Method	Description
static DescriptorExtensionList<AuditLogger,Descriptor<AuditLogger>>	all()	Returns all the registered AuditLogger descriptors.
void	cleanUp()	Clean up any resource used by this logger.
Descriptor<AuditLogger>	getDescriptor()
abstract void	log(String event)

Methods inherited from class java.lang.Object

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

Constructor Details

AuditLogger

public AuditLogger()

Method Details

log

public abstract void log(String event)

getDescriptor

public Descriptor<AuditLogger> getDescriptor()

Specified by:

getDescriptor in interface Describable<AuditLogger>

cleanUp

public void cleanUp()
             throws SecurityException

Clean up any resource used by this logger. For instance if your logger use a InputStream, this is were you should close it.

Throws:

SecurityException - if a security manager exists and if the caller does not have LoggingPermission("control").

all

public static DescriptorExtensionList<AuditLogger,Descriptor<AuditLogger>> all()

Returns all the registered AuditLogger descriptors.