biz.onixs.fix.engine.storage

Class FileBasedSessionStorage

java.lang.Object

biz.onixs.fix.engine.storage.AbstractSessionStorage

biz.onixs.fix.engine.storage.FileBasedSessionStorage

All Implemented Interfaces:

SessionStorage

public class FileBasedSessionStorage
extends AbstractSessionStorage

Method Summary

Modifier and Type	Method and Description
void	clear() Clears session storage state.
void	close(boolean terminated) Closes session storage.
void	flush(boolean flushMetadata) Flushes pending session data to persistent storage.
FileFlushPolicy	getFileFlushPolicyPerMessage() Returns the file flush policy applied after processing each message.
String	getId() Returns session storage unique id.
long	getInSeqNum() Returns last inbound message sequence number or 0 if no inbound message is stored.
List<FixMessage>	getOutboundMessages(long beginSequenceNumber, long endSequenceNumber) Returns outbound messages with the specified sequence number interval.
long	getOutSeqNum() Returns last outbound sequence number or 0 if no outbound message is stored.
long	getRotateStorageSize() Returns the size at which the storage file is rotated.
SessionId	getSessionId()
String	getStorageFolder() Returns the storage folder.
TimestampProvider	getTimestampProvider() Returns the current timestamp provider.
boolean	isArchiveStorage() Returns whether to archive terminated storage.
void	setArchiveStorage(boolean archiveStorage) Sets whether to archive terminated storage.
void	setFileFlushPolicyPerMessage(FileFlushPolicy fileFlushPolicyPerMessage) Sets the file flush policy applied after processing each message.
void	setInSeqNum(long msgSeqNum) Sets last inbound message sequence number
void	setMaxStorageSize(int maxStorageSize) Sets the maximum size of the message storage.
void	setOutSeqNum(long msgSeqNum) Sets last outbound message sequence number.
void	setRotateStorageSize(long rotateStorageSize) Sets the size at which the storage file is rotated.
void	setStorageFolder(String storageFolder) Sets the storage folder.
void	setTimestampProvider(TimestampProvider timestampProvider) Sets the timestamp provider which is used to get timestamp when writing the logs.
void	storeInboundMessage(ByteBuffer rawMessage, long msgSeqNum, boolean isOriginal) Stores inbound message.
void	storeOutboundMessage(ByteBuffer rawMessage, long msgSeqNum, boolean isOriginal, boolean warmUp) Stores outbound message.
String	toString()

Methods inherited from class biz.onixs.fix.engine.storage.AbstractSessionStorage

getMaxStorageSize

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getSessionId

public SessionId getSessionId()

isArchiveStorage

public boolean isArchiveStorage()

Returns whether to archive terminated storage.

Returns:

archive terminated storage

setArchiveStorage

public void setArchiveStorage(boolean archiveStorage)

Sets whether to archive terminated storage.

Parameters:

archiveStorage - archive terminated storage

getRotateStorageSize

public long getRotateStorageSize()

Returns the size at which the storage file is rotated.

Returns:

storage rotation size, in bytes

setRotateStorageSize

public void setRotateStorageSize(long rotateStorageSize)

Sets the size at which the storage file is rotated.

Parameters:

rotateStorageSize - storage rotation size, in bytes

getStorageFolder

public String getStorageFolder()

Returns the storage folder.

Returns:

storage folder

setStorageFolder

public void setStorageFolder(String storageFolder)

Sets the storage folder.

Parameters:

storageFolder - storage folder

getTimestampProvider

public TimestampProvider getTimestampProvider()

Returns the current timestamp provider.

Returns:

current timestamp provider

setTimestampProvider

public void setTimestampProvider(TimestampProvider timestampProvider)

Sets the timestamp provider which is used to get timestamp when writing the logs.

Parameters:

timestampProvider - timestamp provider

getFileFlushPolicyPerMessage

public FileFlushPolicy getFileFlushPolicyPerMessage()

Returns the file flush policy applied after processing each message.
A stricter policy improves durability but may reduce performance.

Returns:

per-message FileFlushPolicy, or FileFlushPolicy.NONE if unavailable

setFileFlushPolicyPerMessage

public void setFileFlushPolicyPerMessage(FileFlushPolicy fileFlushPolicyPerMessage)

Sets the file flush policy applied after processing each message.
A stricter policy improves durability but may reduce performance.

Parameters:

fileFlushPolicyPerMessage - per-message FileFlushPolicy

clear

public void clear()

Description copied from interface: SessionStorage

Clears session storage state. Inbound and outbound sequence numbers are reset to 0.

close

public void close(boolean terminated)

Description copied from interface: SessionStorage

Closes session storage.
The terminated set to true means that after closing this session storage can not be restored. Its state is vanished. The session with the same parameters will be started from scratch.
The terminated set to false means that after closing this session can be restored at some point in the future. The session state need to be kept - sequence numbers, etc.

Parameters:

terminated - controls whether this session storage state should be kept or cleaned

getOutboundMessages

public List<FixMessage> getOutboundMessages(long beginSequenceNumber,
                                            long endSequenceNumber)

Description copied from interface: SessionStorage

Returns outbound messages with the specified sequence number interval. Ends are included.
Warning. This is critical to avoid using the method directly.

Parameters:

beginSequenceNumber - sequence number to begin with, 0 means the minimum available

endSequenceNumber - sequence number to end with, 0 means the maximum available

Returns:

outbound messages

storeInboundMessage

public void storeInboundMessage(ByteBuffer rawMessage,
                                long msgSeqNum,
                                boolean isOriginal)

Description copied from interface: SessionStorage

Stores inbound message.

Parameters:

rawMessage - message to store

msgSeqNum - message sequence number

isOriginal - whether message is original or not

storeOutboundMessage

public void storeOutboundMessage(ByteBuffer rawMessage,
                                 long msgSeqNum,
                                 boolean isOriginal,
                                 boolean warmUp)

Description copied from interface: SessionStorage

Stores outbound message.

Parameters:

rawMessage - message to store

msgSeqNum - message sequence number

isOriginal - whether message is original or not

warmUp - indicates whether it is a warmUp message

getId

public String getId()

Description copied from interface: SessionStorage

Returns session storage unique id.

Returns:

session storage unique id

getInSeqNum

public long getInSeqNum()

Description copied from interface: SessionStorage

Returns last inbound message sequence number or 0 if no inbound message is stored.

Returns:

inbound sequence number

setInSeqNum

public void setInSeqNum(long msgSeqNum)

Description copied from interface: SessionStorage

Sets last inbound message sequence number

Parameters:

msgSeqNum - inbound message sequence number

getOutSeqNum

public long getOutSeqNum()

Description copied from interface: SessionStorage

Returns last outbound sequence number or 0 if no outbound message is stored.

Returns:

outbound sequence number

setOutSeqNum

public void setOutSeqNum(long msgSeqNum)

Description copied from interface: SessionStorage

Sets last outbound message sequence number.

Parameters:

msgSeqNum - last outbound message sequence number

setMaxStorageSize

public void setMaxStorageSize(int maxStorageSize)

Description copied from interface: SessionStorage

Sets the maximum size of the message storage.
The details depend on the selected storage implementation.

Specified by:

setMaxStorageSize in interface SessionStorage

Overrides:

setMaxStorageSize in class AbstractSessionStorage

Parameters:

maxStorageSize - maximum size of the message storage

flush

public void flush(boolean flushMetadata)
           throws IOException

Description copied from interface: SessionStorage

Flushes pending session data to persistent storage.

Parameters:

flushMetadata - if true, flushes data and metadata; if false, flushes data only

Throws:

IOException - if the flush operation fails

toString

public String toString()

Overrides:

toString in class Object