Package org.freedesktop.secret

Class Collection

java.lang.Object

org.freedesktop.secret.handlers.Messaging

org.freedesktop.secret.interfaces.AbstractInterface

org.freedesktop.secret.interfaces.Collection

org.freedesktop.secret.Collection

All Implemented Interfaces:

org.freedesktop.dbus.interfaces.DBusInterface

public class Collection
extends Collection

Nested Class Summary

Nested classes/interfaces inherited from class org.freedesktop.secret.interfaces.Collection

Collection.ItemChanged, Collection.ItemCreated, Collection.ItemDeleted

Field Summary

Fields

Modifier and Type	Field	Description
static List<Class<? extends org.freedesktop.dbus.messages.DBusSignal>>	signals

Fields inherited from class org.freedesktop.secret.interfaces.Collection

LABEL

Fields inherited from class org.freedesktop.secret.handlers.Messaging

connection, interfaceName, msg, objectPath, serviceName, sh

Constructor Summary

Constructors

Constructor	Description
Collection(String id, Service service)
Collection(org.freedesktop.dbus.DBusPath path, Service service)
Collection(org.freedesktop.dbus.DBusPath path, Service service, List<Class<? extends org.freedesktop.dbus.messages.DBusSignal>> signals)

Method Summary

Modifier and Type	Method	Description
org.freedesktop.dbus.types.UInt64	created()
Pair<org.freedesktop.dbus.ObjectPath,org.freedesktop.dbus.ObjectPath>	createItem(Map<String,org.freedesktop.dbus.types.Variant> properties, Secret secret, boolean replace)	Create an item with the given attributes, secret and label.
org.freedesktop.dbus.ObjectPath	delete()	Delete this collection.
String	getId()
List<org.freedesktop.dbus.ObjectPath>	getItems()	Items is a D-Bus Property.
String	getLabel()	Label is a D-Bus Property.
String	getObjectPath()
boolean	isLocked()
boolean	isRemote()
org.freedesktop.dbus.types.UInt64	modified()
List<org.freedesktop.dbus.ObjectPath>	searchItems(Map<String,String> attributes)	Search for items in this collection matching the lookup attributes.
void	setLabel(String label)	Label is a D-Bus Property.

Methods inherited from class org.freedesktop.secret.interfaces.Collection

createProperties

Methods inherited from class org.freedesktop.secret.handlers.Messaging

getAllProperties, getConnection, getInterfaceName, getMessageHandler, getPath, getProperty, getServiceName, getSignalHandler, send, send, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

signals

public static final List<Class<? extends org.freedesktop.dbus.messages.DBusSignal>> signals

Constructor Detail

Collection

public Collection(org.freedesktop.dbus.DBusPath path,
                  Service service)

Collection

public Collection(org.freedesktop.dbus.DBusPath path,
                  Service service,
                  List<Class<? extends org.freedesktop.dbus.messages.DBusSignal>> signals)

Collection

public Collection(String id,
                  Service service)

Method Detail

delete

public org.freedesktop.dbus.ObjectPath delete()

Description copied from class: Collection

Delete this collection.

Specified by:

delete in class Collection

Returns:

prompt — A prompt to delete the collection, or the special value '/' when no prompt is necessary.

See Also:

ObjectPath

searchItems

public List<org.freedesktop.dbus.ObjectPath> searchItems(Map<String,String> attributes)

Description copied from class: Collection

Search for items in this collection matching the lookup attributes.

Specified by:

searchItems in class Collection

Parameters:

attributes - Attributes to match.

Returns:

results — Items that matched the attributes.

See Also:

ObjectPath, Secret, Item

createItem

public Pair<org.freedesktop.dbus.ObjectPath,org.freedesktop.dbus.ObjectPath> createItem(Map<String,org.freedesktop.dbus.types.Variant> properties,
                                                                                        Secret secret,
                                                                                        boolean replace)

Description copied from class: Collection

Create an item with the given attributes, secret and label. If replace is set, then it replaces an item already present with the same values for the attributes.

Specified by:

createItem in class Collection

Parameters:

properties - The properties for the new item.

This allows setting the new item's properties upon its creation. All READWRITE properties are useable. Specify the property names in full interface.Property form.

Example 13.2. Example for properties of an item:
properties = {
"org.freedesktop.Secret.Item.Label": "MyItem",
"org.freedesktop.Secret.Item.Attributes": {
"Attribute1": "Value1",
"Attribute2": "Value2"
}
}


Note: Please note that there is a distinction between the terms Property, which refers to D-Bus properties of an object, and Attribute, which refers to one of a secret item's string-valued attributes.

secret - The secret to store in the item, encoded with the included session.

replace - Whether to replace an item with the same attributes or not.

Returns:

Pair<item, prompt>

item — The item created, or the special value '/' if a prompt is necessary.

prompt — A prompt object, or the special value '/' if no prompt is necessary.

See Also:

Pair, ObjectPath, Secret, Item

getItems

public List<org.freedesktop.dbus.ObjectPath> getItems()

Description copied from class: Collection

Items is a D-Bus Property.

It is managed by using the org.freedesktop.DBus.Properties interface.

Specified by:

getItems in class Collection

Returns:

Items in this collection.

getLabel

public String getLabel()

Description copied from class: Collection

Label is a D-Bus Property.

It is managed by using the org.freedesktop.DBus.Properties interface.

Specified by:

getLabel in class Collection

Returns:

The displayable label of this collection.

Note: The displayable label can differ from the actual name of a collection.

setLabel

public void setLabel(String label)

Description copied from class: Collection

Label is a D-Bus Property.

It is managed by using the org.freedesktop.DBus.Properties interface.

Specified by:

setLabel in class Collection

Parameters:

label - The displayable label of this collection.

Note: The displayable label can differ from the actual name of a collection.

isLocked

public boolean isLocked()

Specified by:

isLocked in class Collection

Returns:

Whether the collection is locked and must be authenticated by the client application.

created

public org.freedesktop.dbus.types.UInt64 created()

Specified by:

created in class Collection

Returns:

The unix time when the collection was created.

modified

public org.freedesktop.dbus.types.UInt64 modified()

Specified by:

modified in class Collection

Returns:

The unix time when the collection was last modified.

isRemote

public boolean isRemote()

getObjectPath

public String getObjectPath()

Specified by:

getObjectPath in interface org.freedesktop.dbus.interfaces.DBusInterface

Overrides:

getObjectPath in class Messaging

getId

public String getId()