com.scalar.dl.ledger.config

Class LedgerConfig

java.lang.Object

com.scalar.dl.ledger.config.LedgerConfig

All Implemented Interfaces:

com.scalar.dl.ledger.config.ServerConfig, com.scalar.dl.ledger.config.ServersHmacAuthenticatable

@Immutable
public class LedgerConfig
extends java.lang.Object
implements com.scalar.dl.ledger.config.ServerConfig, com.scalar.dl.ledger.config.ServersHmacAuthenticatable

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUDITOR_CERT_HOLDER_ID Deprecated. This will be deleted in release 5.0.0 since Ledger-Auditor authentication will use HMAC only.
static java.lang.String	AUDITOR_CERT_VERSION Deprecated. This will be deleted in release 5.0.0 since Ledger-Auditor authentication will use HMAC only.
static java.lang.String	AUDITOR_ENABLED scalar.dl.ledger.auditor.enabled A flag to enable Auditor (false by default).
static java.lang.String	AUTHENTICATION_HMAC_CIPHER_KEY scalar.dl.ledger.authentication.hmac.cipher_key (Optional) A cipher key used to encrypt and decrypt the HMAC secret keys of client entities.
static java.lang.String	AUTHENTICATION_METHOD scalar.dl.ledger.authentication.method (Optional) The authentication method for a client and servers.
static java.lang.String	DIRECT_ASSET_ACCESS_ENABLED scalar.dl.ledger.direct_asset_access.enabled A flag to access asset table directly without going through asset_metadata (false by default).
static java.lang.String	EXECUTABLE_CONTRACTS scalar.dl.ledger.executable_contracts Binary names of contracts that can be executed.
static java.lang.String	FUNCTION_ENABLED scalar.dl.ledger.function.enabled A flag to enable function for mutable database (true by default).
static java.lang.String	NAME scalar.dl.ledger.name (Optional) Name of ledger ("Scalar Ledger" by default).
static java.lang.String	NAMESPACE scalar.dl.ledger.namespace (Optional) Namespace of ledger tables ("scalar" by default)
static java.lang.String	NONCE_TXID_ENABLED scalar.dl.ledger.nonce_txid.enabled A flag to use nonce as a transaction ID (true by default).
static java.lang.String	PROOF_ENABLED scalar.dl.ledger.proof.enabled A flag to enable asset proof that is used to verify assets (false by default).
static java.lang.String	PROOF_PRIVATE_KEY_PATH scalar.dl.ledger.proof.private_key_path The path of a private key file in PEM format.
static java.lang.String	PROOF_PRIVATE_KEY_PEM scalar.dl.ledger.proof.private_key_pem PEM-encoded private key data.
static java.lang.String	SERVER_ADMIN_PORT scalar.dl.ledger.server.admin_port Server admin port (50053 by default).
static java.lang.String	SERVER_DECOMMISSIONING_DURATION_SECS scalar.dl.ledger.server.decommissioning_duration_secs (Optional) Decommissioning duration (30 seconds by default) where the servers are running but returning NOT_SERVING to a gRPC health check request.
static java.lang.String	SERVER_GRPC_MAX_INBOUND_MESSAGE_SIZE scalar.dl.ledger.server.grpc.max_inbound_message_size (Optional) The maximum message size allowed for a single gRPC frame.
static java.lang.String	SERVER_GRPC_MAX_INBOUND_METADATA_SIZE scalar.dl.ledger.server.grpc.max_inbound_metadata_size (Optional) The maximum size of metadata allowed to be received.
static java.lang.String	SERVER_PORT scalar.dl.ledger.server.port Server port (50051 by default).
static java.lang.String	SERVER_PRIVILEGED_PORT scalar.dl.ledger.server.privileged_port Server privileged port (50052 by default).
static java.lang.String	SERVER_PROMETHEUS_EXPORTER_PORT scalar.dl.ledger.server.prometheus_exporter_port Prometheus exporter port (8080 by default).
static java.lang.String	SERVER_TLS_CERT_CHAIN_PATH scalar.dl.ledger.server.tls.cert_chain_path Certificate chain file used for TLS communication.
static java.lang.String	SERVER_TLS_ENABLED scalar.dl.ledger.server.tls.enabled A flag to enable TLS between clients and servers (false by default).
static java.lang.String	SERVER_TLS_PRIVATE_KEY_PATH scalar.dl.ledger.server.tls.private_key_path Private key file used for TLS communication.
static java.lang.String	SERVERS_AUTHENTICATION_HMAC_SECRET_KEY scalar.dl.ledger.servers.authentication.hmac.secret_key A secret key of HMAC for the authentication of messages between (Ledger and Auditor) servers.
static java.lang.String	TX_STATE_MANAGEMENT_ENABLED scalar.dl.ledger.tx_state_management.enabled A flag to manage transaction states by Ledger (false by default).

Constructor Summary

Constructors

Constructor and Description
LedgerConfig(java.io.File propertiesFile)
LedgerConfig(java.io.InputStream stream)
LedgerConfig(java.util.Properties properties)

Method Summary

Modifier and Type	Method and Description
protected void	finalize() SpotBugs detects Bug Type "CT_CONSTRUCTOR_THROW" saying that "The object under construction remains partially initialized and may be vulnerable to Finalizer attacks."
int	getAdminPort()
java.lang.String	getAuditorCertHolderId() Deprecated.
int	getAuditorCertVersion() Deprecated.
com.scalar.dl.ledger.config.AuthenticationMethod	getAuthenticationMethod()
com.scalar.db.config.DatabaseConfig	getDatabaseConfig()
int	getDecommissioningDurationSecs()
java.util.Set<java.lang.String>	getExecutableContractNames()
com.scalar.dl.ledger.config.GrpcServerConfig	getGrpcServerConfig()
java.lang.String	getHmacCipherKey()
java.lang.String	getName()
java.lang.String	getNamespace()
int	getPort()
int	getPrivilegedPort()
java.lang.String	getProductName()
int	getPrometheusExporterPort()
java.lang.String	getProofPrivateKey()
java.lang.String	getServersAuthenticationHmacSecretKey()
java.lang.String	getServerTlsCertChainPath()
java.lang.String	getServerTlsPrivateKeyPath()
java.lang.String	getServiceName()
boolean	isAuditorEnabled()
boolean	isDirectAssetAccessEnabled()
boolean	isFunctionEnabled()
boolean	isNonceTxidEnabled()
boolean	isProofEnabled()
boolean	isServerTlsEnabled()
boolean	isTxStateManagementEnabled()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

scalar.dl.ledger.name (Optional)
Name of ledger ("Scalar Ledger" by default). It is used to identify a ledger.

See Also:

Constant Field Values

NAMESPACE

public static final java.lang.String NAMESPACE

scalar.dl.ledger.namespace (Optional)
Namespace of ledger tables ("scalar" by default)

See Also:

Constant Field Values

AUTHENTICATION_METHOD

public static final java.lang.String AUTHENTICATION_METHOD

scalar.dl.ledger.authentication.method (Optional)
The authentication method for a client and servers. ("digital-signature" by default) This has to be consistent with the client configuration.

See Also:

Constant Field Values

AUTHENTICATION_HMAC_CIPHER_KEY

public static final java.lang.String AUTHENTICATION_HMAC_CIPHER_KEY

scalar.dl.ledger.authentication.hmac.cipher_key (Optional)
A cipher key used to encrypt and decrypt the HMAC secret keys of client entities. This variable is used only when scalar.dl.ledger.authentication.method is "hmac". Please set an unpredictable and long enough value.

See Also:

Constant Field Values

SERVER_PORT

public static final java.lang.String SERVER_PORT

scalar.dl.ledger.server.port
Server port (50051 by default).

See Also:

Constant Field Values

SERVER_PRIVILEGED_PORT

public static final java.lang.String SERVER_PRIVILEGED_PORT

scalar.dl.ledger.server.privileged_port
Server privileged port (50052 by default).

See Also:

Constant Field Values

SERVER_ADMIN_PORT

public static final java.lang.String SERVER_ADMIN_PORT

scalar.dl.ledger.server.admin_port
Server admin port (50053 by default).

See Also:

Constant Field Values

SERVER_PROMETHEUS_EXPORTER_PORT

public static final java.lang.String SERVER_PROMETHEUS_EXPORTER_PORT

scalar.dl.ledger.server.prometheus_exporter_port
Prometheus exporter port (8080 by default). Prometheus exporter will not be started if a negative number is given.

See Also:

Constant Field Values

SERVER_DECOMMISSIONING_DURATION_SECS

public static final java.lang.String SERVER_DECOMMISSIONING_DURATION_SECS

scalar.dl.ledger.server.decommissioning_duration_secs (Optional)
Decommissioning duration (30 seconds by default) where the servers are running but returning NOT_SERVING to a gRPC health check request.

See Also:

Constant Field Values

SERVER_TLS_ENABLED

public static final java.lang.String SERVER_TLS_ENABLED

scalar.dl.ledger.server.tls.enabled
A flag to enable TLS between clients and servers (false by default).

See Also:

Constant Field Values

SERVER_TLS_CERT_CHAIN_PATH

public static final java.lang.String SERVER_TLS_CERT_CHAIN_PATH

scalar.dl.ledger.server.tls.cert_chain_path
Certificate chain file used for TLS communication.

See Also:

Constant Field Values

SERVER_TLS_PRIVATE_KEY_PATH

public static final java.lang.String SERVER_TLS_PRIVATE_KEY_PATH

scalar.dl.ledger.server.tls.private_key_path
Private key file used for TLS communication.

See Also:

Constant Field Values

SERVER_GRPC_MAX_INBOUND_MESSAGE_SIZE

public static final java.lang.String SERVER_GRPC_MAX_INBOUND_MESSAGE_SIZE

scalar.dl.ledger.server.grpc.max_inbound_message_size (Optional)
The maximum message size allowed for a single gRPC frame. If an inbound message larger than this limit is received, it will not be processed, and the RPC will fail with RESOURCE_EXHAUSTED.

See Also:

Constant Field Values

SERVER_GRPC_MAX_INBOUND_METADATA_SIZE

public static final java.lang.String SERVER_GRPC_MAX_INBOUND_METADATA_SIZE

scalar.dl.ledger.server.grpc.max_inbound_metadata_size (Optional)
The maximum size of metadata allowed to be received. This is cumulative size of the entries with some overhead, as defined for HTTP/2's SETTINGS_MAX_HEADER_LIST_SIZE. The default is 8 KiB.

See Also:

Constant Field Values

PROOF_ENABLED

public static final java.lang.String PROOF_ENABLED

scalar.dl.ledger.proof.enabled
A flag to enable asset proof that is used to verify assets (false by default). This feature must be enabled in both client and server.

See Also:

Constant Field Values

PROOF_PRIVATE_KEY_PATH

public static final java.lang.String PROOF_PRIVATE_KEY_PATH

scalar.dl.ledger.proof.private_key_path
The path of a private key file in PEM format. Either this or scalar.dl.ledger.proof.private_key_pem is used for signing proofs with digital signatures. The signatures are also used for Auditor to authenticate the corresponding proofs from Ledger if scalar.dl.ledger.servers.authentication.hmac.secret_key is empty.

See Also:

Constant Field Values

PROOF_PRIVATE_KEY_PEM

public static final java.lang.String PROOF_PRIVATE_KEY_PEM

scalar.dl.ledger.proof.private_key_pem
PEM-encoded private key data. Either this or scalar.dl.ledger.proof.private_key_path is used for signing proofs with digital signatures. The signatures are also used for Auditor to authenticate the corresponding proofs from Ledger if scalar.dl.ledger.servers.authentication.hmac.secret_key is empty.

See Also:

Constant Field Values

FUNCTION_ENABLED

public static final java.lang.String FUNCTION_ENABLED

scalar.dl.ledger.function.enabled
A flag to enable function for mutable database (true by default).

See Also:

Constant Field Values

NONCE_TXID_ENABLED

public static final java.lang.String NONCE_TXID_ENABLED

scalar.dl.ledger.nonce_txid.enabled
A flag to use nonce as a transaction ID (true by default).

See Also:

Constant Field Values

AUDITOR_ENABLED

public static final java.lang.String AUDITOR_ENABLED

scalar.dl.ledger.auditor.enabled
A flag to enable Auditor (false by default).

See Also:

Constant Field Values

SERVERS_AUTHENTICATION_HMAC_SECRET_KEY

public static final java.lang.String SERVERS_AUTHENTICATION_HMAC_SECRET_KEY

scalar.dl.ledger.servers.authentication.hmac.secret_key
A secret key of HMAC for the authentication of messages between (Ledger and Auditor) servers. The same key has to be set in the corresponding Auditor as well. If this is not set, Ledger uses digital signature authentication using scalar.dl.ledger.proof.private_key_pem/path for signing and scalar.dl.ledger.auditor.cert_holder_id and its corresponding certificate (stored in the database) for verification.

See Also:

Constant Field Values

AUDITOR_CERT_HOLDER_ID

@Deprecated
public static final java.lang.String AUDITOR_CERT_HOLDER_ID

Deprecated. This will be deleted in release 5.0.0 since Ledger-Auditor authentication will use HMAC only.

scalar.dl.ledger.auditor.cert_holder_id
Auditor certificate holder ID ("auditor" by default).

See Also:

Constant Field Values

AUDITOR_CERT_VERSION

@Deprecated
public static final java.lang.String AUDITOR_CERT_VERSION

Deprecated. This will be deleted in release 5.0.0 since Ledger-Auditor authentication will use HMAC only.

scalar.dl.ledger.auditor.cert_version
Auditor certificate version (1 by default).

See Also:

Constant Field Values

EXECUTABLE_CONTRACTS

public static final java.lang.String EXECUTABLE_CONTRACTS

scalar.dl.ledger.executable_contracts
Binary names of contracts that can be executed. Please use the following format.

 [[contracts]]
 contract-binary-name = "com.org1.contract.StateUpdater"

 [[contracts]]
 contract-binary-name = "com.org1.contract.StateReader"
 

See Also:

Constant Field Values

DIRECT_ASSET_ACCESS_ENABLED

public static final java.lang.String DIRECT_ASSET_ACCESS_ENABLED

scalar.dl.ledger.direct_asset_access.enabled
A flag to access asset table directly without going through asset_metadata (false by default). This should be set to false for some databases such as Cassandra that incur multiple database lookups for scanning a clustering key with limit 1.

See Also:

Constant Field Values

TX_STATE_MANAGEMENT_ENABLED

public static final java.lang.String TX_STATE_MANAGEMENT_ENABLED

scalar.dl.ledger.tx_state_management.enabled
A flag to manage transaction states by Ledger (false by default). This must be enabled when using JdbcTransactionManager as the transaction manager of ScalarDB.

See Also:

Constant Field Values

Constructor Detail

LedgerConfig

public LedgerConfig(java.io.File propertiesFile)
             throws java.io.IOException

Throws:

java.io.IOException

LedgerConfig

public LedgerConfig(java.io.InputStream stream)
             throws java.io.IOException

Throws:

java.io.IOException

LedgerConfig

public LedgerConfig(java.util.Properties properties)

Method Detail

finalize

protected final void finalize()

SpotBugs detects Bug Type "CT_CONSTRUCTOR_THROW" saying that "The object under construction remains partially initialized and may be vulnerable to Finalizer attacks."

Overrides:

finalize in class java.lang.Object

getDatabaseConfig

public com.scalar.db.config.DatabaseConfig getDatabaseConfig()

getProductName

public java.lang.String getProductName()

getServiceName

public java.lang.String getServiceName()

Specified by:

getServiceName in interface com.scalar.dl.ledger.config.ServerConfig

getName

public java.lang.String getName()

Specified by:

getName in interface com.scalar.dl.ledger.config.ServerConfig

getNamespace

public java.lang.String getNamespace()

getAuthenticationMethod

public com.scalar.dl.ledger.config.AuthenticationMethod getAuthenticationMethod()

getHmacCipherKey

@Nullable
public java.lang.String getHmacCipherKey()

getPort

public int getPort()

Specified by:

getPort in interface com.scalar.dl.ledger.config.ServerConfig

getPrivilegedPort

public int getPrivilegedPort()

Specified by:

getPrivilegedPort in interface com.scalar.dl.ledger.config.ServerConfig

getAdminPort

public int getAdminPort()

Specified by:

getAdminPort in interface com.scalar.dl.ledger.config.ServerConfig

getPrometheusExporterPort

public int getPrometheusExporterPort()

Specified by:

getPrometheusExporterPort in interface com.scalar.dl.ledger.config.ServerConfig

getDecommissioningDurationSecs

public int getDecommissioningDurationSecs()

Specified by:

getDecommissioningDurationSecs in interface com.scalar.dl.ledger.config.ServerConfig

isServerTlsEnabled

public boolean isServerTlsEnabled()

Specified by:

isServerTlsEnabled in interface com.scalar.dl.ledger.config.ServerConfig

getServerTlsCertChainPath

public java.lang.String getServerTlsCertChainPath()

Specified by:

getServerTlsCertChainPath in interface com.scalar.dl.ledger.config.ServerConfig

getServerTlsPrivateKeyPath

public java.lang.String getServerTlsPrivateKeyPath()

Specified by:

getServerTlsPrivateKeyPath in interface com.scalar.dl.ledger.config.ServerConfig

getGrpcServerConfig

public com.scalar.dl.ledger.config.GrpcServerConfig getGrpcServerConfig()

Specified by:

getGrpcServerConfig in interface com.scalar.dl.ledger.config.ServerConfig

isProofEnabled

public boolean isProofEnabled()

getProofPrivateKey

public java.lang.String getProofPrivateKey()

isFunctionEnabled

public boolean isFunctionEnabled()

isNonceTxidEnabled

public boolean isNonceTxidEnabled()

isAuditorEnabled

public boolean isAuditorEnabled()

getServersAuthenticationHmacSecretKey

@Nullable
public java.lang.String getServersAuthenticationHmacSecretKey()

Specified by:

getServersAuthenticationHmacSecretKey in interface com.scalar.dl.ledger.config.ServersHmacAuthenticatable

getAuditorCertHolderId

@Deprecated
 @Nullable
public java.lang.String getAuditorCertHolderId()

Deprecated.

getAuditorCertVersion

@Deprecated
public int getAuditorCertVersion()

Deprecated.

getExecutableContractNames

public java.util.Set<java.lang.String> getExecutableContractNames()

isDirectAssetAccessEnabled

public boolean isDirectAssetAccessEnabled()

isTxStateManagementEnabled

public boolean isTxStateManagementEnabled()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object