biz.onixs.cme.ilink3.handler.storage

Class FileBasedSessionStorage

java.lang.Object

biz.onixs.cme.ilink3.handler.storage.AbstractSessionStorage

biz.onixs.cme.ilink3.handler.storage.FileBasedSessionStorage

All Implemented Interfaces:

SessionStorage

public class FileBasedSessionStorage
extends AbstractSessionStorage

Field Summary

Fields

Modifier and Type	Field and Description
static String	LAST_INBOUND_SEQ_NUM_KEY
static String	LAST_OUTBOUND_PREVIOUS_SEQ_NO_KEY
static String	LAST_OUTBOUND_SEQ_NUM_KEY
static String	NEGOTIATED_KEY
static String	PREVIOUS_UUID
static String	TERMINATION_STATUS
static String	UUID

Method Summary

Modifier and Type	Method and Description
void	clear() Clears session storage state.
void	close(boolean terminated) Closes session storage.
long	getInSeqNum() Returns last inbound message sequence number or 0 if no inbound message is stored.
List<IMessage>	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	getPreviousSeqNo() Returns last inbound message sequence number of previous session or 0 if no inbound message is stored.
long	getPreviousUuid() Returns previous Universally Unique Identifier (UUID).
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.
long	getUuid() Returns Universally Unique Identifier (UUID).
boolean	isArchiveStorage() Returns whether to archive terminated storage.
boolean	isNegotiated() Returns whether the session is negotiated.
boolean	isTerminated() Returns the flag whether this storage state should be kept or cleaned.
void	setArchiveStorage(boolean archiveStorage) Sets whether to archive terminated storage.
void	setInSeqNum(long msgSeqNum) Sets last inbound message sequence number
void	setMaxStorageSize(int maxStorageSize) Sets the maximum size of the message storage.
void	setNegotiated(boolean value) Sets whether the session is negotiated.
void	setOutSeqNum(long msgSeqNum) Sets last outbound message sequence number.
void	setPreviousSeqNo(long seqNo) Sets last inbound message sequence number of previous session
void	setPreviousUuid(long uuid) Sets previous Universally Unique Identifier (UUID).
void	setRotateStorageSize(long rotateStorageSize) Sets the size at which the storage file is rotated.
void	setStorageFolder(String storageFolder) Sets the storage folder.
void	setTerminated(boolean terminated) Sets the flag whether this storage state should be kept or cleaned
void	setTimestampProvider(TimestampProvider timestampProvider) Sets the timestamp provider which is used to get timestamp when writing the logs.
void	setUuid(long uuid) Sets Universally Unique Identifier (UUID).
void	storeInboundMessage(IMessage message, long msgSeqNum) Stores inbound message.
void	storeOutboundMessage(IMessage message, long msgSeqNum, boolean warmUp) Stores outbound message.
String	toString()

Methods inherited from class biz.onixs.cme.ilink3.handler.storage.AbstractSessionStorage

getMaxStorageSize

Methods inherited from class java.lang.Object

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

Field Detail

LAST_INBOUND_SEQ_NUM_KEY

public static final String LAST_INBOUND_SEQ_NUM_KEY

See Also:

Constant Field Values

LAST_OUTBOUND_SEQ_NUM_KEY

public static final String LAST_OUTBOUND_SEQ_NUM_KEY

See Also:

Constant Field Values

LAST_OUTBOUND_PREVIOUS_SEQ_NO_KEY

public static final String LAST_OUTBOUND_PREVIOUS_SEQ_NO_KEY

See Also:

Constant Field Values

NEGOTIATED_KEY

public static final String NEGOTIATED_KEY

See Also:

Constant Field Values

UUID

public static final String UUID

See Also:

Constant Field Values

PREVIOUS_UUID

public static final String PREVIOUS_UUID

See Also:

Constant Field Values

TERMINATION_STATUS

public static final String TERMINATION_STATUS

See Also:

Constant Field Values

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

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<IMessage> 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

endSequenceNumber - sequence number to end with

Returns:

outbound messages

storeInboundMessage

public void storeInboundMessage(IMessage message,
                                long msgSeqNum)

Description copied from interface: SessionStorage

Stores inbound message.

Parameters:

message - message to store

msgSeqNum - message sequence number

storeOutboundMessage

public void storeOutboundMessage(IMessage message,
                                 long msgSeqNum,
                                 boolean warmUp)

Description copied from interface: SessionStorage

Stores outbound message.

Parameters:

message - message to store

msgSeqNum - message sequence number

warmUp - indicates whether it is a warmUp message

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

getPreviousSeqNo

public long getPreviousSeqNo()

Description copied from interface: SessionStorage

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

Returns:

inbound sequence number of previous session

setPreviousSeqNo

public void setPreviousSeqNo(long seqNo)

Description copied from interface: SessionStorage

Sets last inbound message sequence number of previous session

Parameters:

seqNo - inbound message sequence number of previous session

getUuid

public long getUuid()

Description copied from interface: SessionStorage

Returns Universally Unique Identifier (UUID).

Returns:

Universally Unique Identifier (UUID).

setUuid

public void setUuid(long uuid)

Description copied from interface: SessionStorage

Sets Universally Unique Identifier (UUID).

Parameters:

uuid - Universally Unique Identifier (UUID)

getPreviousUuid

public long getPreviousUuid()

Description copied from interface: SessionStorage

Returns previous Universally Unique Identifier (UUID).

Returns:

previous Universally Unique Identifier (UUID).

setPreviousUuid

public void setPreviousUuid(long uuid)

Description copied from interface: SessionStorage

Sets previous Universally Unique Identifier (UUID).

Parameters:

uuid - previous Universally Unique Identifier (UUID)

isNegotiated

public boolean isNegotiated()

Description copied from interface: SessionStorage

Returns whether the session is negotiated.

Returns:

true if the session is negotiated (the Negotiation Response message has been received in reply to the Negotiation message), otherwise false.

setNegotiated

public void setNegotiated(boolean value)

Description copied from interface: SessionStorage

Sets whether the session is negotiated. The session is negotiated when the Negotiation Response message has been received in reply to the Negotiation message.

Parameters:

value - negotiation status.

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

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

toString

public String toString()

Overrides:

toString in class Object