com.beowulfchain.beowulfj.plugins.apis.database

Class DatabaseApi

java.lang.Object

com.beowulfchain.beowulfj.plugins.apis.database.DatabaseApi

public class DatabaseApi
extends Object

This class implements the "database_api".

Method Summary

Modifier and Type	Method and Description
static List<AccountName>	getActiveSupernodes(CommunicationHandler communicationHandler) Get the list of the current active supernodes.
static Config	getConfig(CommunicationHandler communicationHandler) Get the configuration.
static DynamicGlobalProperty	getDynamicGlobalProperties(CommunicationHandler communicationHandler) Get the global properties.
static GetPotentialSignaturesReturn	getPotentialSignatures(CommunicationHandler communicationHandler, GetPotentialSignaturesArgs getPotentialSignaturesArgs)
static GetRequiredSignaturesReturn	getRequiredSignatures(CommunicationHandler communicationHandler, GetRequiredSignaturesArgs getRequiredSignaturesArgs)
static SupernodeSchedule	getSupernodeSchedule(CommunicationHandler communicationHandler) Get the supernode schedule.
static GetTransactionHexReturn	getTransactionHex(CommunicationHandler communicationHandler, GetTransactionHexArgs getTransactionHexArgs)
static VerifyAccountAuthorityReturn	verifyAccountAuthority(CommunicationHandler communicationHandler, VerifyAccountAuthorityArgs verifyAccountAuthorityArgs)
static VerifyAuthorityReturn	verifyAuthority(CommunicationHandler communicationHandler, VerifyAuthorityArgs verifyAuthorityArgs)

Methods inherited from class java.lang.Object

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

Method Detail

getConfig

public static Config getConfig(CommunicationHandler communicationHandler)
                        throws BeowulfCommunicationException,
                               BeowulfResponseException

Get the configuration.

Parameters:

communicationHandler - The communication handler.

Returns:

The beowulf configuration.

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getDynamicGlobalProperties

public static DynamicGlobalProperty getDynamicGlobalProperties(CommunicationHandler communicationHandler)
                                                        throws BeowulfCommunicationException,
                                                               BeowulfResponseException

Get the global properties.

Parameters:

communicationHandler - The communication handler.

Returns:

The dynamic global properties.

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getSupernodeSchedule

public static SupernodeSchedule getSupernodeSchedule(CommunicationHandler communicationHandler)
                                              throws BeowulfCommunicationException,
                                                     BeowulfResponseException

Get the supernode schedule.

Parameters:

communicationHandler - The communication handler.

Returns:

The supernode schedule.

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getActiveSupernodes

public static List<AccountName> getActiveSupernodes(CommunicationHandler communicationHandler)
                                             throws BeowulfCommunicationException,
                                                    BeowulfResponseException

Get the list of the current active supernodes.

Parameters:

communicationHandler - A CommunicationHandler instance that should be used to send the request.

Returns:

The list of the current active supernodes.

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getTransactionHex

public static GetTransactionHexReturn getTransactionHex(CommunicationHandler communicationHandler,
                                                        GetTransactionHexArgs getTransactionHexArgs)
                                                 throws BeowulfCommunicationException,
                                                        BeowulfResponseException

Parameters:

communicationHandler - The communication handler.

getTransactionHexArgs - The TransactionHexArgs.

Returns:

GetTransactionHexReturn

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getRequiredSignatures

public static GetRequiredSignaturesReturn getRequiredSignatures(CommunicationHandler communicationHandler,
                                                                GetRequiredSignaturesArgs getRequiredSignaturesArgs)
                                                         throws BeowulfCommunicationException,
                                                                BeowulfResponseException

Parameters:

communicationHandler - The communication handler.

getRequiredSignaturesArgs - The RequiredSignaturesArgs.

Returns:

GetRequiredSignaturesReturn The GetRequiredSignaturesReturn.

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

getPotentialSignatures

public static GetPotentialSignaturesReturn getPotentialSignatures(CommunicationHandler communicationHandler,
                                                                  GetPotentialSignaturesArgs getPotentialSignaturesArgs)
                                                           throws BeowulfCommunicationException,
                                                                  BeowulfResponseException

Parameters:

communicationHandler - The communication handler.

getPotentialSignaturesArgs - The PotentialSignaturesArgs.

Returns:

GetPotentialSignaturesReturn The GetPotentialSignaturesReturn

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

verifyAuthority

public static VerifyAuthorityReturn verifyAuthority(CommunicationHandler communicationHandler,
                                                    VerifyAuthorityArgs verifyAuthorityArgs)
                                             throws BeowulfCommunicationException,
                                                    BeowulfResponseException

Parameters:

communicationHandler - The communication handler.

verifyAuthorityArgs - The verify Authority Args.

Returns:

VerifyAuthorityReturn The VerifyAuthorityReturn.

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.

verifyAccountAuthority

public static VerifyAccountAuthorityReturn verifyAccountAuthority(CommunicationHandler communicationHandler,
                                                                  VerifyAccountAuthorityArgs verifyAccountAuthorityArgs)
                                                           throws BeowulfCommunicationException,
                                                                  BeowulfResponseException

Parameters:

communicationHandler - The communication handler.

verifyAccountAuthorityArgs - The verifyAccountAuthorityArgs.

Returns:

VerifyAccountAuthorityReturn The VerifyAccountAuthorityReturn.

Throws:

BeowulfCommunicationException -

• If the server was not able to answer the request in the given time (see setResponseTimeout).
• If there is a connection problem.

BeowulfResponseException -

• If the BeowulfJ is unable to transform the JSON response into a Java object.
• If the Server returned an error object.