- Overview
- Package
- Class
- Tree
- Deprecated
- Index
- Help
See: Description
| Package | Description |
|---|---|
| com.caplin.datasource |
About DataSource for Java
|
| com.caplin.datasource.channel |
The Channel package consists of interfaces allowing creation and maintenance of
Channels that
provide a bi-directional communication mechanism between StreamLink clients and DataSource applications |
| com.caplin.datasource.messaging |
Defines the message types that are used by DataSource for Java.
|
| com.caplin.datasource.messaging.container |
This package defines the interfaces for sending Container messages.
|
| com.caplin.datasource.messaging.mapping |
This package defines the interfaces for sending Mapping messages.
|
| com.caplin.datasource.messaging.news |
This package defines the interfaces for sending News messages.
|
| com.caplin.datasource.messaging.page |
This package defines the interfaces for sending Page messages.
|
| com.caplin.datasource.messaging.permission |
This package defines the interfaces for sending Permission messages.
|
| com.caplin.datasource.messaging.record |
This package defines the interfaces for sending Record messages.
|
| com.caplin.datasource.messaging.story |
This package defines the interfaces for sending Story messages.
|
| com.caplin.datasource.namespace |
Namespaces are used to determine if a subject is of interest to an
DataProvider. |
| com.caplin.datasource.publisher |
Defines the methods of providing and publishing data that are used by DataSource for Java.
|
| com.caplin.datasource.subscription |
Defines the interfaces and classes that are used by a Java DataSource application when it needs
to subscribe to data provided by another DataSource application.
|
| Package | Description |
|---|---|
| com.caplin.datasource.blotter |
This package contains the public elements of the BlotterAPI.
|
| Package | Description |
|---|---|
| com.caplin.trading |
The Caplin Trading Integration API provides Java classes and interfaces that
allow you to create Trading Adapters.
|
| Package | Description |
|---|---|
| com.caplin.charting |
Contains the ChartingProvider class which should be used when creating a data source to provide charting data.
|
| Package | Description |
|---|---|
| com.caplin.permissioning |
The Caplin Permissioning Integration API provides classes and interfaces
that allow you to create Permissioning Adapters.
|
| com.caplin.permissioning.logging |
The classes and interfaces that support the ability to apply a different logging strategy for permissioning objects.
|
| Package | Description |
|---|---|
| com.caplin.datasource.notification |
This package contains the public elements of the Notification API.
|
| Package | Description |
|---|---|
| com.caplin.datasource.fields | |
| com.caplin.management | |
| com.caplin.management.jmx |
Provides classes that help manage the Caplin JMX implementation of adding MBeans, MBean relationships and MBeanServer.
|
| com.caplin.management.jmx.encoder |
Provides classes that should be used to encode and decode that values contained within
ObjectNames. |
| com.caplin.management.jmx.relations |
Defines the classes used to represent "to many" relationships within the Caplin JMX
implementation.
|
| com.caplin.management.jmx.relations.links |
Provides classes that represent a relationship to a specific MBean.
|
The Caplin Integration Suite is set of SDKs, APIs, and tools for integrating the Caplin Platform with external systems. The Java APIs allow you to write Java-based DataSource applications called Adapters, which provide the integration with the external systems. The following table shows the Integration APIs that are provided and the type of Adapter that each API allows you to create:
| Caplin Integration Suite API | Adapter type | integrates with |
|---|---|---|
| Trading Integration API | Trading Adapter | Trading systems |
| Permissioning Integration API | Permissioning Adapter | Permissioning system |
| Notification API | Notification Adapter | External sources of notifications |
| Blotter API | Trading history (typically) | Trading history systems (typically) |
| DataSource API | Pricing Adapter (typically) | Pricing systems (typically) |
For more information about DataSource, DataSource applications, and DataSource Adapters, see the document Caplin DataSource Overview.
The following diagram shows how the APIs defined in this document are typically used to integrate the Caplin Platform with a bank's trading and infrastructure systems.
The diagram shows four Adapters that interact with the banks' existing systems and other external systems. Each Adapter uses one of the APIs of the Caplin Integration Suite to send messages between a particular bank system / external system and the appropriate Caplin Platform component (Transformer or Liberator). The API sends and receives messages on the platform side using a common protocol and format (DataSource messaging). The protocol and format of the messaging between each DataSource Adapter and the bank / external system that it is connected to depends on the system; you must write the integration code that handles the interaction between the Adapter and the bank / external system.
Although the previous table and diagram show a separate Adapter for each type of Caplin Integration Suite API, it is possible to combine more than one API into the same Adapter. For example a single Adapter could incorporate calls to both the Trading Integration API and Permissioning Integration API. You might need to implement such an Adapter if the trading system that it interfaces with controls user permissions as well (that is, it controls which users can actually trade and what they can trade).
The Trading Integration API allows financial trading systems to be integrated with the Caplin Platform. It can be configured to support any Trade Models of your choice.
For more information on how to use the Trading Integration API, see the following documents:
Describes how the Caplin Trading Integration API allows you to integrate the Caplin Platform with your existing trading system. It explains trading concepts (such as Trade Models), how to implement a Trading Adapter, and how to configure Caplin Liberator for trading.
This reference document describes the XML-based configuration that defines the Trade Models used by Trading Adapters, where the Adapter is built using the Caplin Trading Integration API.
com.caplin.trading in this document)
The Permissioning Integration API allows your authentication, permissioning, and tiering systems to be integrated with the Caplin Platform.
For more information on how to use the Permissioning Integration API, see the following documents:
Introduces permissioning concepts and terms, and shows the permissioning components of the Caplin Platform architecture.
Describes how to create a Permissioning Adapter using the Permissioning Integration API.
Describes how to install the Permissioning Auth Module in an existing Caplin Platform installation.
com.caplin.permissioning in this document)
The Notification API allows you to push notifications to any logged in user across all their sessions.
This API can be used to generate system-wide Notifications from sources external to the Caplin Platform. However, you do not need to use this API to write special code to generate Notifications relating to changes in instrument prices; this capability is already provided by the Alerts Service for Transformer. There is a StreamLink Notification Service for integrating with the Notification API via StreamLink.
For more information on Notification API, see
(package com.caplin.datasource.notification in this document)
The Blotter API allows you to manage blotters.
This API gives you object representations of per user blotter channels onto which items can be added. It services requests for these blotter channels.
See com.caplin.datasource.blotter.
The DataSource API allows you to write you own custom DataSource applications, and is used by the other integration APIs. In particular, it is used to write pricing adaptors.
For more information about DataSource concepts and capabilities, and how to use the DataSource API, see the following documents:
A technical overview of Caplin DataSource. It includes, what Caplin DataSource is and how it can be used, DataSource concepts & features, how DataSource fits into the Caplin Platform as a whole, and an overview of the DataSource SDKs that are used to produce custom DataSource applications.
com.caplin.datasource in this document)Related documentation available on the Documentation pages of the Caplin Client Portal:
Provides a technical overview of the Caplin Platform and includes an explanation of its architecture.
Describes the Caplin Liberator server and its place within Caplin Xaqua. Explains how to install, configure, and manage the Liberator. Includes configuration reference information.
A technical overview of Caplin Trader.
Describes how to add permissioning to Caplin Trader so that display components behave in accordance with the permissions of the logged in user.
Please send bug reports and comments to Caplin support