Package com.nimbusds.common.config

Class MonitorConfiguration

java.lang.Object

com.nimbusds.common.config.MonitorConfiguration

All Implemented Interfaces:

LoggableConfiguration

@Immutable
public final class MonitorConfiguration
extends Object
implements LoggableConfiguration

DropWizard metrics configuration. System property override is enabled.

The configuration is stored as public fields which become immutable (final) after their initialisation.

Property keys: monitor.*

Example properties:

 monitor.entryCountCacheTimeout=1800
 monitor.enableJMX=true
 monitor.graphite.enable=true
 monitor.graphite.host=carbon.server.com
 monitor.graphite.port=2003
 monitor.graphite.reportInterval=60
 monitor.graphite.batchSize=100
 monitor.graphite.prefix=
 monitor.graphite.ratesTimeUnit=SECONDS
 monitor.graphite.durationsTimeUnit=MILLISECONDS
 monitor.graphite.filter.1=authzStore.ldapConnector.*
 monitor.graphite.filter.2=tokenEndpoint.code.*
 monitor.graphite.filter.3=tokenEndpoint.refreshToken.*
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MonitorConfiguration.Graphite	Graphite reporting configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static long	DEFAULT_ENTRY_COUNT_CACHE_TIMEOUT	The default entry count cache timeout (30 minutes).
boolean	enableJMX	Enables / disables JMX reporting.
long	entryCountCacheTimeout	Timeout for caching entry count results, in seconds.
MonitorConfiguration.Graphite	graphite	The Graphite reporting configuration.
static String	PREFIX	The prefix for the property names.

Fields inherited from interface com.nimbusds.common.config.LoggableConfiguration

LOG_CATEGORY

Constructor Summary

Constructors

Constructor	Description
MonitorConfiguration(Properties props)	Creates a new monitoring configuration from the specified properties.

Method Summary

Modifier and Type	Method	Description
void	log()	Logs the configuration details at INFO level.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final String PREFIX

The prefix for the property names.

See Also:

Constant Field Values

DEFAULT_ENTRY_COUNT_CACHE_TIMEOUT

public static final long DEFAULT_ENTRY_COUNT_CACHE_TIMEOUT

The default entry count cache timeout (30 minutes).

See Also:

Constant Field Values

entryCountCacheTimeout

public final long entryCountCacheTimeout

Timeout for caching entry count results, in seconds. Zero means no caching, negative disabled readings.

enableJMX

public final boolean enableJMX

Enables / disables JMX reporting.

graphite

public final MonitorConfiguration.Graphite graphite

The Graphite reporting configuration.

Constructor Detail

MonitorConfiguration

public MonitorConfiguration(Properties props)
                     throws ConfigurationException

Creates a new monitoring configuration from the specified properties.

Parameters:

props - The properties. Must not be null.

Throws:

ConfigurationException - On a missing or invalid property.

Method Detail

log

public void log()

Logs the configuration details at INFO level.

Specified by:

log in interface LoggableConfiguration