nxt.http

Class APICall.Builder<T extends APICall.Builder>

java.lang.Object

nxt.http.APICall.Builder<T>

Direct Known Subclasses:

AddPeerCall, BlacklistAPIProxyPeerCall, BlacklistBundlerCall, BlacklistPeerCall, BootstrapAPIProxyCall, BroadcastTransactionCall, CalculateFeeCall, CalculateFullHashCall, CanDeleteCurrencyCall, ChainSpecificCallBuilder, ClearUnconfirmedTransactionsCall, CombineSecretCall, DecodeFileTokenCall, DecodeQRCodeCall, DecodeTokenCall, DecryptFromCall, DeriveAccountFromMasterPublicKeyCall, DeriveAccountFromSeedCall, DetectMimeTypeCall, DumpPeersCall, EncodeQRCodeCall, EncryptToCall, EvaluateExpressionCall, EventRegisterCall, EventWaitCall, FullHashToIdCall, FullResetCall, GenerateFileTokenCall, GenerateTokenCall, GetAccountAssetCountCall, GetAccountAssetsCall, GetAccountBlockCountCall, GetAccountBlockIdsCall, GetAccountBlocksCall, GetAccountCall, GetAccountCurrenciesCall, GetAccountCurrencyCountCall, GetAccountIdCall, GetAccountLedgerCall, GetAccountLedgerEntryCall, GetAccountLessorsCall, GetAccountPropertiesCall, GetAccountPublicKeyCall, GetAllAssetsCall, GetAllBroadcastedTransactionsCall, GetAllBundlerRatesCall, GetAllCurrenciesCall, GetAllPhasingOnlyControlsCall, GetAllWaitingTransactionsCall, GetAPIProxyReportsCall, GetAssetAccountCountCall, GetAssetAccountsCall, GetAssetCall, GetAssetHistoryCall, GetAssetIdsCall, GetAssetPropertiesCall, GetAssetsByIssuerCall, GetAssetsCall, GetAssetTransfersCall, GetBlockCall, GetBlockchainStatusCall, GetBlockIdCall, GetBlocksCall, GetBundlerRatesCall, GetBundlingOptionsCall, GetCoinExchangeOrderCall, GetCoinExchangeTradeCall, GetConfigurationCall, GetConstantsCall, GetContractReferencesCall, GetCurrenciesByIssuerCall, GetCurrenciesCall, GetCurrencyAccountCountCall, GetCurrencyAccountsCall, GetCurrencyIdsCall, GetCurrencyTransfersCall, GetECBlockCall, GetEffectiveBalanceCall, GetEpochTimeCall, GetForgingCall, GetFxtTransactionCall, GetGuaranteedBalanceCall, GetHashedSecretPhasedTransactionsCall, GetLedgerMasterPublicKeyCall, GetLinkedPhasedTransactionsCall, GetLogCall, GetMintingTargetCall, GetMyInfoCall, GetNextBlockGeneratorsCall, GetPeerCall, GetPeersCall, GetPhasingAssetControlCall, GetPhasingOnlyControlCall, GetPluginsCall, GetSharedKeyCall, GetShufflersCall, GetStackTracesCall, GetSupportedContractsCall, GetTimeCall, HashCall, HexConvertCall, LongConvertCall, LuceneReindexCall, ManagePeersNetworkingCall, ParsePhasingParamsCall, ParseTransactionCall, PopOffCall, ProcessVoucherCall, RebroadcastUnconfirmedTransactionsCall, RequeueUnconfirmedTransactionsCall, RsConvertCall, SaveContractRunnerEncryptedCall, ScanCall, SearchAccountsCall, SearchAssetsCall, SearchCurrenciesCall, SendTransactionCall, SetAPIProxyPeerCall, SetConfigurationCall, SetLoggingCall, ShutdownCall, SignTransactionCall, SplitSecretCall, StartContractRunnerEncryptedCall, StartForgingCall, StopForgingCall, StopShufflerCall, TaxReportCall, TriggerContractByHeightCall, TriggerContractByRequestCall, TriggerContractByVoucherCall, TrimDerivedTablesCall, UploadContractRunnerConfigurationCall

Enclosing class:

APICall

public static class APICall.Builder<T extends APICall.Builder>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	params

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(ApiSpec apiSpec)
protected	Builder(java.lang.String requestType, java.util.List<java.lang.String> validParams, java.util.List<java.lang.String> validFileParams, boolean isChainSpecific)

Method Summary

Modifier and Type	Method and Description
APICall	build()
JO	call()
JO	callNoError()
byte[]	download()
BlockResponse	getBlock()
java.util.List<BlockResponse>	getBlocks()
Chain	getChain()
TransactionResponse	getCreatedTransaction() Use to parse responses of create transaction API
java.util.List<TransactionResponse>	getCreatedTransactions() Response from CreateTransaction calls wraps the transactions inside a transactionJSON object
java.lang.String	getParam(java.lang.String key)
TransactionResponse	getTransaction() Use to parse responses of APIs which return a transaction object like getTransaction
java.util.List<TransactionResponse>	getTransactions() Use with any API which returns a "transactions" json array
java.util.List<TransactionResponse>	getTransactions(java.lang.String arrayName) Use in case the response transaction array has a different name
boolean	isParamSet(java.lang.String key)
boolean	isRemoteOnly()
T	param(java.lang.String key, boolean value)
T	param(java.lang.String key, byte value)
T	param(java.lang.String key, byte[] value)
T	param(java.lang.String key, byte[][] value)
T	param(java.lang.String key, int... intArray)
T	param(java.lang.String key, int value)
T	param(java.lang.String key, java.util.List<java.lang.String> values)
T	param(java.lang.String key, long... longArray)
T	param(java.lang.String key, long value)
T	param(java.lang.String key, java.lang.String value)
T	param(java.lang.String key, java.lang.String[] values)
T	parts(java.lang.String key, byte[] b)
T	privateKey(byte[] value)
T	privateKey(java.lang.String value)
T	remote(java.net.URL url)
T	secretPhrase(java.lang.String value)
T	setParamValidation(boolean isEnabled)
T	sharedPiece(java.lang.String... sharedPiece)
T	sharedPieceAccount(java.lang.String value)
T	trustRemoteCertificate(boolean trustRemoteCertificate)
T	unsignedLongParam(java.lang.String key, long... longArray)
T	unsignedLongParam(java.lang.String key, long value)

Methods inherited from class java.lang.Object

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

Field Detail

params

protected final java.util.Map<java.lang.String,java.util.List<java.lang.String>> params

Constructor Detail

Builder

protected Builder(ApiSpec apiSpec)

Builder

protected Builder(java.lang.String requestType,
                  java.util.List<java.lang.String> validParams,
                  java.util.List<java.lang.String> validFileParams,
                  boolean isChainSpecific)

Method Detail

remote

public T remote(java.net.URL url)

trustRemoteCertificate

public T trustRemoteCertificate(boolean trustRemoteCertificate)

isRemoteOnly

public boolean isRemoteOnly()

setParamValidation

public T setParamValidation(boolean isEnabled)

param

public T param(java.lang.String key,
               java.lang.String value)

param

public T param(java.lang.String key,
               java.lang.String[] values)

param

public T param(java.lang.String key,
               java.util.List<java.lang.String> values)

param

public T param(java.lang.String key,
               boolean value)

param

public T param(java.lang.String key,
               byte value)

param

public T param(java.lang.String key,
               int value)

param

public T param(java.lang.String key,
               int... intArray)

param

public T param(java.lang.String key,
               long value)

param

public T param(java.lang.String key,
               long... longArray)

unsignedLongParam

public T unsignedLongParam(java.lang.String key,
                           long value)

unsignedLongParam

public T unsignedLongParam(java.lang.String key,
                           long... longArray)

param

public T param(java.lang.String key,
               byte[] value)

param

public T param(java.lang.String key,
               byte[][] value)

secretPhrase

public T secretPhrase(java.lang.String value)

privateKey

public T privateKey(byte[] value)

privateKey

public T privateKey(java.lang.String value)

sharedPiece

public T sharedPiece(java.lang.String... sharedPiece)

sharedPieceAccount

public T sharedPieceAccount(java.lang.String value)

getParam

public java.lang.String getParam(java.lang.String key)

getChain

public Chain getChain()

isParamSet

public boolean isParamSet(java.lang.String key)

parts

public T parts(java.lang.String key,
               byte[] b)

build

public APICall build()

call

public JO call()

callNoError

public JO callNoError()

download

public byte[] download()

getTransactions

public java.util.List<TransactionResponse> getTransactions()

Use with any API which returns a "transactions" json array

Returns:

list of transaction objects

getTransactions

public java.util.List<TransactionResponse> getTransactions(java.lang.String arrayName)

Use in case the response transaction array has a different name

Parameters:

arrayName - the name of the transaction array

Returns:

list of transaction objects

getCreatedTransactions

public java.util.List<TransactionResponse> getCreatedTransactions()

Response from CreateTransaction calls wraps the transactions inside a transactionJSON object

Returns:

list of transaction objects

getTransaction

public TransactionResponse getTransaction()

Use to parse responses of APIs which return a transaction object like getTransaction

Returns:

transaction object

getCreatedTransaction

public TransactionResponse getCreatedTransaction()

Use to parse responses of create transaction API

Returns:

transaction object

getBlocks

public java.util.List<BlockResponse> getBlocks()

getBlock

public BlockResponse getBlock()