net.java.truecommons.key.macosx.keychain

Class Keychain

java.lang.Object

net.java.truecommons.key.macosx.keychain.Keychain

All Implemented Interfaces:

AutoCloseable

@ThreadSafe
public abstract class Keychain
extends Object
implements AutoCloseable

A simple abstraction over Apple's Keychain Services API. The methods in this class generally throw KeychainException to report any errors when accessing this keychain.

Implementations need to safe for multi-threading.

Since:

TrueCommons 2.2

Author:

Christian Schlichtherle

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Keychain.AttributeClass Enumerates classes of attributes of items in a ketchain.
static interface	Keychain.Item An item in a keychain.
static class	Keychain.ItemClass Enumerates classes of items in a keychain.
static interface	Keychain.Visitor A visitor for items in a keychain.

Constructor Summary

Constructors

Constructor and Description
Keychain()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Closes this keychain.
abstract void	createItem(Keychain.ItemClass id, Map<Keychain.AttributeClass,ByteBuffer> attributes, ByteBuffer secret) Creates a new item in this keychain.
abstract void	delete() Deletes and closes this keychain.
static Keychain	open() Opens the default keychain.
static Keychain	open(String path, char[] password) Opens the specified keychain, creating it first if necessary.
abstract void	visitItems(Keychain.ItemClass id, Map<Keychain.AttributeClass,ByteBuffer> attributes, Keychain.Visitor visitor) Visits items in this keychain.

Methods inherited from class java.lang.Object

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

Constructor Detail

Keychain

public Keychain()

Method Detail

close

public abstract void close()

Closes this keychain.

Specified by:

close in interface AutoCloseable

createItem

public abstract void createItem(Keychain.ItemClass id,
                                Map<Keychain.AttributeClass,ByteBuffer> attributes,
                                ByteBuffer secret)
                         throws KeychainException

Creates a new item in this keychain.

Parameters:

id - the class of the item to create.

attributes - the attributes of the item to create.

secret - the secret data of the item to create.

Throws:

KeychainException

delete

public abstract void delete()
                     throws KeychainException

Deletes and closes this keychain.

Throws:

KeychainException

open

public static Keychain open()
                     throws KeychainException

Opens the default keychain.

Throws:

KeychainException

open

public static Keychain open(String path,
                            @Nullable
                            char[] password)
                     throws KeychainException

Opens the specified keychain, creating it first if necessary.

Parameters:

path - the path name of the keychain.

password - the password to use for creating the keychain. If null, then the user gets prompted for a password.

Throws:

KeychainException

visitItems

public abstract void visitItems(@Nullable
                                Keychain.ItemClass id,
                                @Nullable
                                Map<Keychain.AttributeClass,ByteBuffer> attributes,
                                Keychain.Visitor visitor)
                         throws KeychainException

Visits items in this keychain. The id and attributes parameters filter the set of items to visit.

Parameters:

id - the class of the items to visit. Use null or Keychain.ItemClass.ANY_ITEM to visit items of any class.

attributes - the attributes to visit. Use null or an empty map to visit items with any attributes.

visitor - the visitor to apply to all matching items.

Throws:

KeychainException