Package jenkins.metrics.api

Class MetricsAccessKey

java.lang.Object

hudson.model.AbstractDescribableImpl<MetricsAccessKey>

jenkins.metrics.api.MetricsAccessKey

All Implemented Interfaces:

Describable<MetricsAccessKey>, Serializable

public class MetricsAccessKey
extends AbstractDescribableImpl<MetricsAccessKey>
implements Serializable

Author:

Stephen Connolly

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricsAccessKey.AbstractProvider	An extension point that allows for plugins to provide their own set of access keys.
static class	MetricsAccessKey.DescriptorImpl
static class	MetricsAccessKey.FixedListProviderImpl	A provider that is a simple fixed list of keys.
static interface	MetricsAccessKey.Provider	An extension point that allows for plugins to provide their own set of access keys.

Constructor Summary

Constructors

Constructor	Description
MetricsAccessKey(String description, Secret key, boolean canPing, boolean canThreadDump, boolean canHealthCheck, boolean canMetrics, String origins)
MetricsAccessKey(String description, String key)
MetricsAccessKey(String description, String key, boolean canPing, boolean canThreadDump, boolean canHealthCheck, boolean canMetrics, String origins)	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDescription()
Secret	getKey()
String	getOrigins()
int	hashCode()
boolean	isCanHealthCheck()
boolean	isCanMetrics()
boolean	isCanPing()
boolean	isCanThreadDump()
boolean	isOriginAllowed(String origin)
String	toString()

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

MetricsAccessKey

public MetricsAccessKey(String description,
 String key)

MetricsAccessKey

@Deprecated
public MetricsAccessKey(String description,
 String key,
 boolean canPing,
 boolean canThreadDump,
 boolean canHealthCheck,
 boolean canMetrics,
 String origins)

Deprecated.

MetricsAccessKey

@DataBoundConstructor
public MetricsAccessKey(String description,
 Secret key,
 boolean canPing,
 boolean canThreadDump,
 boolean canHealthCheck,
 boolean canMetrics,
 String origins)

Method Details

getDescription

@CheckForNull
public String getDescription()

getKey

@NonNull
public Secret getKey()

isCanPing

public boolean isCanPing()

isCanThreadDump

public boolean isCanThreadDump()

isCanHealthCheck

public boolean isCanHealthCheck()

isCanMetrics

public boolean isCanMetrics()

getOrigins

public String getOrigins()

isOriginAllowed

public boolean isOriginAllowed(String origin)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object