com.splunk
Class PasswordCollection

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

public class PasswordCollection
extends EntityCollection<Password>

The PasswordCollection class represents a collection of credentials.


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
 Password create(java.lang.String name, java.lang.String password)
          Creates a credential with a username and password.
 Password create(java.lang.String name, java.lang.String password, java.lang.String realm)
          Creates a credential with a username, password, and realm.
protected  java.lang.String itemKey(AtomEntry entry)
          Returns the username for a credential.
 
Methods inherited from class com.splunk.EntityCollection
create, create, remove, remove
 
Methods inherited from class com.splunk.ResourceCollection
clear, containsKey, containsKey, containsValue, createItem, createItem, entrySet, equals, get, get, hashCode, isEmpty, itemPath, 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 Password create(java.lang.String name,
                       java.lang.String password)
Creates a credential with a username and password.

Parameters:
name - The username.
password - The password.
Returns:
The new credential.

create

public Password create(java.lang.String name,
                       java.lang.String password,
                       java.lang.String realm)
Creates a credential with a username, password, and realm.

Parameters:
name - The username.
password - The password.
realm - The credential realm.
Returns:
The new credential.

itemKey

protected java.lang.String itemKey(AtomEntry entry)
Returns the username for a credential.

Overrides:
itemKey in class ResourceCollection<Password>
Parameters:
entry - The AtomEntry object describing the credential.
Returns:
The username.