Package org.freedesktop.secret.simple

Class SimpleCollection

java.lang.Object

org.freedesktop.secret.simple.SimpleCollection

All Implemented Interfaces:

AutoCloseable

public final class SimpleCollection
extends Object
implements AutoCloseable

Constructor Summary

Constructors

Constructor	Description
SimpleCollection()	The default collection.
SimpleCollection(String label, CharSequence password)	A user specified collection.

Method Summary

Modifier and Type	Method	Description
void	clear()	clear the passphrase of the collection.
void	close()
String	createPassword(String label, CharSequence password)	Creates an item with the provided properties in this collection.
String	createPassword(String label, CharSequence password, Map<String,String> attributes)	Creates an item with the provided properties in this collection.
void	delete()	Delete this collection.
void	deletePassword(String objectPath)	Delete an item from this collection.
void	deletePasswords(List<String> objectPaths)	Delete specified items from this collection.
Map<String,String>	getAttributes(String objectPath)	Get the user specified attributes of an item.
String	getLabel(String objectPath)	Get the displayable label of an item.
char[]	getPassword(String objectPath)	Get the secret of the item.
Map<String,char[]>	getPasswords()	Get the secrets from this collection.
void	updatePassword(String objectPath, String label, CharSequence password, Map<String,String> attributes)	Updates an item with the provided properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleCollection

public SimpleCollection()

The default collection.

SimpleCollection

public SimpleCollection(String label,
                        CharSequence password)

A user specified collection.

Parameters:

label - The displayable label of the collection

NOTE: The 'label' of a collection may differ from the 'id' of a collection. The 'id' is assigned by the Secret Service and used in the DBus object path of a collection or item.

A SimpleCollection can't handle collections with the same label, but different ids correctly.

password - Password of the collection

Method Detail

clear

public void clear()

clear the passphrase of the collection.

close

public void close()

Specified by:

close in interface AutoCloseable

delete

public void delete()
            throws AccessControlException

Delete this collection.

Throws:

AccessControlException

createPassword

public String createPassword(String label,
                             CharSequence password,
                             Map<String,String> attributes)
                      throws IllegalArgumentException

Creates an item with the provided properties in this collection.

Parameters:

label - The displayable label of the new item

password - The password of the new item

attributes - The attributes of the new item

Returns:

DBus object path

Throws:

IllegalArgumentException

createPassword

public String createPassword(String label,
                             CharSequence password)
                      throws IllegalArgumentException

Creates an item with the provided properties in this collection.

Parameters:

label - The displayable label of the new item

password - The password of the new item

Returns:

DBus object path

Throws:

IllegalArgumentException

updatePassword

public void updatePassword(String objectPath,
                           String label,
                           CharSequence password,
                           Map<String,String> attributes)
                    throws IllegalArgumentException

Updates an item with the provided properties.

Parameters:

objectPath - The DBus object path of the item

label - The displayable label of the new item

password - The password of the new item

attributes - The attributes of the new item

Throws:

IllegalArgumentException

getLabel

public String getLabel(String objectPath)

Get the displayable label of an item.

Parameters:

objectPath - The DBus object path of the item

Returns:

getAttributes

public Map<String,String> getAttributes(String objectPath)

Get the user specified attributes of an item. NOTE:

The attributes can contain an additional 'xdg:schema' key-value pair.

Parameters:

objectPath - The DBus object path of the item

Returns:

item attributes

getPassword

public char[] getPassword(String objectPath)

Get the secret of the item.

Parameters:

objectPath - The DBus object path of the item

Returns:

plain chars

getPasswords

public Map<String,char[]> getPasswords()
                                throws AccessControlException

Get the secrets from this collection. NOTE:

Retrieving all passwords form a collection requires user permission.

Returns:

Mapping of DBus object paths and plain chars

Throws:

AccessControlException

deletePassword

public void deletePassword(String objectPath)
                    throws AccessControlException

Delete an item from this collection. NOTE:

Deleting a password form a collection requires user permission.

Parameters:

objectPath - The DBus object path of the item

Throws:

AccessControlException

deletePasswords

public void deletePasswords(List<String> objectPaths)
                     throws AccessControlException

Delete specified items from this collection. NOTE:

Deleting passwords form a collection requires user permission.

Parameters:

objectPaths - The DBus object paths of the items

Throws:

AccessControlException