Lightstreamer - Portfolio Demo - Java Adapter

The Portfolio Demo simulates a portfolio management: it shows a list of stocks included in a portfolio and provide a simple order entry form. Changes to portfolio contents, as a result of new orders, are displayed on the page in real-time. In addition to that, the Full Version of the Portfolio Demo also shows, for each stock in the portfolio, the current price, updated in real-time from a market data feed.

This project shows the Java Metadata and Data Adapters for the Portfolio Demo and how they can be plugged into Lightstreamer Server. It also shows how to integrate the Lightstreamer - Stock-List Demo - Java Adapter into the same Adapter Set to support the full version of the Portfolio Demo.

As an example of Clients Using This Adapter, you may refer to the Basic Portfolio Demo - HTML Client and view the corresponding Basic Portfolio Demo Live Demo, or you may refer to the Portfolio Demo - HTML Client and view the corresponding Portfolio Demo Live Demo for the full version of the Portfolio Demo.

This project also provides support for the JSON Patch Portfolio Demo - HTML Client and view the corresponding JSON Patch Portfolio Demo Live Demo, through a second Data Adapter which supplies the same portfolios in a different form, based on JSON structures. Note that the use of JSON is not the recommended way to supply tabular data like this, but it may be needed to handle more complex structures.

Details

Dig the Code

The project is comprised of source code and a deployment example. The source code includes the following parts.

Feed Simulator

A class that simulates a portfolio manager, which generates random portfolios and accepts buy and sell operations to change portfolio contents.

Portfolio Data Adapters

The Basic Portfolio Demo Data Adapter, a demo Adapter that handles subscription requests by attaching to the simulated portfolio manager. It can be referred to as a basic example for Data Adapter development. The similar Data Adapter for the JSON variant is also included.

Portfolio Metadata Adapter

A Metadata Adapter to be associated with the Portfolio Demo Data Adapters. This Metadata Adapter inherits from LiteralBasedProvider in Lightstreamer Java In-Process Adapter SDK and just adds a simple support for order entry by implementing the NotifyUserMessage method, to handle "sendMessage" requests from the Portfolio Demo client. A confirmation response is sent by NotifyUserMessage to the client. The communication to the Portfolio Feed Simulator is handled here.

It should not be used as a reference for a real case of client-originated message handling, as no guaranteed delivery and no clustering support is shown.

See the source code comments for further details.

The Adapter Set Configuration

This Adapter Set is configured and will be referenced by the clients as PORTFOLIODEMO.

The adapters.xml file for the Basic Portfolio Demo, should look like:

<?xml version="1.0"?>

<!-- Mandatory. Define an Adapter Set and sets its unique ID. -->
<adapters_conf id="PORTFOLIODEMO">

    <metadata_adapter_initialised_first>Y</metadata_adapter_initialised_first>

    <!-- Mandatory. Define the Metadata Adapter. -->
    <metadata_provider>

        <!-- Mandatory. Java class name of the adapter. -->
        <adapter_class>com.lightstreamer.examples.portfolio_demo.adapters.PortfolioMetadataAdapter</adapter_class>

        <!-- configure the dedicated pool for notifyUserMessage call, see source code of PortfolioMetadataAdapter -->
        <messages_pool>
            <max_pending_requests>100</max_pending_requests>
            <max_queue>100</max_queue>
        </messages_pool>

        <!-- Optional, managed by the inherited LiteralBasedProvider.
             See LiteralBasedProvider javadoc. -->
        <param name="item_family_1">portfolio.*</param>
        <param name="modes_for_item_family_1">COMMAND</param>

    </metadata_provider>

    <!-- Mandatory. Define the Data Adapter. -->
    <data_provider name="PORTFOLIO_ADAPTER">

        <!-- Mandatory. Java class name of the adapter. -->
        <adapter_class>com.lightstreamer.examples.portfolio_demo.adapters.PortfolioDataAdapter</adapter_class>

    </data_provider>

</adapters_conf>

The full version of the Portfolio Demo needs the Portfolio and the StockList demo adapters together in the same Adapter Set.

The adapters.xml file for the Portfolio Demo, should look like:

<?xml version="1.0"?>

<!-- Mandatory. Define an Adapter Set and sets its unique ID. -->
  <adapters_conf id="FULLPORTFOLIODEMO">
  
    <metadata_adapter_initialised_first>Y</metadata_adapter_initialised_first>

    <!-- Mandatory. Define the Metadata Adapter. -->
    <metadata_provider>

      <install_dir>portfolio</install_dir>

      <!-- Mandatory. Java class name of the adapter. -->
      <adapter_class>com.lightstreamer.examples.portfolio_demo.adapters.PortfolioMetadataAdapter</adapter_class>

      <!-- configure the dedicated pool for notifyUserMessage call, see source code of PortfolioMetadataAdapter -->
      <messages_pool>
          <max_pending_requests>100</max_pending_requests>
          <max_queue>100</max_queue>
      </messages_pool>

      <!-- Optional, managed by the inherited LiteralBasedProvider.
           See LiteralBasedProvider javadoc. -->
      <param name="item_family_1">portfolio.*</param>
      <param name="modes_for_item_family_1">COMMAND</param>

      <param name="item_family_2">item.*</param>
      <param name="modes_for_item_family_2">MERGE</param>

    </metadata_provider>

    <!-- Mandatory. Define the Data Adapter. -->
    <data_provider name="PORTFOLIO_ADAPTER">

      <install_dir>portfolio</install_dir>

      <!-- Mandatory. Java class name of the adapter. -->
      <adapter_class>com.lightstreamer.examples.portfolio_demo.adapters.PortfolioDataAdapter</adapter_class>

    </data_provider>

    <!-- Mandatory. Define the Data Adapter. -->
    <data_provider name="QUOTE_ADAPTER">

      <install_dir>Stocklist</install_dir>

      <!-- Mandatory. Java class name of the adapter. -->
      <adapter_class>com.lightstreamer.examples.stocklist_demo.adapters.StockQuotesDataAdapter</adapter_class>

    </data_provider>

  </adapters_conf>

On the other hand, the adapters.xml file for the JSON Patch Portfolio Demo, should look like:

<?xml version="1.0"?>

<!-- Mandatory. Define an Adapter Set and sets its unique ID. -->
<adapters_conf id="JSONPORTFOLIODEMO">

    <metadata_adapter_initialised_first>Y</metadata_adapter_initialised_first>

    <!-- Mandatory. Define the Metadata Adapter. -->
    <metadata_provider>

        <!-- Mandatory. Java class name of the adapter. -->
        <adapter_class>com.lightstreamer.examples.portfolio_demo.adapters.PortfolioMetadataAdapter</adapter_class>

        <!-- configure the dedicated pool for notifyUserMessage call, see source code of PortfolioMetadataAdapter -->
        <messages_pool>
            <max_pending_requests>100</max_pending_requests>
            <max_queue>100</max_queue>
        </messages_pool>

        <!-- Optional, managed by the inherited LiteralBasedProvider.
             See LiteralBasedProvider javadoc. -->
        <param name="item_family_1">portfolio.*</param>
        <param name="modes_for_item_family_1">MERGE</param>

    </metadata_provider>

    <!-- Mandatory. Define the Data Adapter. -->
    <data_provider name="PORTFOLIO_JSON_ADAPTER">

        <!-- Mandatory. Java class name of the adapter. -->
        <adapter_class>com.lightstreamer.examples.portfolio_demo.adapters.PortfolioDataAdapterJsonVersion</adapter_class>

    </data_provider>

</adapters_conf>

Note that the Data Adapters needed by the various demos could also be deployed together. The adapters.xml file would look like:

<?xml version="1.0"?>

<!-- Mandatory. Define an Adapter Set and sets its unique ID. -->
  <adapters_conf id="ALLPORTFOLIODEMOS">
  
    <metadata_adapter_initialised_first>Y</metadata_adapter_initialised_first>

    <!-- Mandatory. Define the Metadata Adapter. -->
    <metadata_provider>

      <!-- Mandatory. Java class name of the adapter. -->
      <adapter_class>com.lightstreamer.examples.portfolio_demo.adapters.PortfolioMetadataAdapter</adapter_class>

      <!-- configure the dedicated pool for notifyUserMessage call, see source code of PortfolioMetadataAdapter -->
      <messages_pool>
          <max_pending_requests>100</max_pending_requests>
          <max_queue>100</max_queue>
      </messages_pool>

      <!-- Optional, managed by the inherited LiteralBasedProvider.
           See LiteralBasedProvider javadoc. -->
      <param name="item_family_1">portfolio.*</param>
      <param name="data_adapter_for_item_family_1">PORTFOLIO_ADAPTER</param>
      <param name="modes_for_item_family_1">COMMAND</param>

      <param name="item_family_2">portfolio.*</param>
      <param name="data_adapter_for_item_family_2">PORTFOLIO_JSON_ADAPTER</param>
      <param name="modes_for_item_family_2">MERGE</param>

      <param name="item_family_3">item.*</param>
      <param name="data_adapter_for_item_family_3">QUOTE_ADAPTER</param>
      <param name="modes_for_item_family_3">MERGE</param>

    </metadata_provider>

    <!-- Mandatory. Define the Data Adapter. -->
    <data_provider name="PORTFOLIO_ADAPTER">

      <!-- Mandatory. Java class name of the adapter. -->
      <adapter_class>com.lightstreamer.examples.portfolio_demo.adapters.PortfolioDataAdapter</adapter_class>

    </data_provider>

    <!-- Mandatory. Define the Data Adapter. -->
    <data_provider name="PORTFOLIO_JSON_ADAPTER">

        <!-- Mandatory. Java class name of the adapter. -->
        <adapter_class>com.lightstreamer.examples.portfolio_demo.adapters.PortfolioDataAdapterJsonVersion</adapter_class>

    </data_provider>

    <!-- Mandatory. Define the Data Adapter. -->
    <data_provider name="QUOTE_ADAPTER">

      <!-- Mandatory. Java class name of the adapter. -->
      <adapter_class>com.lightstreamer.examples.stocklist_demo.adapters.StockQuotesDataAdapter</adapter_class>

    </data_provider>

  </adapters_conf>

NOTE: not all configuration options of an Adapter Set are exposed by the files suggested above. You can easily expand your configurations using the generic template, see the Java In-Process Adapter Interface Project for details.

Please refer here for more details about Lightstreamer Adapters.

Install

Install the Basic Portfolio Demo

If you want to install a basic version of the Portfolio Demo in your local Lightstreamer Server, follow these steps:

• Download Lightstreamer Server (Lightstreamer Server comes with a free non-expiring demo license for 20 connected users) from Lightstreamer Download page, and install it, as explained in the GETTING_STARTED.TXT file in the installation home directory.
• Make sure that Lightstreamer Server is not running.
• Get the deploy.zip file of the proper release, unzip it, go to the Deployment_LS folder, and copy the Portfolio folder into the adapters folder of your Lightstreamer Server installation.
• Launch Lightstreamer Server.
• Test the Adapter, launching the Basic Portfolio Demo - HTML Client, listed in Clients Using This Adapter.

Install the Portfolio Demo

To work with full functionality, the Portfolio Demo - HTML Client, needs both the PORTFOLIO_ADAPTER, from the Portfolio Demo, and the QUOTE_ADAPTER, from the Stock-List Demo (see Lightstreamer - Stock-List Demo - Java Adapter). If you want to install a full version of the Portfolio Demo in your local Lightstreamer Server, you have to deploy the PORTFOLIO_ADAPTER and the QUOTE_ADAPTER together in the same Adapter Set. To allow the two adapters to coexist within the same Adapter Set, please follow the steps below:

• Download Lightstreamer Server (Lightstreamer Server comes with a free non-expiring demo license for 20 connected users) from Lightstreamer Download page, and install it, as explained in the GETTING_STARTED.TXT file in the installation home directory.
• Make sure that Lightstreamer Server is not running.
• Get the deploy.zip file of the proper release, unzip it, go to the Full_Deployment_LS folder, and copy the FullPortfolio folder into the adapters folder of your Lightstreamer Server installation.
• Launch Lightstreamer Server.
• Test the Adapter, launching the Portfolio Demo - HTML Client, listed in Clients Using This Adapter.

Install the JSON Patch Portfolio Demo

If you want to install the JSON variant of the Portfolio Demo in your local Lightstreamer Server, follow these steps:

• Download Lightstreamer Server (Lightstreamer Server comes with a free non-expiring demo license for 20 connected users) from Lightstreamer Download page, and install it, as explained in the GETTING_STARTED.TXT file in the installation home directory.
• Make sure that Lightstreamer Server is not running.
• Get the deploy.zip file of the proper release, unzip it, go to the Deployment_LS_JSON_version folder, and copy the PortfolioJSON folder into the adapters folder of your Lightstreamer Server installation.
• Launch Lightstreamer Server.
• Test the Adapter, launching the JSON Patch Portfolio Demo - HTML Client, listed in Clients Using This Adapter.

Build

To build your own version of portfolio-adapter-java-x.y.z.jar instead of using the one provided in the deploy.zip file from the Install section above, you have two options: either use Maven (or other build tools) to take care of dependencies and building (recommended) or gather the necessary jars yourself and build it manually. For the sake of simplicity only the Maven case is detailed here.

Maven

You can easily build and run this application using Maven through the pom.xml file located in the root folder of this project. As an alternative, you can use an alternative build tool (e.g. Gradle, Ivy, etc.) by converting the provided pom.xml file.

Assuming Maven is installed and available in your path you can build the demo by running

 mvn install dependency:copy-dependencies 

See Also

Clients Using This Adapter

• Lightstreamer - Portfolio Demos - HTML Clients
• Lightstreamer - Portfolio Demo - .NET Client
• Lightstreamer - Portfolio Demo - Flex Client
• Lightstreamer - Portfolio Demo - Dojo Toolkit Client

Related Projects

• LiteralBasedProvider Metadata Adapter
• Lightstreamer - Stock-List Demo - Java Adapter
• Lightstreamer - Portfolio Demo - .NET Adapter

Lightstreamer Compatibility Notes

• Compatible with Lightstreamer SDK for Java In-Process Adapters since version 8.0.
• For a version of this example compatible with Lightstreamer SDK for Java In-Process Adapters versions 7.4.x, please refer to this tag.
• For a version of this example compatible with Lightstreamer SDK for Java In-Process Adapters version 7.3, please refer to this tag.
• For a version of this example compatible with Lightstreamer SDK for Java In-Process Adapters version 6.0, please refer to this tag.
• For a version of this example compatible with Lightstreamer SDK for Java In-Process Adapters version 5.1, please refer to this tag.