com.splunk
Class PasswordCollection

java.lang.Object
  com.splunk.Resource
      com.splunk.ResourceCollection<T>
          com.splunk.EntityCollection<Password>
              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

boolean	containsKey(java.lang.Object key)
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.
Password	get(java.lang.Object key) Gets the value of a given key, if it exists within this collection.
Password	get(java.lang.String realm, java.lang.String name) Get a credential with realm and name.
Password	remove(java.lang.String key) Removes an entity from this collection.
Password	remove(java.lang.String realm, java.lang.String name) Remove a credential with realm and name.

Methods inherited from class com.splunk.EntityCollection

create, create, remove

Methods inherited from class com.splunk.ResourceCollection

clear, containsKey, containsValue, createItem, createItem, entrySet, equals, get, hashCode, isEmpty, itemKey, 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.

get

public Password get(java.lang.String realm,
                    java.lang.String name)

Get a credential with realm and name.

Parameters:

realm - The credential realm.

name - The username.

Returns:

The credential, or null if not found.

get

public Password get(java.lang.Object key)

Description copied from class: ResourceCollection

Gets the value of a given key, if it exists within this collection.

Specified by:

get in interface java.util.Map<java.lang.String,Password>

Overrides:

get in class ResourceCollection<Password>

Parameters:

key - The key to look up.

Returns:

The value indexed by the key, or null if it doesn't exist.

remove

public Password remove(java.lang.String realm,
                       java.lang.String name)

Remove a credential with realm and name.

Parameters:

realm - The credential realm.

name - The username.

Returns:

The removed credential, or null if not found.

remove

public Password remove(java.lang.String key)

Description copied from class: EntityCollection

Removes an entity from this collection.

Overrides:

remove in class EntityCollection<Password>

Parameters:

key - The name of the entity to remove.

Returns:

The collection.

containsKey

public boolean containsKey(java.lang.Object key)

Description copied from class: ResourceCollection

Specified by:

containsKey in interface java.util.Map<java.lang.String,Password>

Overrides:

containsKey in class ResourceCollection<Password>