biz.onixs.cme.ilink3.handler.storage

Interface SessionStorage

All Known Implementing Classes:

AbstractSessionStorage, AsyncFileSessionStorage, FileBasedSessionStorage, MemoryBasedSessionStorage, NullSessionStorage, TimingSessionStorage

public interface SessionStorage

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.
int	getMaxStorageSize() Returns the maximum size of the message storage.
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	getUuid() Returns Universally Unique Identifier (UUID).
boolean	isNegotiated() Returns whether the session is negotiated.
boolean	isTerminated() Returns the flag whether this storage state should be kept or cleaned.
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	setTerminated(boolean terminated) Sets the flag whether this storage state should be kept or cleaned
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.

Method Detail

clear

void clear()

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

close

void close(boolean terminated)

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

Throws:

StorageException - if closing failed

getOutboundMessages

List<IMessage> getOutboundMessages(long beginSequenceNumber,
                                   long endSequenceNumber)

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

Throws:

IllegalArgumentException - if (beginSeqNum < 1)

storeInboundMessage

void storeInboundMessage(IMessage message,
                         long msgSeqNum)

Stores inbound message.

Parameters:

message - message to store

msgSeqNum - message sequence number

Throws:

StorageException - if storing failed

storeOutboundMessage

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

Stores outbound message.

Parameters:

message - message to store

msgSeqNum - message sequence number

warmUp - indicates whether it is a warmUp message

Throws:

StorageException - if storing failed

getInSeqNum

long getInSeqNum()

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

Returns:

inbound sequence number

setInSeqNum

void setInSeqNum(long msgSeqNum)

Sets last inbound message sequence number

Parameters:

msgSeqNum - inbound message sequence number

Throws:

StorageException - if set failed

getOutSeqNum

long getOutSeqNum()

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

Returns:

outbound sequence number

setOutSeqNum

void setOutSeqNum(long msgSeqNum)

Sets last outbound message sequence number.

Parameters:

msgSeqNum - last outbound message sequence number

Throws:

StorageException - if set failed

getPreviousSeqNo

long getPreviousSeqNo()

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

void setPreviousSeqNo(long seqNo)

Sets last inbound message sequence number of previous session

Parameters:

seqNo - inbound message sequence number of previous session

Throws:

StorageException - if set failed

getUuid

long getUuid()

Returns Universally Unique Identifier (UUID).

Returns:

Universally Unique Identifier (UUID).

setUuid

void setUuid(long uuid)

Sets Universally Unique Identifier (UUID).

Parameters:

uuid - Universally Unique Identifier (UUID)

getPreviousUuid

long getPreviousUuid()

Returns previous Universally Unique Identifier (UUID).

Returns:

previous Universally Unique Identifier (UUID).

setPreviousUuid

void setPreviousUuid(long uuid)

Sets previous Universally Unique Identifier (UUID).

Parameters:

uuid - previous Universally Unique Identifier (UUID)

isNegotiated

boolean isNegotiated()

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

void setNegotiated(boolean value)

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

boolean isTerminated()

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

Returns:

flag whether this storage state should be kept or cleaned

setTerminated

void setTerminated(boolean terminated)

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

Parameters:

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

Throws:

StorageException - if set failed

getMaxStorageSize

int getMaxStorageSize()

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

Returns:

maximum size of the message storage

setMaxStorageSize

void setMaxStorageSize(int maxStorageSize)

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

Parameters:

maxStorageSize - maximum size of the message storage

Throws:

IllegalArgumentException - if (maxStorageSize < 0)