The DataSource XML configuration schema (Deprecated)

DataSource for Java SDK uses XML files validated against XML schemas. This enforces order, so elements within other elements must appear in the correct order as declared in the schema. The hierarchy and order of tags is shown below.

N.B. Tags without children must be self-closing (end with />) or the parser will throw an error.

<dataSource>
    <logging>
        <pattern />
    </logging>
    <packetLog>
        <pattern />
    </packetLog>
    <latencyChainManager />
    <peer>
        <heartbeat />
        <local />
        <remote />
        <destination />
    </peer>
    <jmxManager />
    <sendDirect />
</dataSource>
	

A description of each tag and its attributes follows.

<dataSource> tag

The root tag for configuring a DataSource.

Configures how peers will identify and connect to this DataSource application. This application will identify its peers using the information set in the <peer> tags. Note: if SSL is enabled keystores must be correctly configured. See http://docs.oracle.com/javase/6/docs/technotes/guides/security/jsse/JSSERefGuide.html#CreateKeystore for further details.

Attributes:

<dataSource> tags can contain the following elements:

Example:

Back to DataSource XML schema

< logging> tag

Configures how your DataSource application logs internal status messages and error messages.

This tag will result in a {@link java.util.logging.Logger} instance being created with the specified configuration. This logger instance is available from {@link com.caplin.datasource.DataSource#getLogger()}.

Please note that from version 6.0 configuring your logger in XML is not recommended. The preferred approach is to pass your {@link java.util.logging.Logger} into the factory method {@link com.caplin.datasource.DataSourceFactory#createDataSource(String, String, Logger)}. If you use this factory method then you must remove any logging configuration from your XML configuration file, otherwise an IllegalStateException will be thrown.

The logging element is deprecated from version 6.0.

Attributes:

Example:

Back to DataSource XML schema

<packetLog> tag

Configures how your DataSource records binary messages sent between this DataSource and its peers.

This tag will result in a packet-level log file being created with the specified configuration, unless the noPacketLog attribute is set.

Attributes:

Example:

<pattern> tag attributes:

Pattern tag is optional and there can be only one in a <packetLog> or <logging> tag. It allows to specify the name of the initial log to be created by the DataSource (rotated log files will have a .number appended to this). The pattern may be constructed with an expression for java.text.SimpleDateFormat class to parse, so the file names would contain the actual date and/or time. There are several special character allowed:

• %t - java.io.tempdir property
• %u - user.home property
• %h - hostname
• %r - current directory
• %n or %a - application name (the name of the main() class)

Example:

<packetLog cycleTime="30" cyclePeriod="30" count="336" />
   <pattern patternType="date" patternString="'%u/packet-%n-'yyyy-MM-dd'.log'" />
</packetLog>

Back to DataSource XML schema

<latencyChainManager> tag

Tag for enabling latency chaining.

Attributes:

Example:

Back to DataSource XML schema

<peer> tag

Parent tag containing the elements which configure how this application communicates with its peers. Multiple destinations should be used to enable failover. If multiple destinations are present then connections to the destinations will be attempted in the order the tags appear in the XML.

Attributes:

<peer> tags can contain the following elements:

Example:

<peer>
    <local id="112" name="CaplinTest" type="ACTIVE CONTRIB"/>
    <destination address="merlin" port="25007" />
    <destination address="merlin2" port="25005" />
</peer>

Back to DataSource XML schema

<heartbeat> tag

Configures the rate of heartbeats sent between peers which indicate the health of connections. This heartbeat rate is just a suggestion: on connection to a peer, the DataSources will negotiate a suitable heartbeat rate. If the peer doesn't support heartbeats then they will not be sent.

Attributes:

Example:

Back to DataSource XML schema

<local> tag

Configures the type information that the DataSource sends to this peer to identify its capabilities.

Attributes

Example:

Back to DataSource XML schema

<remote> tag

Configures the expected capabilites of this peer. Note: once connected, this peer may send different capabilities, which will override those set here.

Attributes:

Example:

Back to DataSource XML schema

<destination> tag

Configures the location of this peer.

Attributes:

Example:

Back to DataSource XML schema

<jmxManager> tag

Tag containing the elements which configure jmx monitoring for this application.

Attributes:

Example:

<jmxManager enable="true" rmiRegistryPort="4567" hostInterface="192.168.35.100" root="production-source-1"/>

<sendDirect> tag

Tag containing the attribute which configures the default {@link com.caplin.datasrc.DSSendManager} (a {@link com.caplin.datasrc.SendDirect} instance for this DataSource. If a SendDirect instance is not used, this tag has no effect.

Attributes:

Example:

<sendDirect sendMessagesToDisconnectedPeers="true" />

TOP

The FieldManager XML configuration schema

The FieldManager is configured with its own XML file. This defines the fields available and their name / number mappings. The path to the configuration file must be passed in to either of the {@link com.caplin.datasource.DataSourceFactory} factory methods to create a {@link com.caplin.datasource.DataSource} instance.

• Negative field number support: The fields numbers range is 1..65535 to -65535..65535.
• A total of 131071 fields can be defined.

Any fields that you wish to use when sending or receiving records must be defined in the fields XML configuration file.

As with the DataSource XML schema, elements within other elements must appear in the correct order declared in the schema. The hierarchy and order of tags is shown below.

<fieldManager>
    <field>
    </field>
</fieldManager>

<fieldManager> tag

The root element for the FieldManager configuration.

Attributes:

The <fieldManager> tag can contain the following elements:

Example:

<fieldManager xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
  <field name="Bid" number="-25"/>
  <field name="Ask" number="23"/>
  <field name="Last" number="106"/>
  <field name="Close" number="-65536"/>
  </fieldManager>

Back to Field XML schema

<field> tag

Configures a field to be added to the FieldManager.

Attributes:

Example:

Back to Field XML schema