Package io.jenkins.plugins.monitoring

Class MonitorConfigurationProperty

java.lang.Object

hudson.model.UserProperty

io.jenkins.plugins.monitoring.MonitorConfigurationProperty

All Implemented Interfaces:

ExtensionPoint, Describable<UserProperty>, ReconfigurableDescribable<UserProperty>, Saveable

public class MonitorConfigurationProperty
extends UserProperty
implements Saveable

A UserProperty to store the json configuration per user as property.

Author:

Simon Symhoven

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MonitorConfigurationProperty.MonitorConfiguration	The property class to store.
static class	MonitorConfigurationProperty.MonitorPropertyDescriptor	A UserPropertyDescriptor for the MonitorConfigurationProperty.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_ID	The id for the default configuration.

Fields inherited from class hudson.model.UserProperty

user

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
MonitorConfigurationProperty(List<MonitorConfigurationProperty.MonitorConfiguration> configurations)	Creates a new MonitorConfigurationProperty.

Method Summary

Modifier and Type	Method	Description
void	createOrUpdateConfiguration(String id, String config)	Updates an existing MonitorConfigurationProperty.MonitorConfiguration.
static Optional<MonitorConfigurationProperty>	forCurrentUser()	Gets the MonitorConfigurationProperty for current user.
MonitorConfigurationProperty.MonitorConfiguration	getConfiguration(String id)	Get a MonitorConfigurationProperty.MonitorConfiguration by its id.
Collection<MonitorConfigurationProperty.MonitorConfiguration>	getConfigurations()
void	removeConfiguration(String id)	Removes a configuration from configurations list.
void	save()

Methods inherited from class hudson.model.UserProperty

all, getDescriptor, reconfigure, setUser

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ID

public static final String DEFAULT_ID

The id for the default configuration.

See Also:

Constant Field Values

Constructor Detail

MonitorConfigurationProperty

public MonitorConfigurationProperty(List<MonitorConfigurationProperty.MonitorConfiguration> configurations)

Creates a new MonitorConfigurationProperty.

Parameters:

configurations - the list of configurations to add to the MonitorConfigurationProperty.

Method Detail

getConfigurations

public Collection<MonitorConfigurationProperty.MonitorConfiguration> getConfigurations()

getConfiguration

public MonitorConfigurationProperty.MonitorConfiguration getConfiguration(String id)

Get a MonitorConfigurationProperty.MonitorConfiguration by its id.

Parameters:

id - the id of the MonitorConfigurationProperty.MonitorConfiguration to get.

Returns:

the MonitorConfigurationProperty.MonitorConfiguration or default if id does not exist on MonitorConfigurationProperty.

createOrUpdateConfiguration

public void createOrUpdateConfiguration(String id,
                                        String config)

Updates an existing MonitorConfigurationProperty.MonitorConfiguration.

Parameters:

id - the id of the MonitorConfigurationProperty.MonitorConfiguration to update.

config - the config string to update.

removeConfiguration

public void removeConfiguration(String id)

Removes a configuration from configurations list.

Parameters:

id - the id of configuration to remove.

forCurrentUser

public static Optional<MonitorConfigurationProperty> forCurrentUser()

Gets the MonitorConfigurationProperty for current user.

Returns:

the MonitorConfigurationProperty as Optional.

save

public void save()

Specified by:

save in interface Saveable