Package hudson.plugins.audit_trail

Class AuditTrailPlugin

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

hudson.plugins.audit_trail.AuditTrailPlugin

All Implemented Interfaces:

ExtensionPoint, Describable<GlobalConfiguration>, Saveable, OnMaster

@Symbol("audit-trail")
@Extension
public class AuditTrailPlugin
extends GlobalConfiguration

Keep audit trail of particular Jenkins operations, such as configuring jobs.

Author:

Alan Harder, Pierre Beitz

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
AuditTrailPlugin()

Method Summary

Modifier and Type	Method	Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
FormValidation	doRegexCheck(String value)	Validate regular expression syntax.
protected XmlFile	getConfigFile()
boolean	getDisplayUserName()
boolean	getLogBuildCause()	Deprecated.
boolean	getLogCredentialsUsage()
DescriptorExtensionList<AuditLogger,Descriptor<AuditLogger>>	getLoggerDescriptors()	Deprecated. as of 2.6
List<AuditLogger>	getLoggers()
String	getPattern()
void	onFinalized(AbstractBuild build)	Deprecated. as of 2.6
void	onFinalized(Run run)	Deprecated. as of 2.6
void	setDisplayUserName(boolean displayUserName)
void	setLogBuildCause(boolean logBuildCause)
void	setLogCredentialsUsage(boolean logCredentialsUsage)
void	setLoggers(List<AuditLogger> loggers)
void	setPattern(String pattern)
boolean	shouldDisplayUserName()
boolean	shouldLogBuildCause()
boolean	shouldLogCredentialsUsage()

Methods inherited from class jenkins.model.GlobalConfiguration

all, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditTrailPlugin

public AuditTrailPlugin()

Method Detail

getPattern

public String getPattern()

getLogBuildCause

@Deprecated
public boolean getLogBuildCause()

Deprecated.

shouldLogBuildCause

public boolean shouldLogBuildCause()

getLogCredentialsUsage

public boolean getLogCredentialsUsage()

shouldLogCredentialsUsage

public boolean shouldLogCredentialsUsage()

shouldDisplayUserName

public boolean shouldDisplayUserName()

getDisplayUserName

public boolean getDisplayUserName()

getLoggers

public List<AuditLogger> getLoggers()

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject formData)

Overrides:

configure in class GlobalConfiguration

setPattern

@DataBoundSetter
public void setPattern(String pattern)

setLogBuildCause

@DataBoundSetter
public void setLogBuildCause(boolean logBuildCause)

setLogCredentialsUsage

@DataBoundSetter
public void setLogCredentialsUsage(boolean logCredentialsUsage)

setDisplayUserName

@DataBoundSetter
public void setDisplayUserName(boolean displayUserName)

getLoggerDescriptors

@Deprecated
public DescriptorExtensionList<AuditLogger,Descriptor<AuditLogger>> getLoggerDescriptors()

Deprecated.

as of 2.6

setLoggers

@DataBoundSetter
public void setLoggers(List<AuditLogger> loggers)

onFinalized

@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@Deprecated
public void onFinalized(Run run)

Deprecated.

as of 2.6

onFinalized

@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
@Deprecated
public void onFinalized(AbstractBuild build)

Deprecated.

as of 2.6

doRegexCheck

public FormValidation doRegexCheck(@QueryParameter
                                   String value)
                            throws IOException,
                                   javax.servlet.ServletException

Validate regular expression syntax.

Throws:

IOException

javax.servlet.ServletException

getConfigFile

protected XmlFile getConfigFile()

Overrides:

getConfigFile in class Descriptor<GlobalConfiguration>