org.linguafranca.pwdb

Interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>

All Known Implementing Classes:

AbstractDatabase, ProtectedDatabase

public interface Database<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>

Interface for a password database consisting of Groups, sub-Groups and Entries. A database is arranged as a tree starting from the root group, with entries allowed as children of any group.

A database is a factory for new Groups and Entries. Groups and entries belonging to one database cannot in general be added to another database, they need to be imported using newGroup(Group) and newEntry(Entry), or implicitly imported using Group.addGroup(Group) which automatically create Groups and Entries (as well as importing subgroups and their entries). Group.addEntry(Entry) allows arbitrary importing from other databases.

Databases may be navigated directly from the root getRootGroup(), or using a Visitor and visit(Visitor) or visit(Group, Visitor) to start the visit at a particular group.

A list of entries that match a string or some custom criteria may be obtained using the findEntries(Entry.Matcher) and findEntries(String) methods.

To match (optionally recursively) entries in a Group use Group.findEntries(String, boolean) or Group.findEntries(Entry.Matcher, boolean).

All Lists provided returned by methods of all interfaces may be modified by the caller without affecting the underlying database structure, however changes to the Groups and Entries contained in the lists do modify the database.

Method Summary

Modifier and Type	Method and Description
boolean	deleteEntry(UUID uuid) Delete an entry with this UUID from anywhere in the database except the recycle bin if recycle is enabled then the entry is moved to the recycle bin
boolean	deleteGroup(UUID uuid) Delete a group with this UUID from anywhere in the database except the recycle bin if recycle is enabled then the group is moved to the recycle bin
void	emptyRecycleBin() empty the recycle bin whether it is enabled or disabled
void	enableRecycleBin(boolean enable) change the recycle bin state
List<? extends E>	findEntries(Entry.Matcher matcher) Find all entries that match the criteria
List<? extends E>	findEntries(String find) Find all entries that match Entry.match(String)
E	findEntry(UUID uuid) Find an entry with this UUID anywhere in the database except the recycle bin
G	findGroup(UUID uuid) Find a group with this UUID anywhere in the database except the recycle bin
String	getDescription() Gets the database description, if there is one
String	getName() Gets the name of the database or null if not supported
PropertyValue.Strategy	getPropertyValueStrategy() Get the default means of storage of unprotected and protected property values
G	getRecycleBin() If the recycle bin is enabled (or it's disabled but there is a pre-existing recycle bin), then return the recycle bin, creating one if necessary.
G	getRootGroup() get the root group for the database
<C extends StreamConfiguration> StreamFormat<C>	getStreamFormat() Get the format the database was loaded from
boolean	isDirty() True if database been modified
boolean	isRecycleBinEnabled() if a database has a recycle bin then it is enabled by default
List<String>	listShouldProtect() Obtain a list of those properties that should be protected by default
E	newEntry() Create a new Entry
E	newEntry(Entry<?,?,?,?> entry) Create a new Entry copying the details of the supplied entry
E	newEntry(String title) Create a new Entry with a title
G	newGroup() Create a new Group
G	newGroup(Group<?,?,?,?> group) Create a new Group copying the details of the supplied group, but not copying its children
G	newGroup(String name) Create a new named Group
I	newIcon() Create a new default icon
I	newIcon(Integer i) Create a new icon with a specified index
void	save(Credentials credentials, OutputStream outputStream) Save the database to a stream using default format
<C extends StreamConfiguration> void	save(StreamFormat<C> streamFormat, Credentials credentials, OutputStream outputStream) Save the database to a stream
void	setDescription(String description) Sets the database description if it is supported
void	setName(String name) Set the name of the database if this is supported
void	setPropertyValueStrategy(PropertyValue.Strategy propertyValueStrategy) Set the default means of storage of unprotected and protected property values
void	setShouldProtect(String propertyName, boolean protect) Property to protect in memory
boolean	shouldProtect(String propertyName) Property to protect in memory
boolean	supportsBinaryProperties() returns true if the database supports binary properties
boolean	supportsNonStandardPropertyNames() returns true if the database supports non-standard property names
boolean	supportsPropertyValueStrategy() returns true if the implementation supports a PropertyValueStrategy
boolean	supportsRecycleBin() returns true if the database supports recycle bin
void	visit(G group, Visitor<D,G,E,I> visitor) Visit all entries starting from a group
void	visit(Visitor<D,G,E,I> visitor) Visit all entries

Method Detail

getRootGroup

G getRootGroup()

get the root group for the database

Returns:

the root group

newGroup

G newGroup()

Create a new Group

Returns:

the group created

newGroup

G newGroup(String name)

Create a new named Group

Parameters:

name - the name of the group

Returns:

the group created

newGroup

G newGroup(Group<?,?,?,?> group)

Create a new Group copying the details of the supplied group, but not copying its children

Used for copying a group from one database to another

Parameters:

group - the group to copy

Returns:

the group created

newEntry

E newEntry()

Create a new Entry

Returns:

the entry created

newEntry

E newEntry(String title)

Create a new Entry with a title

Returns:

the entry created

newEntry

E newEntry(Entry<?,?,?,?> entry)

Create a new Entry copying the details of the supplied entry

Used for copying an entry from one database to another

Parameters:

entry - the entry to copy

Returns:

the entry created

newIcon

I newIcon()

Create a new default icon

Returns:

the created icon

newIcon

I newIcon(Integer i)

Create a new icon with a specified index

Parameters:

i - the index of the icon to create

Returns:

the created icon

findEntry

@Nullable
E findEntry(UUID uuid)

Find an entry with this UUID anywhere in the database except the recycle bin

Parameters:

uuid - the UUID

Returns:

an entry or null if not found

deleteEntry

boolean deleteEntry(UUID uuid)

Delete an entry with this UUID from anywhere in the database except the recycle bin if recycle is enabled then the entry is moved to the recycle bin

Parameters:

uuid - the UUID

Returns:

true if an entry was deleted

findGroup

@Nullable
G findGroup(UUID uuid)

Find a group with this UUID anywhere in the database except the recycle bin

Parameters:

uuid - the UUID

Returns:

a group or null if not found

deleteGroup

boolean deleteGroup(UUID uuid)

Delete a group with this UUID from anywhere in the database except the recycle bin if recycle is enabled then the group is moved to the recycle bin

Parameters:

uuid - the UUID

Returns:

true if a group was deleted

isRecycleBinEnabled

boolean isRecycleBinEnabled()

if a database has a recycle bin then it is enabled by default

Returns:

true if the recycle bin is enabled - false if it is not or is not supported

enableRecycleBin

void enableRecycleBin(boolean enable)

change the recycle bin state

Throws:

UnsupportedOperationException - if recycle bin functions are not supported

See Also:

supportsRecycleBin()

getRecycleBin

@Nullable
G getRecycleBin()

If the recycle bin is enabled (or it's disabled but there is a pre-existing recycle bin), then return the recycle bin, creating one if necessary. If the recycle bin is disabled and there is no pre-existing recycle bin or if recycle bin is not supported then return null.

See Also:

supportsRecycleBin()

emptyRecycleBin

void emptyRecycleBin()

empty the recycle bin whether it is enabled or disabled

Throws:

UnsupportedOperationException - if recycle bin functions are not supported

See Also:

supportsRecycleBin()

visit

void visit(Visitor<D,G,E,I> visitor)

Visit all entries

Parameters:

visitor - the visitor to use

visit

void visit(G group,
           Visitor<D,G,E,I> visitor)

Visit all entries starting from a group

Parameters:

group - the group to start at

visitor - the visitor to use

findEntries

List<? extends E> findEntries(Entry.Matcher matcher)

Find all entries that match the criteria

Parameters:

matcher - the matcher to use

Returns:

a list of entries

findEntries

List<? extends E> findEntries(String find)

Find all entries that match Entry.match(String)

Parameters:

find - string to find

Returns:

a list of entries

getName

String getName()

Gets the name of the database or null if not supported

Returns:

a database name

setName

void setName(String name)

Set the name of the database if this is supported

Parameters:

name - the name

getDescription

String getDescription()

Gets the database description, if there is one

Returns:

the description or null if not supported

setDescription

void setDescription(String description)

Sets the database description if it is supported

Parameters:

description - a description of the database

isDirty

boolean isDirty()

True if database been modified

save

void save(Credentials credentials,
          OutputStream outputStream)
   throws IOException

Save the database to a stream using default format

Throws:

IOException

save

<C extends StreamConfiguration> void save(StreamFormat<C> streamFormat,
                                          Credentials credentials,
                                          OutputStream outputStream)
                                   throws IOException

Save the database to a stream

Throws:

IOException

getStreamFormat

<C extends StreamConfiguration> StreamFormat<C> getStreamFormat()

Get the format the database was loaded from

shouldProtect

boolean shouldProtect(String propertyName)

Property to protect in memory

Parameters:

propertyName - the property of interest

Returns:

true if it should be protected by default

setShouldProtect

void setShouldProtect(String propertyName,
                      boolean protect)

Property to protect in memory

Parameters:

propertyName - the property of interest

protect - whether to protect by default

listShouldProtect

List<String> listShouldProtect()

Obtain a list of those properties that should be protected by default

Returns:

a list of property names

getPropertyValueStrategy

PropertyValue.Strategy getPropertyValueStrategy()

Get the default means of storage of unprotected and protected property values

setPropertyValueStrategy

void setPropertyValueStrategy(PropertyValue.Strategy propertyValueStrategy)

Set the default means of storage of unprotected and protected property values

Parameters:

propertyValueStrategy - a propertyValue strategy

supportsNonStandardPropertyNames

boolean supportsNonStandardPropertyNames()

returns true if the database supports non-standard property names

supportsBinaryProperties

boolean supportsBinaryProperties()

returns true if the database supports binary properties

supportsRecycleBin

boolean supportsRecycleBin()

returns true if the database supports recycle bin

supportsPropertyValueStrategy

boolean supportsPropertyValueStrategy()

returns true if the implementation supports a PropertyValueStrategy