org.linguafranca.pwdb

Interface Entry<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:

AbstractEntry

public interface Entry<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 Database Entry. Database entries provide support at least for the Standard Properties of

• Title
• Username
• Password
• URL
• Notes

Entries have a UUID and have an Icon, which are not properties.

Support for additional textual properties may be provided by a database implementation.

Entries provide support for tracking when they are used. At some point support for accessing a history of modifications may be added to this interface

Author:

Jo

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Entry.Matcher Interface to implement when using the match(Entry.Matcher) method

Field Summary

Fields

Modifier and Type	Field and Description
static String	STANDARD_PROPERTY_NAME_NOTES
static String	STANDARD_PROPERTY_NAME_PASSWORD
static String	STANDARD_PROPERTY_NAME_TITLE
static String	STANDARD_PROPERTY_NAME_URL
static String	STANDARD_PROPERTY_NAME_USER_NAME Standard properties are attributes of Entries that are accessible either by dedicated methods, such as getPassword, or by getProperty(String)
static List<String>	STANDARD_PROPERTY_NAMES

Method Summary

Modifier and Type	Method and Description
byte[]	getBinaryProperty(String name) Gets the value of a binary property.
List<String>	getBinaryPropertyNames() Returns a list of binary property names known to the entry.
Date	getCreationTime()
boolean	getExpires()
Date	getExpiryTime()
I	getIcon() Returns the Icon associated with this entry.
Date	getLastAccessTime()
Date	getLastModificationTime()
String	getNotes() Gets the notes field for this entry.
G	getParent() Get the parent of this entry
String	getPassword() Gets the (unencrypted) password field for this entry.
String	getPath() Returns an XPath-like representation of this entry's ancestor groups and the title of this entry.
String	getProperty(String name) Gets the value of a property.
List<String>	getPropertyNames() Returns a list of property names known to the entry.
String	getTitle() Gets the title of this entry.
String	getUrl() Gets the URL for this entry.
String	getUsername() Get the username field of this entry
UUID	getUuid() Get the UUID of this entry.
boolean	match(Entry.Matcher matcher) Returns the result of applying the matcher to this Entry
boolean	match(String text) Determines if an entry matches the text supplied.
boolean	matchNotes(String text) Returns true if the notes to lowercase contains the passed string to lowercase.
boolean	matchTitle(String text) Returns true if this title to lowercase contains the passed title to lowercase.
boolean	matchUrl(String url) Returns true if this url to lowercase contains the passed url to lowercase.
boolean	matchUsername(String username) Returns true if this username to lowercase contains the passed username to lowercase.
void	setBinaryProperty(String name, byte[] value) Sets the value of a binary property.
void	setIcon(I icon) Sets the Icon associated with this entry.
void	setNotes(String notes) Sets the notes for this Entry.
void	setPassword(String pass) Sets the plaintext password for this Entry.
void	setProperty(String name, String value) Sets the value of a property.
void	setTitle(String title) Sets the title for this Entry.
void	setUrl(String url) Sets the url for this Entry.
void	setUsername(String username) set the username

Field Detail

STANDARD_PROPERTY_NAME_USER_NAME

static final String STANDARD_PROPERTY_NAME_USER_NAME

Standard properties are attributes of Entries that are accessible either by dedicated methods, such as getPassword, or by getProperty(String)

See Also:

Constant Field Values

STANDARD_PROPERTY_NAME_PASSWORD

static final String STANDARD_PROPERTY_NAME_PASSWORD

See Also:

Constant Field Values

STANDARD_PROPERTY_NAME_URL

static final String STANDARD_PROPERTY_NAME_URL

See Also:

Constant Field Values

STANDARD_PROPERTY_NAME_TITLE

static final String STANDARD_PROPERTY_NAME_TITLE

See Also:

Constant Field Values

STANDARD_PROPERTY_NAME_NOTES

static final String STANDARD_PROPERTY_NAME_NOTES

See Also:

Constant Field Values

STANDARD_PROPERTY_NAMES

static final List<String> STANDARD_PROPERTY_NAMES

Method Detail

match

boolean match(String text)

Determines if an entry matches the text supplied. A match is recorded if the text matches the Url, Title, Username or Notes. Match means that any portion of the field to lower case contains the field supplied, to lowercase.

Parameters:

text - the text to find

Returns:

true if this entry matches the text

match

boolean match(Entry.Matcher matcher)

Returns the result of applying the matcher to this Entry

Parameters:

matcher - the matcher to use

Returns:

the result of applying the matcher

getPath

String getPath()

Returns an XPath-like representation of this entry's ancestor groups and the title of this entry.

getProperty

String getProperty(String name)

Gets the value of a property.

All implementations of Entry are required to support reading and writing of STANDARD_PROPERTY_NAMES.

Parameters:

name - the name of the property to get

Returns:

a value or null if the property is not known, or if setting of arbitrary properties is not supported

setProperty

void setProperty(String name,
                 String value)

Sets the value of a property.

Other than the STANDARD_PROPERTY_NAMES support for this methd is optional.

Parameters:

name - the name of the property to set

value - the value to set it to

Throws:

UnsupportedOperationException - if the name is not one of the standard properties and non-standard properties are not supported.

getPropertyNames

List<String> getPropertyNames()

Returns a list of property names known to the entry.

All implementations of Entry are required to support reading and writing of STANDARD_PROPERTY_NAMES.

Returns:

a list that is modifiable by the caller without affecting the Entry.

getBinaryProperty

byte[] getBinaryProperty(String name)

Gets the value of a binary property.

Support for this method is optional.

Parameters:

name - the name of the property to get

Returns:

a value or null if the property is not known, or if setting of arbitrary properties is not supported

setBinaryProperty

void setBinaryProperty(String name,
                       byte[] value)

Sets the value of a binary property.

Support for this method is optional.

Parameters:

name - the name of the property to set

value - the value to set it to

Throws:

UnsupportedOperationException - if binary properties are not supported.

getBinaryPropertyNames

List<String> getBinaryPropertyNames()

Returns a list of binary property names known to the entry.

All implementations of Entry are required to support reading and writing of STANDARD_PROPERTY_NAMES.

Returns:

a list that is modifiable by the caller without affecting the Entry.

Throws:

UnsupportedOperationException - if binary properties are not supported.

getParent

G getParent()

Get the parent of this entry

Returns:

a parent

getUuid

UUID getUuid()

Get the UUID of this entry. Databases (like KDB) that do not natively support UUIDs must provide a surrogate here.

Returns:

a UUID

getUsername

String getUsername()

Get the username field of this entry

Returns:

a username

setUsername

void setUsername(String username)

set the username

Parameters:

username - username to set

matchUsername

boolean matchUsername(String username)

Returns true if this username to lowercase contains the passed username to lowercase.

Parameters:

username - a username to match

Returns:

true if matches

getPassword

String getPassword()

Gets the (unencrypted) password field for this entry.

Implementations should Touch LastAccessedTime when this method is called.

Returns:

a password

setPassword

void setPassword(String pass)

Sets the plaintext password for this Entry.

Implementations should Touch LastModifiedTime when this method is called.

Parameters:

pass - a password

getUrl

String getUrl()

Gets the URL for this entry.

Implementations should Touch LastAccessedTime when this method is called.

Returns:

a string representation of a URL

setUrl

void setUrl(String url)

Sets the url for this Entry.

Implementations should Touch LastModifiedTime when this method is called.

Parameters:

url - the value to set

matchUrl

boolean matchUrl(String url)

Returns true if this url to lowercase contains the passed url to lowercase.

Parameters:

url - a string to match

Returns:

true if matches

getTitle

String getTitle()

Gets the title of this entry.

Implementations should Touch LastAccessedTime when this method is called.

Returns:

a title

setTitle

void setTitle(String title)

Sets the title for this Entry.

Implementations should Touch LastModifiedTime when this method is called.

Parameters:

title - the value to set

matchTitle

boolean matchTitle(String text)

Returns true if this title to lowercase contains the passed title to lowercase.

Parameters:

text - a string to match

Returns:

true if matches

getNotes

String getNotes()

Gets the notes field for this entry.

Implementations should Touch LastAccessedTime when this method is called.

Returns:

the notes field

setNotes

void setNotes(String notes)

Sets the notes for this Entry.

Implementations should Touch LastModifiedTime when this method is called.

Parameters:

notes - the value to set

matchNotes

boolean matchNotes(String text)

Returns true if the notes to lowercase contains the passed string to lowercase.

Parameters:

text - a string to match

Returns:

true if matches

getIcon

I getIcon()

Returns the Icon associated with this entry.

Returns:

an Icon

setIcon

void setIcon(I icon)

Sets the Icon associated with this entry.

Parameters:

icon - an Icon

getLastAccessTime

Date getLastAccessTime()

getCreationTime

Date getCreationTime()

getExpires

boolean getExpires()

getExpiryTime

Date getExpiryTime()

getLastModificationTime

Date getLastModificationTime()