com.dxfeed.ipf

Class InstrumentProfileReader

java.lang.Object

com.dxfeed.ipf.InstrumentProfileReader

public class InstrumentProfileReader
extends Object

Reads instrument profiles from the stream using Instrument Profile Format (IPF). Please see Instrument Profile Format documentation for complete description. This reader automatically uses data formats as specified in the stream.

This reader is intended for "one time only" usage: create new instances for new IPF reads.

Use InstrumentProfileConnection if support for streaming updates of instrument profiles is needed.

For backward compatibility reader can be configured with system property "-Dcom.dxfeed.ipf.complete" to control the strategy for missing "##COMPLETE" tag when reading IPF, possible values are:

• warn - show warning in the log (default)
• error - throw exception (future default)
• ignore - do nothing (for backward compatibility)

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	wasComplete

Constructor Summary

Constructors

Constructor and Description
InstrumentProfileReader() Creates instrument profile reader.

Method Summary

Modifier and Type	Method and Description
long	getLastModified() Returns last modification time (in milliseconds) from last readFromFile(java.lang.String) operation or zero if it is unknown.
protected void	handleIncomplete(String address)
protected String	intern(String value) To be overridden in subclasses to allow intern strings using pools (like StringCache) to reduce memory footprint.
List<InstrumentProfile>	read(InputStream in) Deprecated. Use read(InputStream, String). This is an extension point only and will be made protected in future.
List<InstrumentProfile>	read(InputStream in, String address) Reads and returns instrument profiles from specified stream This method recognizes data compression formats "zip" and "gzip" automatically.
List<InstrumentProfile>	readCompressed(InputStream in) Deprecated. Use read(InputStream, String)
List<InstrumentProfile>	readFromFile(String address) Reads and returns instrument profiles from specified file.
List<InstrumentProfile>	readFromFile(String address, com.devexperts.auth.AuthToken token) Reads and returns instrument profiles from specified address with a specified token credentials.
List<InstrumentProfile>	readFromFile(String address, String user, String password) Reads and returns instrument profiles from specified address with a specified basic user and password credentials.
static String	resolveSourceURL(String address) Converts a specified string address specification into an URL that will be read by readFromFile(java.lang.String) method using URLInputStream.
boolean	wasComplete() Returns true if IPF was fully read on last readFromFile(java.lang.String) operation.

Methods inherited from class java.lang.Object

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

Field Detail

wasComplete

protected boolean wasComplete

Constructor Detail

InstrumentProfileReader

public InstrumentProfileReader()

Creates instrument profile reader.

Method Detail

getLastModified

public long getLastModified()

Returns last modification time (in milliseconds) from last readFromFile(java.lang.String) operation or zero if it is unknown.

wasComplete

public boolean wasComplete()

Returns true if IPF was fully read on last readFromFile(java.lang.String) operation.

readFromFile

public List<InstrumentProfile> readFromFile(String address)
                                     throws IOException

Reads and returns instrument profiles from specified file. This method recognizes data compression formats "zip" and "gzip" automatically. In case of zip the first file entry will be read and parsed as a plain data stream. In case of gzip compressed content will be read and processed. In other cases data considered uncompressed and will be parsed as is.

Authentication information can be supplied to this method as part of URL user info like "http://user:password@host:port/path/file.ipf".

This is a shortcut for readFromFile(address, null, null).

This operation updates lastModified and wasComplete.

Parameters:

address - URL of file to read from

Returns:

list of instrument profiles

Throws:

InstrumentProfileFormatException - if input stream does not conform to the Instrument Profile Format

IOException - If an I/O error occurs

readFromFile

public List<InstrumentProfile> readFromFile(String address,
                                            String user,
                                            String password)
                                     throws IOException

Reads and returns instrument profiles from specified address with a specified basic user and password credentials. This method recognizes data compression formats "zip" and "gzip" automatically. In case of zip the first file entry will be read and parsed as a plain data stream. In case of gzip compressed content will be read and processed. In other cases data considered uncompressed and will be parsed as is.

Specified user and password take precedence over authentication information that is supplied to this method as part of URL user info like "http://user:password@host:port/path/file.ipf".

This operation updates lastModified and wasComplete.

Parameters:

address - URL of file to read from

user - the username, may be null

password - the password, may be null

Returns:

list of instrument profiles

Throws:

InstrumentProfileFormatException - if input stream does not conform to the Instrument Profile Format

IOException - If an I/O error occurs

readFromFile

public List<InstrumentProfile> readFromFile(String address,
                                            com.devexperts.auth.AuthToken token)
                                     throws IOException

Reads and returns instrument profiles from specified address with a specified token credentials. This method recognizes data compression formats "zip" and "gzip" automatically. In case of zip the first file entry will be read and parsed as a plain data stream. In case of gzip compressed content will be read and processed. In other cases data considered uncompressed and will be parsed as is.

Specified token take precedence over authentication information that is supplied to this method as part of URL user info like "http://user:password@host:port/path/file.ipf".

This operation updates lastModified and wasComplete.

Parameters:

address - URL of file to read from

token - the token, may be null

Returns:

list of instrument profiles

Throws:

InstrumentProfileFormatException - if input stream does not conform to the Instrument Profile Format

IOException - If an I/O error occurs

resolveSourceURL

public static String resolveSourceURL(String address)

Converts a specified string address specification into an URL that will be read by readFromFile(java.lang.String) method using URLInputStream.

read

public final List<InstrumentProfile> read(InputStream in,
                                          String address)
                                   throws IOException

Reads and returns instrument profiles from specified stream This method recognizes data compression formats "zip" and "gzip" automatically. In case of zip the first file entry will be read and parsed as a plain data stream. In case of gzip compressed content will be read and processed. In other cases data considered uncompressed and will be parsed as is.

This operation updates wasComplete flag.

Parameters:

in - InputStream to read profiles from

address - origin of the stream for debugging purposes

Throws:

InstrumentProfileFormatException - if input stream does not conform to the Instrument Profile Format

IOException - If an I/O error occurs

readCompressed

@Deprecated
public final List<InstrumentProfile> readCompressed(InputStream in)
                                                         throws IOException

Deprecated. Use read(InputStream, String)

Throws:

InstrumentProfileFormatException - if input stream does not conform to the Instrument Profile Format

IOException - If an I/O error occurs

read

@Deprecated
public List<InstrumentProfile> read(InputStream in)
                                         throws IOException

Deprecated. Use read(InputStream, String). This is an extension point only and will be made protected in future.

Throws:

InstrumentProfileFormatException - if input stream does not conform to the Instrument Profile Format

IOException - If an I/O error occurs

intern

protected String intern(String value)

To be overridden in subclasses to allow intern strings using pools (like StringCache) to reduce memory footprint. Default implementation does nothing (returns value itself).

Parameters:

value - string value to intern

Returns:

canonical representation of the given string value

handleIncomplete

protected void handleIncomplete(String address)
                         throws InstrumentProfileFormatException

Throws:

InstrumentProfileFormatException