org.iota.jota.account.store

Class AccountFileStore

java.lang.Object

org.iota.jota.account.store.AccountStoreImpl

org.iota.jota.account.store.AccountFileStore

All Implemented Interfaces:

AccountStore, TaskService

public class AccountFileStore
extends AccountStoreImpl

Terribly inefficient storage method which reads/writes all to disk every time you modify. Can be optimized by caching yml after modify, or only loading in the current account instead of all file data.

Constructor Summary

Constructors

Constructor and Description
AccountFileStore()
AccountFileStore(File file)
AccountFileStore(Store fileStore) Takes any store, but make sure the store allows saving of POJOs, and not just key/value Strings
AccountFileStore(String file)

Method Summary

Modifier and Type	Method and Description
void	addDepositAddress(String id, int index, StoredDepositAddress request) Stores the deposit address under the given account with the used key index.
void	addPendingTransfer(String id, Hash tailTx, Trytes[] bundleTrytes, int... indices) Stores the pending transfer under the given account with the origin tail tx hash as a key and removes all deposit addresses which correspond to the used key indices for the transfer.
void	addTailHash(String id, Hash tailHash, Hash newTailTxHash) Adds the given new tail transaction hash (presumably from a reattachment) under the given pending transfer indexed by the given origin tail transaction hash.
ExportedAccountState	exportAccount(String id) Axports the given account from the store.
Map<Integer,StoredDepositAddress>	getDepositAddresses(String id) Loads the stored deposit addresses of the given account.
Map<String,PendingTransfer>	getPendingTransfers(String id) Returns all pending transfers of the given account.
void	importAccount(ExportedAccountState state) Imports the given account state into the store.
void	load() Loads this task
AccountState	loadAccount(String id) Loads an existing or allocates a new account state from/in the database and returns the state.
int	readIndex(String id) Reads and returns the last used key index.
void	removeAccount(String id) Removes the accoutn state linekd to this account.
void	removeDepositAddress(String id, int index) Removes the deposit address with the given key index under the given account.
void	removePendingTransfer(String id, Hash tailHash) Removes the pending transfer with the given origin tail transaction hash from the given account.
void	saveAccount(String id, AccountState state) Saves this specific account state to the store, regardless of what was stored.
void	shutdown() Stops this task.
boolean	start() Starts this task
String	toString()
void	writeIndex(String id, int index) Stores the given index as the last used key index for the given account.

Methods inherited from class org.iota.jota.account.store.AccountStoreImpl

trytesToTrits

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountFileStore

public AccountFileStore()

AccountFileStore

public AccountFileStore(File file)

AccountFileStore

public AccountFileStore(Store fileStore)

Takes any store, but make sure the store allows saving of POJOs, and not just key/value Strings

Parameters:

fileStore - Storage we use for reading/writing our account data

AccountFileStore

public AccountFileStore(String file)

Method Detail

load

public void load()
          throws Exception

Description copied from interface: TaskService

Loads this task

Throws:

Exception - when loading failed

start

public boolean start()

Description copied from interface: TaskService

Starts this task

Returns:

true if loaded successful. otherwise false

shutdown

public void shutdown()

Description copied from interface: TaskService

Stops this task.

loadAccount

public AccountState loadAccount(String id)

Description copied from interface: AccountStore

Loads an existing or allocates a new account state from/in the database and returns the state.

Parameters:

id - The account we are loading or creating

Returns:

The loaded account state

saveAccount

public void saveAccount(String id,
                        AccountState state)

Description copied from interface: AccountStore

Saves this specific account state to the store, regardless of what was stored.

Parameters:

id - The id of the account we are storing

state - The state we are storing for the account

removeAccount

public void removeAccount(String id)

Description copied from interface: AccountStore

Removes the accoutn state linekd to this account.

Parameters:

id - The id of the account

readIndex

public int readIndex(String id)

Description copied from interface: AccountStore

Reads and returns the last used key index.

Parameters:

id - The id of the account we check for

Returns:

The last used index, always at least 0

writeIndex

public void writeIndex(String id,
                       int index)

Description copied from interface: AccountStore

Stores the given index as the last used key index for the given account.

Parameters:

id - The id of the account

index - The new index of this account

addDepositAddress

public void addDepositAddress(String id,
                              int index,
                              StoredDepositAddress request)

Description copied from interface: AccountStore

Stores the deposit address under the given account with the used key index.

Parameters:

id - The id of the account

index - The index used for this address

request - The deposit address we are adding

removeDepositAddress

public void removeDepositAddress(String id,
                                 int index)

Description copied from interface: AccountStore

Removes the deposit address with the given key index under the given account.

Parameters:

id - The id of the account

index - The index of the deposit we are removing

getDepositAddresses

public Map<Integer,StoredDepositAddress> getDepositAddresses(String id)

Description copied from interface: AccountStore

Loads the stored deposit addresses of the given account.

Parameters:

id - The id of the account

Returns:

A map of deposit addresses with their stored index

addPendingTransfer

public void addPendingTransfer(String id,
                               Hash tailTx,
                               Trytes[] bundleTrytes,
                               int... indices)

Description copied from interface: AccountStore

Stores the pending transfer under the given account with the origin tail tx hash as a key and removes all deposit addresses which correspond to the used key indices for the transfer.

Parameters:

id - The id of the account

tailTx - The tail tx of this transfer

bundleTrytes - The trytes/essense of this transfer

indices - indexes to remove for this transfer, currently unused since we remove when we ask for inputs

removePendingTransfer

public void removePendingTransfer(String id,
                                  Hash tailHash)

Description copied from interface: AccountStore

Removes the pending transfer with the given origin tail transaction hash from the given account.

Parameters:

id - The id of the account

tailHash - The tail tx of the transfer we are remiving

addTailHash

public void addTailHash(String id,
                        Hash tailHash,
                        Hash newTailTxHash)

Description copied from interface: AccountStore

Adds the given new tail transaction hash (presumably from a reattachment) under the given pending transfer indexed by the given origin tail transaction hash.

Parameters:

id - The id of the account

tailHash - The tail tx of the initial transfer

newTailTxHash - The tail tx of the newly added transfer

getPendingTransfers

public Map<String,PendingTransfer> getPendingTransfers(String id)

Description copied from interface: AccountStore

Returns all pending transfers of the given account.

Parameters:

id - The id of the account

Returns:

A map of pending transfers linked to their initial tail tx hash

importAccount

public void importAccount(ExportedAccountState state)

Description copied from interface: AccountStore

Imports the given account state into the store. An existing account is overridden by this method.

Parameters:

state - The state of the account we are storing

exportAccount

public ExportedAccountState exportAccount(String id)

Description copied from interface: AccountStore

Axports the given account from the store.

Parameters:

id - The id of the account we want to export

Returns:

The exported account state

toString

public String toString()

Overrides:

toString in class Object