com.splunk

Class WindowsRegistryInput

java.lang.Object

com.splunk.Resource

com.splunk.Entity

com.splunk.Input

com.splunk.WindowsRegistryInput

All Implemented Interfaces:

Map<String,Object>

public class WindowsRegistryInput
extends Input

The WindowsRegistryInput class represents a Windows Registry data input.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.splunk.Entity

content, toUpdate

Fields inherited from class com.splunk.Resource

actions, path, refreshArgs, service, title, updated

Method Summary

Modifier and Type	Method and Description
boolean	getBaseline() Indicates whether this Windows Registry input has an established baseline.
String	getHive() Returns the hive name to monitor for this Windows Registry input.
String	getIndex() Returns the index name for this Windows Registry input.
InputKind	getKind() Returns the input kind for this input.
boolean	getMonitorSubnodes() Indicates whether this Windows Registry input monitors all sub-nodes under a given hive.
String	getProc() Returns the regular expression (regex) that is compared to process names when including or excluding events for this Windows Registry input.
String[]	getType() Returns the regular expressions (regexes) that are compared to registry event types for this Windows Registry input.
void	setBaseline(boolean baseline) Sets whether to establish a baseline value for the registry keys.
void	setDisabled(boolean disabled) Sets whether this input is enabled or disabled.
void	setHive(String hive) Sets the registry hive under which to monitor for changes.
void	setIndex(String index) Sets the index in which to store all generated events.
void	setMonitorSubnodes(boolean monitorSubnodes) Sets whether to monitor the subnodes of the given registry hive.
void	setProc(String proc) Sets the regular expression (regex) that is compared to process names when including or excluding events for this Windows Registry input.
void	setType(String[] regexes) Sets the regular expressions (regexes) that are compared to registry event types for this Windows Registry input.
void	update() Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.
void	update(Map<String,Object> args) Updates the entity with the values you previously set using the setter methods, and any additional specified arguments.

Methods inherited from class com.splunk.Entity

actionPath, clear, containsKey, containsValue, disable, enable, entrySet, get, getContent, getMetadata, isDisabled, isEmpty, isNameChangeAllowed, keySet, put, putAll, refresh, remove, remove, size, validate, values

Methods inherited from class com.splunk.Resource

getName, getPath, getService, getTitle, getUpdated, invalidate

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Detail

getBaseline

public boolean getBaseline()

Indicates whether this Windows Registry input has an established baseline.

Returns:

true if this Windows Registry input has an established baseline, false if not.

getProc

public String getProc()

Returns the regular expression (regex) that is compared to process names when including or excluding events for this Windows Registry input. Changes are only collected if a process name matches this regex.

Returns:

The process names regex.

getHive

public String getHive()

Returns the hive name to monitor for this Windows Registry input.

Returns:

The hive name to monitor.

getIndex

public String getIndex()

Returns the index name for this Windows Registry input.

Returns:

The index name.

getKind

public InputKind getKind()

Returns the input kind for this input.

Overrides:

getKind in class Input

Returns:

The input kind.

getMonitorSubnodes

public boolean getMonitorSubnodes()

Indicates whether this Windows Registry input monitors all sub-nodes under a given hive.

Returns:

true if this Windows Registry input monitors all sub-nodes under a given hive, false if not.

getType

public String[] getType()

Returns the regular expressions (regexes) that are compared to registry event types for this Windows Registry input. Only types that match at least one of the regexes are monitored.

Returns:

An array of regex strings for event types.

setBaseline

public void setBaseline(boolean baseline)

Sets whether to establish a baseline value for the registry keys.

Parameters:

baseline - true to establish a baseline value, false if not.

setDisabled

public void setDisabled(boolean disabled)

Sets whether this input is enabled or disabled.

Note: Using this method requires you to restart Splunk before this setting takes effect. To avoid restarting Splunk, use the Entity.disable and Entity.enable methods instead, which take effect immediately.

Parameters:

disabled - true to disable this input, false to enable it.

setHive

public void setHive(String hive)

Sets the registry hive under which to monitor for changes.

Parameters:

hive - The registry hive.

setIndex

public void setIndex(String index)

Sets the index in which to store all generated events.

Parameters:

index - The index name.

setMonitorSubnodes

public void setMonitorSubnodes(boolean monitorSubnodes)

Sets whether to monitor the subnodes of the given registry hive.

Parameters:

monitorSubnodes - true for this Windows Registry input to monitor all sub-nodes, false if not.

setProc

public void setProc(String proc)

Sets the regular expression (regex) that is compared to process names when including or excluding events for this Windows Registry input. Changes are only collected if a process name matches this regex.

Parameters:

proc - The process names regex.

setType

public void setType(String[] regexes)

Sets the regular expressions (regexes) that are compared to registry event types for this Windows Registry input. Only types that match at least one regex are monitored.

Parameters:

regexes - An array of regex strings for event types.

update

public void update(Map<String,Object> args)

Updates the entity with the values you previously set using the setter methods, and any additional specified arguments. The specified arguments take precedent over the values that were set using the setter methods.

Overrides:

update in class Entity

Parameters:

args - The arguments to update.

update

public void update()

Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.

Overrides:

update in class Entity