quickfix

Class FileStore

java.lang.Object

quickfix.FileStore

All Implemented Interfaces:

Closeable, AutoCloseable, MessageStore

public class FileStore
extends Object
implements MessageStore, Closeable

File store implementation. THIS CLASS IS PUBLIC ONLY TO MAINTAIN COMPATIBILITY WITH THE QUICKFIX JNI. IT SHOULD ONLY BE CREATED USING A FACTORY.

See Also:

FileStoreFactory

Method Summary

Modifier and Type	Method and Description
void	close() Close the store's files.
void	closeAndDeleteFiles()
void	get(int startSequence, int endSequence, Collection<String> messages) Get messages within sequence number range (inclusive).
boolean	get(int sequence, String message) This method is here for JNI API consistency but it's not implemented.
Date	getCreationTime() Get the session creation time.
int	getNextSenderMsgSeqNum()
int	getNextTargetMsgSeqNum()
void	incrNextSenderMsgSeqNum()
void	incrNextTargetMsgSeqNum()
void	refresh() Refresh session state from a shared state storage (e.g. database, file, ...).
void	reset() Reset the message store.
boolean	set(int sequence, String message) Adds a raw fix messages to the store with the given sequence number.
void	setNextSenderMsgSeqNum(int next)
void	setNextTargetMsgSeqNum(int next)

Methods inherited from class java.lang.Object

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

Method Detail

getCreationTime

public Date getCreationTime()
                     throws IOException

Description copied from interface: MessageStore

Get the session creation time.

Specified by:

getCreationTime in interface MessageStore

Returns:

the session creation time.

Throws:

IOException - IO error

close

public void close()
           throws IOException

Close the store's files.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

closeAndDeleteFiles

public void closeAndDeleteFiles()
                         throws IOException

Throws:

IOException

getNextSenderMsgSeqNum

public int getNextSenderMsgSeqNum()
                           throws IOException

Specified by:

getNextSenderMsgSeqNum in interface MessageStore

Throws:

IOException

getNextTargetMsgSeqNum

public int getNextTargetMsgSeqNum()
                           throws IOException

Specified by:

getNextTargetMsgSeqNum in interface MessageStore

Throws:

IOException

setNextSenderMsgSeqNum

public void setNextSenderMsgSeqNum(int next)
                            throws IOException

Specified by:

setNextSenderMsgSeqNum in interface MessageStore

Throws:

IOException

setNextTargetMsgSeqNum

public void setNextTargetMsgSeqNum(int next)
                            throws IOException

Specified by:

setNextTargetMsgSeqNum in interface MessageStore

Throws:

IOException

incrNextSenderMsgSeqNum

public void incrNextSenderMsgSeqNum()
                             throws IOException

Specified by:

incrNextSenderMsgSeqNum in interface MessageStore

Throws:

IOException

incrNextTargetMsgSeqNum

public void incrNextTargetMsgSeqNum()
                             throws IOException

Specified by:

incrNextTargetMsgSeqNum in interface MessageStore

Throws:

IOException

get

public void get(int startSequence,
                int endSequence,
                Collection<String> messages)
         throws IOException

Description copied from interface: MessageStore

Get messages within sequence number range (inclusive). Used for message resend requests.

Specified by:

get in interface MessageStore

Parameters:

startSequence - the starting message sequence number.

endSequence - the ending message sequence number.

messages - the retrieved messages (out parameter)

Throws:

IOException - IO error

get

public boolean get(int sequence,
                   String message)
            throws IOException

This method is here for JNI API consistency but it's not implemented. Use get(int, int, Collection) with the same start and end sequence.

Throws:

IOException

set

public boolean set(int sequence,
                   String message)
            throws IOException

Description copied from interface: MessageStore

Adds a raw fix messages to the store with the given sequence number. (Most implementations just append the message data to the store so be careful about assuming random access behavior.)

Specified by:

set in interface MessageStore

Parameters:

sequence - the sequence number

message - the raw FIX message string

Returns:

true is successful, false otherwise

Throws:

IOException - IO error

refresh

public void refresh()
             throws IOException

Description copied from interface: MessageStore

Refresh session state from a shared state storage (e.g. database, file, ...). Refresh will not work for message stores without shared state (e.g., MemoryStore). These stores should log an session error, at a minimum, or throw an exception.

Specified by:

refresh in interface MessageStore

Throws:

IOException

reset

public void reset()
           throws IOException

Description copied from interface: MessageStore

Reset the message store. Sequence numbers are set back to 1 and stored messages are erased. The session creation time is also set to the time of the reset.

Specified by:

reset in interface MessageStore

Throws:

IOException - IO error