com.greatmancode.craftconomy3.storage.sql

Class SQLStorageEngine

java.lang.Object

com.greatmancode.craftconomy3.storage.StorageEngine

com.greatmancode.craftconomy3.storage.sql.SQLStorageEngine

Direct Known Subclasses:

H2Engine, MySQLEngine

public abstract class SQLStorageEngine
extends StorageEngine

Field Summary

Fields

Modifier and Type	Field and Description
protected AccessTable	accessTable
protected AccountTable	accountTable
protected BalanceTable	balanceTable
protected ConfigTable	configTable
protected CurrencyTable	currencyTable
protected com.zaxxer.hikari.HikariDataSource	db
protected ExchangeTable	exchangeTable
protected LogTable	logTable
protected java.lang.String	tablePrefix
protected WorldGroupTable	worldGroupTable

Constructor Summary

Constructors

Constructor and Description
SQLStorageEngine()

Method Summary

Modifier and Type	Method and Description
boolean	accountExist(java.lang.String name, boolean bankAccount) Checks if a account exist
void	cleanLog(java.sql.Timestamp timestamp) Clear the logs before the timestamp given
void	commit() Commit the changes.
boolean	deleteAccount(java.lang.String name, boolean bankAccount) Delete a account from the backend
void	deleteCurrency(Currency currency) Delete a currency from the storage
void	disable() Disable the storage engine.
void	disableAutoCommit() Disable auto-commit in the storage engine
void	enableAutoCommit() Enable auto-commit in the storage engine (default)
Account	getAccount(java.lang.String name, boolean bankAccount, boolean createDefault) Retrieve an account from the storage.
Account	getAccount(java.util.UUID uuid) Retrieve an account from the storage.
java.util.List<java.lang.String>	getAllAccounts(boolean bank) Retrieve all account names
java.util.List<Balance>	getAllBalance(Account account) Retrieve all the balance of an account
java.util.Map<java.lang.String,Currency>	getAllCurrencies() Retrieve all currencies
java.util.List<java.lang.String>	getAllCurrencyNames() Get the names of all the currencies in the system.
java.util.List<Balance>	getAllWorldBalance(Account account, java.lang.String worldName) Retrieve all balance from a world
double	getBalance(Account account, Currency currency, java.lang.String world) Retrieve the balance of an account
java.lang.String[]	getBankAccountList(java.lang.String sender) Retrieve the list of bank account this player have access to
java.lang.String	getConfigEntry(java.lang.String name) Retrieve the configuration value
Currency	getCurrency(java.lang.String name) Retrieve a currency
java.util.List<CurrencyRatesCommand.CurrencyRateEntry>	getCurrencyExchanges() Get the exchange rates of every currencies
double	getExchangeRate(Currency currency, Currency otherCurrency) Retrieve the exchange rate between 2 currencies
java.util.List<LogCommand.LogEntry>	getLog(Account user, int page) Get the logs of an account
java.util.List<TopCommand.TopEntry>	getTopEntry(int page, Currency currency, java.lang.String world) Retrieve a list of the top accounts
java.util.Map<java.lang.String,WorldGroup>	getWorldGroups() Get all the world groups in the system
void	removeWorldGroup(java.lang.String group) Remove a world group from the system
java.util.Map<java.lang.String,AccountACLValue>	retrieveACL(Account account) Retrieve the ACL listing for a bank account
java.lang.String	retrieveWorldGroupWorlds(java.lang.String name) Get the raw value of the world list of a world group.
AccountACLValue	saveACL(Account account, java.lang.String name, boolean deposit, boolean withdraw, boolean acl, boolean balance, boolean owner) Save the ACL setting of a bank account
void	saveCurrency(java.lang.String oldName, Currency currency) Save a currency in the backend
void	saveImporterUsers(java.util.List<Converter.User> userList) Save the converted accounts into the backend
void	saveLog(LogInfo info, Cause cause, java.lang.String causeReason, Account account, double amount, Currency currency, java.lang.String worldName) Write a transaction to the Log.
void	saveLog(LogInfo info, Cause cause, java.lang.String causeReason, Account account, double amount, Currency currency, java.lang.String worldName, java.sql.Timestamp timestamp)
void	saveWorldGroup(java.lang.String name, java.lang.String worldList) Save a world group
double	setBalance(Account account, double amount, Currency currency, java.lang.String world) Set the balance of the account
void	setConfigEntry(java.lang.String name, java.lang.String value) Set a configuration value in the database
void	setDefaultBankCurrency(Currency currency) Set the default bank creation currency.
void	setDefaultCurrency(Currency currency) Set the default currency of the system
void	setExchangeRate(Currency currency, Currency otherCurrency, double amount) Set the exchange between 2 currencies in the backend
void	setIgnoreACL(Account account, boolean ignoreACL) Set if the account must ignore the ACL
void	setInfiniteMoney(Account account, boolean infinite) Set if the account have infinite money
void	updateUsername(java.lang.String name, java.util.UUID uuid) Update the username in the account
void	updateUUID(java.lang.String name, java.util.UUID uuid) Set the UUID of the account if it exists

Methods inherited from class com.greatmancode.craftconomy3.storage.StorageEngine

getAccount

Methods inherited from class java.lang.Object

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

Field Detail

tablePrefix

protected java.lang.String tablePrefix

db

protected com.zaxxer.hikari.HikariDataSource db

accessTable

protected AccessTable accessTable

accountTable

protected AccountTable accountTable

balanceTable

protected BalanceTable balanceTable

configTable

protected ConfigTable configTable

currencyTable

protected CurrencyTable currencyTable

exchangeTable

protected ExchangeTable exchangeTable

logTable

protected LogTable logTable

worldGroupTable

protected WorldGroupTable worldGroupTable

Constructor Detail

SQLStorageEngine

public SQLStorageEngine()

Method Detail

disable

public void disable()

Description copied from class: StorageEngine

Disable the storage engine.

Specified by:

disable in class StorageEngine

getAccount

public Account getAccount(java.lang.String name,
                          boolean bankAccount,
                          boolean createDefault)

Description copied from class: StorageEngine

Retrieve an account from the storage. If it doesn't exist, it must be created

Specified by:

getAccount in class StorageEngine

Parameters:

name - The account name

bankAccount - If the account is a bank account or not

createDefault - If it adds the default balance in or not

Returns:

An Account

getAccount

public Account getAccount(java.util.UUID uuid)

Description copied from class: StorageEngine

Retrieve an account from the storage. Doesn't care if it doesn't exist.

Specified by:

getAccount in class StorageEngine

Parameters:

uuid - The UUID of the player

Returns:

An Account if an account was found, else null

getAllAccounts

public java.util.List<java.lang.String> getAllAccounts(boolean bank)

Description copied from class: StorageEngine

Retrieve all account names

Specified by:

getAllAccounts in class StorageEngine

Parameters:

bank - If we want to retrieve the bank accounts or not

Returns:

A List of all accounts

saveLog

public void saveLog(LogInfo info,
                    Cause cause,
                    java.lang.String causeReason,
                    Account account,
                    double amount,
                    Currency currency,
                    java.lang.String worldName)

Description copied from class: StorageEngine

Write a transaction to the Log.

Specified by:

saveLog in class StorageEngine

Parameters:

info - The type of transaction to log.

cause - The cause of the transaction.

causeReason - The reason of the cause

account - The account being impacted by the change

amount - The amount of money in this transaction.

currency - The currency associated with this transaction

worldName - The world name associated with this transaction

saveLog

public void saveLog(LogInfo info,
                    Cause cause,
                    java.lang.String causeReason,
                    Account account,
                    double amount,
                    Currency currency,
                    java.lang.String worldName,
                    java.sql.Timestamp timestamp)

Specified by:

saveLog in class StorageEngine

getConfigEntry

public java.lang.String getConfigEntry(java.lang.String name)

Description copied from class: StorageEngine

Retrieve the configuration value

Specified by:

getConfigEntry in class StorageEngine

Parameters:

name - The name of the value

Returns:

The configuration value or null if the entry was not found

setConfigEntry

public void setConfigEntry(java.lang.String name,
                           java.lang.String value)

Description copied from class: StorageEngine

Set a configuration value in the database

Specified by:

setConfigEntry in class StorageEngine

Parameters:

name - The name of the value

value - The actual value

getAllBalance

public java.util.List<Balance> getAllBalance(Account account)

Description copied from class: StorageEngine

Retrieve all the balance of an account

Specified by:

getAllBalance in class StorageEngine

Parameters:

account - The account to retrieve the balance from

Returns:

A list of { @link Balance }

getAllWorldBalance

public java.util.List<Balance> getAllWorldBalance(Account account,
                                                  java.lang.String worldName)

Description copied from class: StorageEngine

Retrieve all balance from a world

Specified by:

getAllWorldBalance in class StorageEngine

Parameters:

account - The account to retrieve the balance from

worldName - The world group to retrieve the balance from

Returns:

A list of { @link Balance }

getBalance

public double getBalance(Account account,
                         Currency currency,
                         java.lang.String world)

Description copied from class: StorageEngine

Retrieve the balance of an account

Specified by:

getBalance in class StorageEngine

Parameters:

account - The account to retrieve the balance from

currency - The currency

world - The world group

Returns:

the balance

setBalance

public double setBalance(Account account,
                         double amount,
                         Currency currency,
                         java.lang.String world)

Description copied from class: StorageEngine

Set the balance of the account

Specified by:

setBalance in class StorageEngine

Parameters:

account - The account that the balance is set in.

amount - The amount of money being placed

currency - The Currency

world - The world group

Returns:

The balance

setInfiniteMoney

public void setInfiniteMoney(Account account,
                             boolean infinite)

Description copied from class: StorageEngine

Set if the account have infinite money

Specified by:

setInfiniteMoney in class StorageEngine

Parameters:

account - The account to modify

infinite - If the account have infinite money or not

setIgnoreACL

public void setIgnoreACL(Account account,
                         boolean ignoreACL)

Description copied from class: StorageEngine

Set if the account must ignore the ACL

Specified by:

setIgnoreACL in class StorageEngine

Parameters:

account - The account to modify

ignoreACL - If the account must ignore the ACL or not

retrieveACL

public java.util.Map<java.lang.String,AccountACLValue> retrieveACL(Account account)

Description copied from class: StorageEngine

Retrieve the ACL listing for a bank account

Specified by:

retrieveACL in class StorageEngine

Parameters:

account - The bank account

Returns:

A Map of all the ACL entries

saveACL

public AccountACLValue saveACL(Account account,
                               java.lang.String name,
                               boolean deposit,
                               boolean withdraw,
                               boolean acl,
                               boolean balance,
                               boolean owner)

Description copied from class: StorageEngine

Save the ACL setting of a bank account

Specified by:

saveACL in class StorageEngine

Parameters:

account - The account

name - The player name

deposit - If the player can deposit

withdraw - If the player can withdraw

acl - If the player can modify the ACL

balance - If the player can show the balance

owner - If the player is the owner

Returns:

The value for ACL to put in the account.

getExchangeRate

public double getExchangeRate(Currency currency,
                              Currency otherCurrency)
                       throws NoExchangeRate

Description copied from class: StorageEngine

Retrieve the exchange rate between 2 currencies

Specified by:

getExchangeRate in class StorageEngine

Parameters:

currency - The currency to convert from

otherCurrency - The currency to convert to

Returns:

The exchange rate.

Throws:

NoExchangeRate - If there's no exchange rate, this event is thrown.

setExchangeRate

public void setExchangeRate(Currency currency,
                            Currency otherCurrency,
                            double amount)

Description copied from class: StorageEngine

Set the exchange between 2 currencies in the backend

Specified by:

setExchangeRate in class StorageEngine

Parameters:

currency - The currency to convert from

otherCurrency - The currency to convert to

amount - The exchange rate (Example: 1.3 will make 1 Currency transform to 1.3 otherCurrency)

saveCurrency

public void saveCurrency(java.lang.String oldName,
                         Currency currency)

Description copied from class: StorageEngine

Save a currency in the backend

Specified by:

saveCurrency in class StorageEngine

Parameters:

oldName - The name of the currency if overriding a existing currency

currency - The currency to save

deleteCurrency

public void deleteCurrency(Currency currency)

Description copied from class: StorageEngine

Delete a currency from the storage

Specified by:

deleteCurrency in class StorageEngine

Parameters:

currency - The currency to delete

updateUsername

public void updateUsername(java.lang.String name,
                           java.util.UUID uuid)

Description copied from class: StorageEngine

Update the username in the account

Specified by:

updateUsername in class StorageEngine

Parameters:

name - The name of the player

uuid - The UUID of the player

updateUUID

public void updateUUID(java.lang.String name,
                       java.util.UUID uuid)

Description copied from class: StorageEngine

Set the UUID of the account if it exists

Specified by:

updateUUID in class StorageEngine

Parameters:

name - The player name

uuid - the UUID of the player

getWorldGroups

public java.util.Map<java.lang.String,WorldGroup> getWorldGroups()

Description copied from class: StorageEngine

Get all the world groups in the system

Specified by:

getWorldGroups in class StorageEngine

Returns:

A map of the world groups.

removeWorldGroup

public void removeWorldGroup(java.lang.String group)

Description copied from class: StorageEngine

Remove a world group from the system

Specified by:

removeWorldGroup in class StorageEngine

Parameters:

group - The name of the world group

getBankAccountList

public java.lang.String[] getBankAccountList(java.lang.String sender)

Description copied from class: StorageEngine

Retrieve the list of bank account this player have access to

Specified by:

getBankAccountList in class StorageEngine

Parameters:

sender - The player name

Returns:

A String array of the accounts.

getLog

public java.util.List<LogCommand.LogEntry> getLog(Account user,
                                                  int page)

Description copied from class: StorageEngine

Get the logs of an account

Specified by:

getLog in class StorageEngine

Parameters:

user - The account to retrieve the log from

page - The page number of the entry.

Returns:

A list of actions from an account

getTopEntry

public java.util.List<TopCommand.TopEntry> getTopEntry(int page,
                                                       Currency currency,
                                                       java.lang.String world)

Description copied from class: StorageEngine

Retrieve a list of the top accounts

Specified by:

getTopEntry in class StorageEngine

Parameters:

page - The page number

currency - The currency

world - The world group.

Returns:

A list of the top accounts

getCurrencyExchanges

public java.util.List<CurrencyRatesCommand.CurrencyRateEntry> getCurrencyExchanges()

Description copied from class: StorageEngine

Get the exchange rates of every currencies

Specified by:

getCurrencyExchanges in class StorageEngine

Returns:

A list of the exchange rates

cleanLog

public void cleanLog(java.sql.Timestamp timestamp)

Description copied from class: StorageEngine

Clear the logs before the timestamp given

Specified by:

cleanLog in class StorageEngine

Parameters:

timestamp - The lowest date a log entry can have

deleteAccount

public boolean deleteAccount(java.lang.String name,
                             boolean bankAccount)

Description copied from class: StorageEngine

Delete a account from the backend

Specified by:

deleteAccount in class StorageEngine

Parameters:

name - The name of the account

bankAccount - If the account is a bank account or not

Returns:

True if the account is deleted, else false.

accountExist

public boolean accountExist(java.lang.String name,
                            boolean bankAccount)

Description copied from class: StorageEngine

Checks if a account exist

Specified by:

accountExist in class StorageEngine

Parameters:

name - The name of the account

bankAccount - If the account is a bank account or not

Returns:

True if the account exists, else false.

saveWorldGroup

public void saveWorldGroup(java.lang.String name,
                           java.lang.String worldList)

Description copied from class: StorageEngine

Save a world group

Specified by:

saveWorldGroup in class StorageEngine

Parameters:

name - The name of the world group.

worldList - The worlds being in this world group seperated by , .

getAllCurrencyNames

public java.util.List<java.lang.String> getAllCurrencyNames()

Description copied from class: StorageEngine

Get the names of all the currencies in the system.

Specified by:

getAllCurrencyNames in class StorageEngine

Returns:

A list of all the currencies

setDefaultCurrency

public void setDefaultCurrency(Currency currency)

Description copied from class: StorageEngine

Set the default currency of the system

Specified by:

setDefaultCurrency in class StorageEngine

Parameters:

currency - The currency to set as default

setDefaultBankCurrency

public void setDefaultBankCurrency(Currency currency)

Description copied from class: StorageEngine

Set the default bank creation currency.

Specified by:

setDefaultBankCurrency in class StorageEngine

Parameters:

currency - The currency

getCurrency

public Currency getCurrency(java.lang.String name)

Description copied from class: StorageEngine

Retrieve a currency

Specified by:

getCurrency in class StorageEngine

Parameters:

name - The name of the currency

Returns:

The currency if it exists else null

getAllCurrencies

public java.util.Map<java.lang.String,Currency> getAllCurrencies()

Description copied from class: StorageEngine

Retrieve all currencies

Specified by:

getAllCurrencies in class StorageEngine

Returns:

A map of the currencies.

retrieveWorldGroupWorlds

public java.lang.String retrieveWorldGroupWorlds(java.lang.String name)

Description copied from class: StorageEngine

Get the raw value of the world list of a world group.

Specified by:

retrieveWorldGroupWorlds in class StorageEngine

Parameters:

name - The name of the world group.

Returns:

The list of worlds in a string seperated by commas (,)

saveImporterUsers

public void saveImporterUsers(java.util.List<Converter.User> userList)

Description copied from class: StorageEngine

Save the converted accounts into the backend

Specified by:

saveImporterUsers in class StorageEngine

Parameters:

userList - The user list being converted

disableAutoCommit

public void disableAutoCommit()

Description copied from class: StorageEngine

Disable auto-commit in the storage engine

Specified by:

disableAutoCommit in class StorageEngine

enableAutoCommit

public void enableAutoCommit()

Description copied from class: StorageEngine

Enable auto-commit in the storage engine (default)

Specified by:

enableAutoCommit in class StorageEngine

commit

public void commit()

Description copied from class: StorageEngine

Commit the changes. Only works when autocommit is disabled

Specified by:

commit in class StorageEngine