com.adobe.dx.xeng.cortexmetrics.config

Class CortexMetricsGlobalConfig

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

com.adobe.dx.xeng.cortexmetrics.config.CortexMetricsGlobalConfig

All Implemented Interfaces:

ExtensionPoint, Describable<GlobalConfiguration>, Saveable, OnMaster

@Extension
public class CortexMetricsGlobalConfig
extends GlobalConfiguration

Stores the global configuration options.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CortexMetricsGlobalConfig.GlobalCortexMetricsConfigProvider Provider for global configuration.

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 and Description
static String	DEFAULT_NAMESPACE

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
CortexMetricsGlobalConfig() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
static CortexMetricsGlobalConfig	get() Retrieve the global configuration instance.
Secret	getBearerToken() Get the bearer token used to authenticate to Cortex.
String	getNamespace() Get the namespace for metric names (the first token in each metric sent to Cortex).
String	getUrl() Get the URL for publishing metrics to Cortex.
void	setBearerToken(Secret bearerToken) Set the bearer token used to authenticate to Cortex.
void	setNamespace(String namespace) Set the namespace for metric names.
void	setUrl(String url) Set the URL for publishing metrics to Cortex.

Methods inherited from class jenkins.model.GlobalConfiguration

all, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

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

Field Detail

DEFAULT_NAMESPACE

public static final String DEFAULT_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

CortexMetricsGlobalConfig

public CortexMetricsGlobalConfig()

Constructor.

Method Detail

getUrl

public String getUrl()

Get the URL for publishing metrics to Cortex.

Returns:

the Cortex write URL

setUrl

@DataBoundSetter
public void setUrl(String url)

Set the URL for publishing metrics to Cortex.

Parameters:

url - the Cortex write URL

getBearerToken

public Secret getBearerToken()

Get the bearer token used to authenticate to Cortex.

Returns:

the bearer token for authentication

setBearerToken

@DataBoundSetter
public void setBearerToken(Secret bearerToken)

Set the bearer token used to authenticate to Cortex.

Parameters:

bearerToken - the bearer token for authentication

getNamespace

public String getNamespace()

Get the namespace for metric names (the first token in each metric sent to Cortex).

Returns:

the namespace

setNamespace

@DataBoundSetter
public void setNamespace(String namespace)

Set the namespace for metric names.

Parameters:

namespace - the namespace

get

public static CortexMetricsGlobalConfig get()

Retrieve the global configuration instance.

Returns:

the global configuration

configure

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

Overrides:

configure in class GlobalConfiguration

Throws:

Descriptor.FormException