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

Field Summary

static String

SUMMARY_FILE_EXT

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

keepInMessages, maxStorageSize

Method Summary

void	clear() Clears session storage state. Inbound and outbound sequence numbers are reset to 0.
void	close(boolean terminated) Closes session storage. The terminated set to true means that after closing this session storage can not be restored.
protected void	closeFiles()
String	getId() Returns session storage unique id.
long	getInSeqNum() Returns last inbound message sequence number or 0 if no inbound message is stored.
Message	getMessage(MessageDirection direction, long sequenceNumber) Returns last message with the specified direction and sequence number.
List<Message>	getMessages(MessageDirection direction, long beginSequenceNumber, long endSequenceNumber) Returns messages with the specified direction and sequence number interval.
long	getOutSeqNum() Returns last outbound sequence number or 0 if no outbound message is stored.
long	getRotateStorageSize()
boolean	isScramblePassword() Returns whether to scramble passwords in the session storage
boolean	isTerminated() Returns the flag whether this storage state should be kept or cleaned.
void	open() Opens session storage.
void	readLog()
void	setInSeqNum(long inSeqNum) Sets last inbound message sequence number
void	setOutSeqNum(long outSeqNum) Sets last outbound message sequence number.
void	setRotateStorageSize(long rotateStorageSize)
void	setScramblePassword(boolean scramblePassword) Sets whether to scramble passwords in the session storage
void	setTerminated(boolean terminated) Sets the flag whether this storage state should be kept or cleaned
void	storeMessage(MessageDirection direction, long msgSeqNum, biz.onixs.util.ByteBuffer rawMessage) Stores message.
void	storeMessage(MessageDirection direction, Message message, biz.onixs.util.ByteBuffer rawMessage) Stores message.
String	toString()

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

getMaxStorageSize, setMaxStorageSize

Methods inherited from class java.lang.Object

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

Field Detail

SUMMARY_FILE_EXT

public static final String SUMMARY_FILE_EXT

See Also:

Constant Field Values

Method Detail

open

public void open()

Description copied from interface: SessionStorage

Opens session storage.

isScramblePassword

public boolean isScramblePassword()

Returns whether to scramble passwords in the session storage

Returns:

scramble password flag

setScramblePassword

public void setScramblePassword(boolean scramblePassword)

Sets whether to scramble passwords in the session storage

Parameters:

scramblePassword - scramble password flag

getMessage

public Message getMessage(MessageDirection direction,
                          long sequenceNumber)

Description copied from interface: SessionStorage

Returns last message with the specified direction and sequence number.

Parameters:

direction - message direction

sequenceNumber - message sequence number

Returns:

message or null if not available

getMessages

public List<Message> getMessages(MessageDirection direction,
                                 long beginSequenceNumber,
                                 long endSequenceNumber)

Description copied from interface: SessionStorage

Returns messages with the specified direction and sequence number interval. Ends are included.

Parameters:

direction - messages direction

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

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

getId

public String getId()

Description copied from interface: SessionStorage

Returns session storage unique id.

Returns:

session storage unique id

storeMessage

public void storeMessage(MessageDirection direction,
                         long msgSeqNum,
                         biz.onixs.util.ByteBuffer rawMessage)

Description copied from interface: SessionStorage

Stores message.

Parameters:

direction - message direction

msgSeqNum - message sequence number

rawMessage - message to store

storeMessage

public void storeMessage(MessageDirection direction,
                         Message message,
                         biz.onixs.util.ByteBuffer rawMessage)

Description copied from interface: SessionStorage

Stores message.

Parameters:

direction - message direction

message - message to store

rawMessage - message to store in a raw format

isTerminated

public boolean isTerminated()

Description copied from interface: SessionStorage

Returns the flag whether this storage state should be kept or cleaned.

Returns:

flag whether this storage state should be kept or cleaned

setTerminated

public void setTerminated(boolean terminated)

Description copied from interface: SessionStorage

Sets the flag whether this storage state should be kept or cleaned

Parameters:

terminated - flag whether this storage state should be kept or cleaned

readLog

public void readLog()

closeFiles

protected void closeFiles()
                   throws IOException

Throws:

IOException

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 inSeqNum)

Description copied from interface: SessionStorage

Sets last inbound message sequence number

Parameters:

inSeqNum - 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 outSeqNum)

Description copied from interface: SessionStorage

Sets last outbound message sequence number.

Parameters:

outSeqNum - last outbound message sequence number

getRotateStorageSize

public long getRotateStorageSize()

setRotateStorageSize

public void setRotateStorageSize(long rotateStorageSize)

toString

public String toString()

Overrides:

toString in class Object