org.jenkins.ci.plugins.autorefresh
Class ConfigAutoRefresh

java.lang.Object
  hudson.model.Descriptor<hudson.model.PageDecorator>
      hudson.model.PageDecorator
          org.jenkins.ci.plugins.autorefresh.ConfigAutoRefresh

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.model.PageDecorator>, hudson.model.Saveable

@Extension
public final class ConfigAutoRefresh
extends hudson.model.PageDecorator

The Config AutoRefresh Plugin provides a way to configure the auto-refresh rate from the Jenkins UI.

Since:

0.1

Author:

Jesse Farinacci

Nested Class Summary

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

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

static java.lang.String

AUTO_REFRESH_SECONDS The system property which controls the meta refresh rate of automatic refresh pages.

Fields inherited from class hudson.model.PageDecorator

ALL

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

ConfigAutoRefresh()

Method Summary

boolean	configure(org.kohsuke.stapler.StaplerRequest request, net.sf.json.JSONObject jsonObject)
java.lang.String	getDisplayName()
int	getRefreshRate() Get the rate to refresh the page.
void	load()
void	setRefreshRate(int refreshRate) Set the rate to refresh the page.

Methods inherited from class hudson.model.PageDecorator

all, getDescriptor, getUrl

Methods inherited from class hudson.model.Descriptor

calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, getCheckUrl, getConfigPage, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getPropertyType, getPropertyType, getViewPage, isInstance, isSubTypeOf, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Field Detail

AUTO_REFRESH_SECONDS

public static final java.lang.String AUTO_REFRESH_SECONDS

The system property which controls the meta refresh rate of automatic refresh pages.

See Also:

System.getProperty(String), Constant Field Values

Constructor Detail

ConfigAutoRefresh

@DataBoundConstructor
public ConfigAutoRefresh()

Method Detail

getRefreshRate

public int getRefreshRate()

Get the rate to refresh the page.

Returns:

the rate to refresh the page

setRefreshRate

public void setRefreshRate(int refreshRate)

Set the rate to refresh the page.

Parameters:

refreshRate - the rate to refresh the page

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest request,
                         net.sf.json.JSONObject jsonObject)

Overrides:

configure in class hudson.model.Descriptor<hudson.model.PageDecorator>

getDisplayName

public java.lang.String getDisplayName()

Overrides:

getDisplayName in class hudson.model.PageDecorator

load

public void load()

Overrides:

load in class hudson.model.Descriptor<hudson.model.PageDecorator>