Package com.aresstack.keepassrpc.client

Class DefaultKeePassRpcCredentialClient

java.lang.Object

com.aresstack.keepassrpc.client.DefaultKeePassRpcCredentialClient

All Implemented Interfaces:

KeePassRpcCredentialClient, AutoCloseable

public final class DefaultKeePassRpcCredentialClient
extends Object
implements KeePassRpcCredentialClient

Default KeePassRpcCredentialClient implementation backed by the KeePassRPC protocol client.

Create instances from persisted settings or directly from a pairing result.

Constructor Summary

Constructors

Constructor	Description
DefaultKeePassRpcCredentialClient(String host, int port, String clientId, String srpKey, String origin)	Create a credential client from explicit connection and authentication values.

Method Summary

Modifier and Type	Method	Description
void	addLogin(String title, String userName, String password, String url)	Add a new login entry to KeePass.
void	close()	Close the underlying WebSocket connection.
void	connect()	Open the WebSocket connection and authenticate with KeePassRPC.
static DefaultKeePassRpcCredentialClient	fromPairingResult(KeePassRpcPairingResult result)	Create a credential client directly from a successful pairing result.
static DefaultKeePassRpcCredentialClient	fromSettings(KeePassRpcSettings settings)	Create a credential client from stored settings.
String	getDatabaseFileName()	Query the filename of the active KeePass database.
String	getPassword(String entryTitle)	Read the password for the first KeePass entry matching the given title.
String	getUserName(String entryTitle)	Read the username for the first KeePass entry matching the given title.
String	listEntries()	Return a textual representation of entries visible through KeePassRPC.
void	updateLogin(String title, String userName, String password)	Update an existing login entry by title.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultKeePassRpcCredentialClient

public DefaultKeePassRpcCredentialClient(String host,
 int port,
 String clientId,
 String srpKey,
 String origin)

Create a credential client from explicit connection and authentication values.

Parameters:

host - KeePassRPC host

port - KeePassRPC port

clientId - paired client identifier

srpKey - persisted SRP key returned by pairing

origin - WebSocket origin accepted by KeePassRPC

Method Details

fromSettings

public static DefaultKeePassRpcCredentialClient fromSettings(KeePassRpcSettings settings)

Create a credential client from stored settings.

Parameters:

settings - settings containing endpoint, origin, and SRP key

Returns:

credential client configured from the settings

fromPairingResult

public static DefaultKeePassRpcCredentialClient fromPairingResult(KeePassRpcPairingResult result)

Create a credential client directly from a successful pairing result.

Parameters:

result - pairing result containing endpoint, origin, client ID, and SRP key

Returns:

credential client configured from the pairing result

connect

public void connect()

Description copied from interface: KeePassRpcCredentialClient

Open the WebSocket connection and authenticate with KeePassRPC.

Specified by:

connect in interface KeePassRpcCredentialClient

getUserName

public String getUserName(String entryTitle)

Description copied from interface: KeePassRpcCredentialClient

Read the username for the first KeePass entry matching the given title.

Specified by:

getUserName in interface KeePassRpcCredentialClient

Parameters:

entryTitle - KeePass entry title

Returns:

username or null if no matching entry was found

getPassword

public String getPassword(String entryTitle)

Description copied from interface: KeePassRpcCredentialClient

Read the password for the first KeePass entry matching the given title.

Specified by:

getPassword in interface KeePassRpcCredentialClient

Parameters:

entryTitle - KeePass entry title

Returns:

password or null if no matching entry was found

getDatabaseFileName

public String getDatabaseFileName()

Description copied from interface: KeePassRpcCredentialClient

Query the filename of the active KeePass database.

Specified by:

getDatabaseFileName in interface KeePassRpcCredentialClient

Returns:

database filename or an empty string if KeePassRPC does not return it

addLogin

public void addLogin(String title,
 String userName,
 String password,
 String url)

Description copied from interface: KeePassRpcCredentialClient

Add a new login entry to KeePass.

Specified by:

addLogin in interface KeePassRpcCredentialClient

Parameters:

title - entry title

userName - username

password - password

url - associated URL

updateLogin

public void updateLogin(String title,
 String userName,
 String password)

Description copied from interface: KeePassRpcCredentialClient

Update an existing login entry by title.

Specified by:

updateLogin in interface KeePassRpcCredentialClient

Parameters:

title - entry title

userName - new username

password - new password

listEntries

public String listEntries()

Description copied from interface: KeePassRpcCredentialClient

Return a textual representation of entries visible through KeePassRPC.

Specified by:

listEntries in interface KeePassRpcCredentialClient

Returns:

implementation-specific entry listing

close

public void close()

Description copied from interface: KeePassRpcCredentialClient

Close the underlying WebSocket connection.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface KeePassRpcCredentialClient