com.splunk
Class ConfCollection

java.lang.Object
  extended by com.splunk.Resource
      extended by com.splunk.ResourceCollection<EntityCollection<Entity>>
          extended by com.splunk.ConfCollection
All Implemented Interfaces:
java.util.Map<java.lang.String,EntityCollection<Entity>>

public class ConfCollection
extends ResourceCollection<EntityCollection<Entity>>

The ConfCollection class represents a collection of configuration files.


Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Field Summary
 
Fields inherited from class com.splunk.ResourceCollection
itemClass, items
 
Fields inherited from class com.splunk.Resource
actions, path, refreshArgs, service, title
 
Method Summary
 EntityCollection<Entity> create(java.lang.String name)
          Creates a new stanza in the current configuration file.
 EntityCollection<Entity> create(java.lang.String name, java.util.Map args)
          Creates a new stanza in the current configuration file with attributes.
protected  java.lang.String itemPath(AtomEntry entry)
          Returns the endpoint path for this configuration stanza.
 
Methods inherited from class com.splunk.ResourceCollection
clear, containsKey, containsKey, containsValue, createItem, createItem, entrySet, equals, get, get, hashCode, isEmpty, itemKey, keySet, list, put, putAll, refresh, remove, size, validate, values, valueSize
 
Methods inherited from class com.splunk.Resource
getName, getPath, getService, getTitle, invalidate
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

create

public EntityCollection<Entity> create(java.lang.String name)
Creates a new stanza in the current configuration file.

Parameters:
name - The name of the stanza to create.
Returns:
The name of the new stanza.

create

public EntityCollection<Entity> create(java.lang.String name,
                                       java.util.Map args)
Creates a new stanza in the current configuration file with attributes.

Parameters:
name - The name of the stanza to create.
args - Optional. A set of attributes as key-value pairs to put in the new stanza.
Returns:
The name of the new stanza.

itemPath

protected java.lang.String itemPath(AtomEntry entry)
Returns the endpoint path for this configuration stanza.

Overrides:
itemPath in class ResourceCollection<EntityCollection<Entity>>
Parameters:
entry - The AtomEntry representation of this entry.
Returns:
This stanza's endpoint path in the format "/servicesNS/{user}/{app}/configs/conf-{file}/{stanza}".