jenkins.metrics.api

Class MetricsAccessKey.AbstractProvider

java.lang.Object

jenkins.metrics.api.MetricsAccessKey.AbstractProvider

All Implemented Interfaces:

hudson.ExtensionPoint, Serializable, MetricsAccessKey.Provider

Direct Known Subclasses:

MetricsAccessKey.FixedListProviderImpl

Enclosing class:

MetricsAccessKey

public abstract static class MetricsAccessKey.AbstractProvider
extends Object
implements MetricsAccessKey.Provider

An extension point that allows for plugins to provide their own set of access keys.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
MetricsAccessKey.AbstractProvider()

Method Summary

Methods

Modifier and Type	Method and Description
MetricsAccessKey	getAccessKey(String accessKey) Returns the definition of the specific access key.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jenkins.metrics.api.MetricsAccessKey.Provider

getAccessKeys

Constructor Detail

MetricsAccessKey.AbstractProvider

public MetricsAccessKey.AbstractProvider()

Method Detail

getAccessKey

@CheckForNull
public MetricsAccessKey getAccessKey(String accessKey)

Returns the definition of the specific access key. Note that all entries in MetricsAccessKey.Provider.getAccessKeys() must be returned by this method, but it may also return additional entries.

Specified by:

getAccessKey in interface MetricsAccessKey.Provider

Parameters:

accessKey - the access key to retrieve.

Returns:

the access key.