Package jenkins.telemetry.impl

Class PasswordMasking

java.lang.Object

jenkins.telemetry.Telemetry

jenkins.telemetry.impl.PasswordMasking

All Implemented Interfaces:

ExtensionPoint

@Extension
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class PasswordMasking
extends Telemetry

Telemetry implementation gathering information about password field masking.

Nested Class Summary

Nested classes/interfaces inherited from class jenkins.telemetry.Telemetry

Telemetry.TelemetryReporter

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
PasswordMasking()

Method Summary

Modifier and Type	Method	Description
net.sf.json.JSONObject	createContent()	Returns the content to be sent to the telemetry service.
String	getDisplayName()	User friendly display name for this telemetry collector, ideally localized.
LocalDate	getEnd()	End date for the collection.
LocalDate	getStart()	Start date for the collection.
static void	recordMasking(String className, String closestAncestor, String jellyView)	Records when password masking occurs.

Methods inherited from class jenkins.telemetry.Telemetry

all, buildComponentInformation, getId, isActivePeriod, isAnyTrialActive, isDisabled

Methods inherited from class java.lang.Object

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

Constructor Details

PasswordMasking

public PasswordMasking()

Method Details

recordMasking

public static void recordMasking(String className,
 String closestAncestor,
 String jellyView)

Records when password masking occurs.

Parameters:

className - the class name of the object

closestAncestor - the closest ancestor class name

jellyView - the Jelly view where masking occurred

getDisplayName

@NonNull
public String getDisplayName()

Description copied from class: Telemetry

User friendly display name for this telemetry collector, ideally localized.

Specified by:

getDisplayName in class Telemetry

Returns:

display name, never null or empty

getStart

@NonNull
public LocalDate getStart()

Description copied from class: Telemetry

Start date for the collection. Will be checked in Jenkins to not collect outside the defined time span. This does not have to be precise enough for time zones to be a consideration.

Specified by:

getStart in class Telemetry

Returns:

collection start date

getEnd

@NonNull
public LocalDate getEnd()

Description copied from class: Telemetry

End date for the collection. Will be checked in Jenkins to not collect outside the defined time span. This does not have to be precise enough for time zones to be a consideration.

Specified by:

getEnd in class Telemetry

Returns:

collection end date

createContent

public net.sf.json.JSONObject createContent()

Description copied from class: Telemetry

Returns the content to be sent to the telemetry service. This method is called periodically, once per content submission.

Specified by:

createContent in class Telemetry

Returns:

The JSON payload, or null if no content should be submitted.