Package com.exonum.binding.core.service

Interface Service

All Known Implementing Classes:
AbstractService
public interface Service
An Exonum service.

You shall usually subclass an AbstractService which implements some of the methods declared in this interface.

  • Method Summary

    Modifier and Type Method Description
    default void afterCommit​(BlockCommittedEvent event)
    Handles read-only block commit event.
    default void beforeCommit​(Fork fork)
    Handles the changes made by all transactions included in the upcoming block.
    void createPublicApiHandlers​(Node node, io.vertx.ext.web.Router router)
    Creates handlers that make up the public HTTP API of this service.
    List<HashCode> getStateHashes​(Snapshot snapshot)
    Returns a list of hashes representing the state of this service, as of the given snapshot of the blockchain state.
    default void initialize​(Fork fork, Configuration configuration)
    Performs an initial configuration of the service instance.

  • Method Details

    • initialize

      default void initialize​(Fork fork, Configuration configuration)
      Performs an initial configuration of the service instance. This method is called once after the service instance is added to the blockchain and allows initializing some persistent data of the service.

      As Exonum passes the configuration parameters only once and does not persist them for later access, this service method must make any needed changes to the database based on these parameters. For example, it may initialize some collections in its schema (including one-off initialization that does not depend on the parameters); or save all or some configuration parameters as is for later retrieval in transactions and/or read requests.

      Parameters:
      fork - a database fork to apply changes to. Not valid after this method returns
      configuration - the service configuration parameters
      Throws:
      IllegalArgumentException - if the configuration parameters are not valid (e.g., malformed, or do not meet the preconditions). Exonum will stop the service if its initialization fails
      See Also:
      Configurable

    • getStateHashes

      List<HashCode> getStateHashes​(Snapshot snapshot)
      Returns a list of hashes representing the state of this service, as of the given snapshot of the blockchain state. Usually, it includes the hashes of all Merkelized collections defined by this service.

      The core uses this list to verify that the service on each node in the network has the same database state. To do so efficiently, it aggregates state hashes of all services into a single Merkelized meta-map. The hash of this meta-map is considered the hash of the entire blockchain state and is recorded as such in blocks and Precommit messages.

      Please note that if this service does not provide any state hashes, the framework will not be able to verify that its transactions cause the same results on different nodes.

      Parameters:
      snapshot - a snapshot of the blockchain state. Not valid after this method returns
      See Also:
      ProofListIndexProxy.getIndexHash(), ProofMapIndexProxy.getIndexHash()

    • createPublicApiHandlers

      void createPublicApiHandlers​(Node node, io.vertx.ext.web.Router router)
      Creates handlers that make up the public HTTP API of this service. The handlers are added to the given router, which is then mounted at the following path: /api/services/<service-name>.

      Please note that the path prefix shown above is stripped from the request path when it is forwarded to the given router. For example, if your service name is «timestamping», and you have an endpoint «/timestamp», use «/timestamp» as the endpoint name when defining the handler and it will be available by path «/api/services/timestamping/timestamp»: 

      
 router.get("/timestamp").handler((rc) -> {
   rc.response().end("2019-04-01T10:15:30+02:00[Europe/Kiev]");
 });
      Parameters:
      node - a set-up Exonum node, providing an interface to access the current blockchain state and submit transactions
      router - a router responsible for handling requests to this service
      See Also:
      Documentation on service API

    • beforeCommit

      default void beforeCommit​(Fork fork)
      Handles the changes made by all transactions included in the upcoming block. This handler is an optional callback method invoked by the blockchain after all transactions in a block are executed, but before it is committed. The service can modify its state in this handler, therefore, implementations must be deterministic and use only the current database state as their input.

      This method is invoked synchronously from the thread that commits the block, therefore, implementations of this method must not perform any blocking or long-running operations.

      Any exceptions in this method will revert any changes made to the database by it, but will not affect the processing of this block.

    • afterCommit

      default void afterCommit​(BlockCommittedEvent event)
      Handles read-only block commit event. This handler is an optional callback method which is invoked by the blockchain after each block commit. For example, a service can create one or more transactions if a specific condition has occurred.

      This method is invoked synchronously from the thread that commits the block, therefore, implementations of this method must not perform any blocking or long-running operations.

      Any exceptions in this method will be swallowed and will not affect the processing of transactions or blocks.

      Parameters:
      event - the read-only context allowing to access the blockchain state as of that committed block