Package org.graylog2.plugin.configuration

Class ConfigurationRequest

java.lang.Object

org.graylog2.plugin.configuration.ConfigurationRequest

public class ConfigurationRequest
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfigurationRequest.Templates

Constructor Summary

Constructors

Constructor	Description
ConfigurationRequest()

Method Summary

Modifier and Type	Method	Description
void	addField(ConfigurationField f)
void	addFields(List<ConfigurationField> fields)
Map<String,Map<String,Object>>	asList()
void	check(Configuration configuration)
boolean	containsField(String fieldName)
static ConfigurationRequest	createWithFields(ConfigurationField... fields)
Configuration	filter(Configuration config)	Creates a new configuration object containing only the fields specified in this request object.
ConfigurationField	getField(String fieldName)
Map<String,ConfigurationField>	getFields()
void	putAll(Map<String,ConfigurationField> fields)
boolean	removeField(String fieldName)	Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigurationRequest

public ConfigurationRequest()

Method Details

putAll

public void putAll(Map<String,ConfigurationField> fields)

addField

public void addField(ConfigurationField f)

addFields

public void addFields(List<ConfigurationField> fields)

containsField

public boolean containsField(String fieldName)

getField

public ConfigurationField getField(String fieldName)

getFields

public Map<String,ConfigurationField> getFields()

removeField

@Deprecated
public boolean removeField(String fieldName)

Deprecated.

createWithFields

public static ConfigurationRequest createWithFields(ConfigurationField... fields)

asList

public Map<String,Map<String,Object>> asList()

check

public void check(Configuration configuration)
           throws ConfigurationException

Throws:

ConfigurationException

filter

@Nonnull
public Configuration filter(Configuration config)

Creates a new configuration object containing only the fields specified in this request object.

Parameters:

config - original Configuration

Returns:

filtered Configuration, not null but might be empty