Package jenkins.management

Class AsynchronousAdministrativeMonitor

java.lang.Object

hudson.model.AbstractModelObject

hudson.model.AdministrativeMonitor

jenkins.management.AsynchronousAdministrativeMonitor

All Implemented Interfaces:

ExtensionPoint, ModelObject, SearchableModelObject, SearchItem, org.kohsuke.stapler.StaplerProxy

Direct Known Subclasses:

RekeySecretAdminMonitor

public abstract class AsynchronousAdministrativeMonitor
extends AdministrativeMonitor

Convenient partial implementation of AdministrativeMonitor that involves a background "fixing" action once the user opts in for the execution of it.

A subclass defines what that background fixing actually does in fix(TaskListener). The logging output from it gets persisted, and this class provides a "/log" view that allows the administrator to monitor its progress.

See RekeySecretAdminMonitor for an example of how to subtype this class.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AsynchronousAdministrativeMonitor.FixThread

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.AdministrativeMonitor

id

Constructor Summary

Constructors

Constructor	Description
AsynchronousAdministrativeMonitor()

Method Summary

Modifier and Type	Method	Description
protected abstract void	fix(TaskListener listener)	Run on a separate thread in the background to fix up stuff.
protected File	getBaseDir()
abstract String	getDisplayName()
protected File	getLogFile()	Rewrite log file.
AnnotatedLargeText	getLogText()	Used to URL-bind AnnotatedLargeText.
boolean	isFixingActive()	Is there an active execution process going on?
protected Thread	start(boolean forceRestart)	Starts the background fixing activity.

Methods inherited from class hudson.model.AdministrativeMonitor

all, checkRequiredPermission, disable, doDisable, getRequiredPermission, getSearchUrl, getTarget, getUrl, hasPermissionToDisplay, hasRequiredPermission, isActivated, isEnabled, isSecurity

Methods inherited from class hudson.model.AbstractModelObject

getSearch, getSearchIndex, getSearchName, makeSearchIndex, requirePOST, sendError, sendError, sendError, sendError, sendError

Methods inherited from class java.lang.Object

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

Constructor Details

AsynchronousAdministrativeMonitor

public AsynchronousAdministrativeMonitor()

Method Details

isFixingActive

public boolean isFixingActive()

Is there an active execution process going on?

getLogText

public AnnotatedLargeText getLogText()

Used to URL-bind AnnotatedLargeText.

getLogFile

protected File getLogFile()

Rewrite log file.

getBaseDir

protected File getBaseDir()

getDisplayName

public abstract String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

Overrides:

getDisplayName in class AdministrativeMonitor

start

protected Thread start(boolean forceRestart)

Starts the background fixing activity.

Parameters:

forceRestart - If true, any ongoing fixing activity gets interrupted and the new one starts right away.

fix

protected abstract void fix(TaskListener listener)
                     throws Exception

Run on a separate thread in the background to fix up stuff.

Throws:

Exception