Package io.jenkins.plugins.cloudaeye

Class CloudAEyeGlobalKeyConfiguration

java.lang.Object

hudson.model.Descriptor<GlobalConfiguration>

jenkins.model.GlobalConfiguration

io.jenkins.plugins.cloudaeye.CloudAEyeGlobalKeyConfiguration

All Implemented Interfaces:

ExtensionPoint, Describable<GlobalConfiguration>, Saveable, Loadable, OnMaster

@Extension
public class CloudAEyeGlobalKeyConfiguration
extends GlobalConfiguration

Handles the global key configuration for the plugin

Nested Class Summary

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 inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
CloudAEyeGlobalKeyConfiguration()

Method Summary

Modifier and Type	Method	Description
FormValidation	doCheckTenantKey(String tenantKey)	Validates the tenantKey
FormValidation	doCheckToken(String token)
FormValidation	doTestConnection(Secret tenantKey, Secret token)	Makes a dynamic ping to test the connectivity with the CloudAEye webhook
static CloudAEyeGlobalKeyConfiguration	get()
Secret	getTenantKey()
Secret	getToken()
void	setTenantKey(Secret tenantKey)
void	setToken(Secret token)

Methods inherited from class jenkins.model.GlobalConfiguration

all, configure, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, 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, getRequiredGlobalConfigPagePermission, 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

Constructor Details

CloudAEyeGlobalKeyConfiguration

public CloudAEyeGlobalKeyConfiguration()

Method Details

get

public static CloudAEyeGlobalKeyConfiguration get()

Returns:

the singleton instance

getTenantKey

public Secret getTenantKey()

setTenantKey

@DataBoundSetter
public void setTenantKey(Secret tenantKey)

getToken

public Secret getToken()

setToken

@DataBoundSetter
public void setToken(Secret token)

doCheckTenantKey

public FormValidation doCheckTenantKey(@QueryParameter
 String tenantKey)

Validates the tenantKey

Parameters:

tenantKey - CloudAEye webhook tenantKey

Returns:

Valid form

doCheckToken

public FormValidation doCheckToken(@QueryParameter
 String token)

doTestConnection

@POST
public FormValidation doTestConnection(@QueryParameter("tenantKey")
 Secret tenantKey,
 @QueryParameter("token")
 Secret token)
                                throws IOException,
javax.servlet.ServletException

Makes a dynamic ping to test the connectivity with the CloudAEye webhook

Parameters:

tenantKey - Unique key assigned to the tenant

token - Secret token

Returns:

A valid/invalid form response

Throws:

IOException

javax.servlet.ServletException