Package hudson.model

Class UsageStatistics

java.lang.Object

hudson.model.Descriptor<PageDecorator>

hudson.model.PageDecorator

hudson.model.UsageStatistics

All Implemented Interfaces:

ExtensionPoint, Describable<PageDecorator>, PersistentDescriptor, Saveable, Loadable, OnMaster

@Extension
public class UsageStatistics
extends PageDecorator
implements PersistentDescriptor

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UsageStatistics.CombinedCipherInputStream	The opposite of the UsageStatistics.CombinedCipherOutputStream.
static final class	UsageStatistics.CombinedCipherOutputStream	Asymmetric cipher is slow and in case of Sun RSA implementation it can only encrypt the first block.

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

Modifier and Type	Field	Description
static boolean	DISABLED

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

Constructors

Constructor	Description
UsageStatistics()
UsageStatistics(String keyImage)	Creates an instance with a specific public key image.

Method Summary

Modifier and Type	Method	Description
boolean	configure(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject json)	Invoked when the global configuration page is submitted.
Permission	getRequiredGlobalConfigPagePermission()	Returns the permission type needed in order to access the Descriptor.getGlobalConfigPage() for this descriptor.
String	getStatData()	Gets the encrypted usage stat data to be sent to the Hudson server.
boolean	isDue()	Returns true if it's time for us to check for new version.
static boolean	isEnabled()	Returns whether between UI configuration, system property, and environment, usage statistics should be submitted.

Methods inherited from class hudson.model.PageDecorator

all, getDescriptor, getUrl

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, 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

Methods inherited from interface hudson.model.PersistentDescriptor

load

Methods inherited from interface hudson.model.Saveable

save

Field Details

DISABLED

public static boolean DISABLED

Constructor Details

UsageStatistics

public UsageStatistics()

UsageStatistics

public UsageStatistics(String keyImage)

Creates an instance with a specific public key image.

Method Details

isDue

public boolean isDue()

Returns true if it's time for us to check for new version.

isEnabled

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static boolean isEnabled()

Returns whether between UI configuration, system property, and environment, usage statistics should be submitted.

Returns:

true if and only if usage stats should be submitted

Since:

TODO

getStatData

public String getStatData()
                   throws IOException

Gets the encrypted usage stat data to be sent to the Hudson server. Used exclusively by jelly: resources/hudson/model/UsageStatistics/footer.jelly

Throws:

IOException

getRequiredGlobalConfigPagePermission

@NonNull
public Permission getRequiredGlobalConfigPagePermission()

Description copied from class: Descriptor

Returns the permission type needed in order to access the Descriptor.getGlobalConfigPage() for this descriptor. By default, requires Jenkins.ADMINISTER permission. For now this only applies to descriptors configured through the global (GlobalConfigurationCategory.Unclassified) configuration. Override to return something different if appropriate. The only currently supported alternative return value is Jenkins.MANAGE.

Overrides:

getRequiredGlobalConfigPagePermission in class Descriptor<PageDecorator>

Returns:

Permission required to globally configure this descriptor.

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest2 req,
 net.sf.json.JSONObject json)
                  throws Descriptor.FormException

Description copied from class: Descriptor

Invoked when the global configuration page is submitted. Can be overridden to store descriptor-specific information.

Overrides:

configure in class Descriptor<PageDecorator>

Parameters:

json - The JSON object that captures the configuration data for this Descriptor. See the developer documentation.

Returns:

false to keep the client in the same config page.

Throws:

Descriptor.FormException