org.jenkinsci.plugins.diagnostics.diagnostics

Class Diagnostic

java.lang.Object

hudson.model.AbstractDescribableImpl<Diagnostic>

org.jenkinsci.plugins.diagnostics.diagnostics.Diagnostic

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<Diagnostic>, Serializable

Direct Known Subclasses:

DefaultDiagnostic

public abstract class Diagnostic
extends hudson.model.AbstractDescribableImpl<Diagnostic>
implements hudson.ExtensionPoint, Serializable

Extension point that allows the creation of new diagnostics.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
Diagnostic() Creates a diagnostic
Diagnostic(int initialDelay, int period, int runs) Creates a diagnostic

Method Summary

Modifier and Type	Method and Description
void	afterExecutionFinished(DiagnosticsContainer result) Called when all the executions have been completed or the diagnostics session has been canceled.
static hudson.DescriptorExtensionList<Diagnostic,DiagnosticDescriptor<?>>	all() All the registered DiagnosticDescriptors.
void	beforeExecutionStart(DiagnosticsContainer result) Called before the first execution of the first run of this diagnostic.
boolean	equals(Object obj)
DiagnosticDescriptor<?>	getDescriptor()
abstract String	getFileName() Name used for the folder and files to be created.
String	getId() By default, the Class.getName() of the component implementation
int	getInitialDelay() Indicates the number milliseconds to delay the first execution
int	getPeriod() The period to wait between successive executions in milliseconds
int	getRuns() Number of times this diagnostic should be executed on the diagnostic session
int	hashCode()
abstract void	runDiagnostic(DiagnosticsContainer result, int run) Executes the diagnostic
void	setInitialDelay(int initialDelay) Sets the number milliseconds to delay the first execution
void	setPeriod(int period) Sets the period to wait between successive executions in milliseconds
void	setRuns(int runs) Sets the number of times this diagnostic should be executed on the diagnostic session

Methods inherited from class java.lang.Object

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

Constructor Detail

Diagnostic

public Diagnostic()

Creates a diagnostic

Diagnostic

public Diagnostic(int initialDelay,
                  int period,
                  int runs)

Creates a diagnostic

Parameters:

initialDelay - number milliseconds to delay the first execution

period - period to wait between successive executions in milliseconds

runs - number of times this diagnostic should be executed on the diagnostic session

Method Detail

setInitialDelay

public void setInitialDelay(int initialDelay)

Sets the number milliseconds to delay the first execution

Parameters:

initialDelay - milliseconds to delay the first execution

getInitialDelay

public int getInitialDelay()

Indicates the number milliseconds to delay the first execution

Returns:

the time to delay first execution in milliseconds

setPeriod

public void setPeriod(int period)

Sets the period to wait between successive executions in milliseconds

Parameters:

period - to wait between successive executions in milliseconds

getPeriod

public int getPeriod()

The period to wait between successive executions in milliseconds

Returns:

the period between successive executions in milliseconds

setRuns

public void setRuns(int runs)

Sets the number of times this diagnostic should be executed on the diagnostic session

Parameters:

runs - number of times this diagnostic should be executed on the diagnostic session

getRuns

public int getRuns()

Number of times this diagnostic should be executed on the diagnostic session

Returns:

the number of times to execute the diagnose

getId

@Nonnull
public String getId()

By default, the Class.getName() of the component implementation

Returns:

the id for this diagnostic

getFileName

@Nonnull
public abstract String getFileName()

Name used for the folder and files to be created. When creating multiple files some information will be post-pended to it.

Returns:

the simple name

runDiagnostic

public abstract void runDiagnostic(@Nonnull
                                   DiagnosticsContainer result,
                                   int run)
                            throws IOException

Executes the diagnostic

Parameters:

result - DiagnosticsContainer where the diagnostic should write the results

run - execution number of this call

Throws:

IOException - thrown when there is a problem executing the diagnostic

beforeExecutionStart

public void beforeExecutionStart(DiagnosticsContainer result)
                          throws IOException

Called before the first execution of the first run of this diagnostic. Can be used to initialize resources, create content, etc.

Parameters:

result - the DiagnosticsContainer to store the result to

Throws:

IOException - thrown when there is a problem executing the diagnostic

afterExecutionFinished

public void afterExecutionFinished(@Nonnull
                                   DiagnosticsContainer result)
                            throws IOException

Called when all the executions have been completed or the diagnostics session has been canceled. Can be used to clean up any open resources and include additional information to the container like manifest data, etc.

Parameters:

result - the DiagnosticsContainer to store the result to

Throws:

IOException - thrown when there is a problem executing the diagnostic

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getDescriptor

public DiagnosticDescriptor<?> getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<Diagnostic>

Overrides:

getDescriptor in class hudson.model.AbstractDescribableImpl<Diagnostic>

all

@Nonnull
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static hudson.DescriptorExtensionList<Diagnostic,DiagnosticDescriptor<?>> all()

All the registered DiagnosticDescriptors.

Returns:

All the registered DiagnosticDescriptors.