uk.co.real_logic.artio.session

Interface SessionIdStrategy

public interface SessionIdStrategy

This strategy creates the composite key that uniquely identifies Session Ids. This is a strategy because different gateways identify themselves based upon different sets of fields, Common fields include:

• Sender Company Id + Target Company Id
• Sender Company Id + Sender Sub Id + Target Company Id
• Sender Company Id + Sender Sub Id + Sender Location Id + Target Company Id

Implementations should define their own composite session key type, which must provide correct value based equals/hashcode implementation. Strategy should be stateless. In all cases sender and target are defined from your own perspective of the connection.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INSUFFICIENT_SPACE
static char[]	MISSING_COMP_ID

Method Summary

Modifier and Type	Method and Description
static char[]	checkMissing(char[] providedCompId)
CompositeKey	load(org.agrona.DirectBuffer buffer, int offset, int length) Loads a composite key from a buffer.
CompositeKey	onAcceptLogon(uk.co.real_logic.artio.decoder.SessionHeaderDecoder header) Creates the composite session key when you accept a logon.
CompositeKey	onInitiateLogon(java.lang.String localCompId, java.lang.String localSubId, java.lang.String localLocationId, java.lang.String remoteCompId, java.lang.String remoteSubId, java.lang.String remoteLocationId) Creates the composite session key when you initiate a logon.
int	save(CompositeKey compositeKey, org.agrona.MutableDirectBuffer buffer, int offset) Saves the given composite key to a buffer.
static SessionIdStrategy	senderAndTarget()
static SessionIdStrategy	senderTargetAndSub()
void	setupSession(CompositeKey compositeKey, uk.co.real_logic.artio.builder.SessionHeaderEncoder headerEncoder) Sets up an outbound message header with the composite session key.
int	validateCompIds(CompositeKey compositeKey, uk.co.real_logic.artio.decoder.SessionHeaderDecoder header) Check that the header of a message matches the expected composite key of the session.

Field Detail

MISSING_COMP_ID

static final char[] MISSING_COMP_ID

INSUFFICIENT_SPACE

static final int INSUFFICIENT_SPACE

See Also:

Constant Field Values

Method Detail

checkMissing

static char[] checkMissing(char[] providedCompId)

senderAndTarget

static SessionIdStrategy senderAndTarget()

senderTargetAndSub

static SessionIdStrategy senderTargetAndSub()

onAcceptLogon

CompositeKey onAcceptLogon(uk.co.real_logic.artio.decoder.SessionHeaderDecoder header)
                    throws java.lang.IllegalArgumentException

Creates the composite session key when you accept a logon.

Parameters:

header - the header of the logon message.

Returns:

the composite session key.

Throws:

java.lang.IllegalArgumentException - if the header is missing a required field then an IllegalArgumentException can be thrown.

onInitiateLogon

CompositeKey onInitiateLogon(java.lang.String localCompId,
                             java.lang.String localSubId,
                             java.lang.String localLocationId,
                             java.lang.String remoteCompId,
                             java.lang.String remoteSubId,
                             java.lang.String remoteLocationId)

Creates the composite session key when you initiate a logon.

Parameters:

localCompId - the sender company id, always present.

localSubId - the sender sub id, nullable.

localLocationId - the sender location id, nullable.

remoteCompId - the target company id, always present.

remoteSubId - the target sub id, nullable.

remoteLocationId - the target location id, nullable.

Returns:

the composite session key.

setupSession

void setupSession(CompositeKey compositeKey,
                  uk.co.real_logic.artio.builder.SessionHeaderEncoder headerEncoder)

Sets up an outbound message header with the composite session key.

Parameters:

compositeKey - the composite session key.

headerEncoder - the outbound message header.

save

int save(CompositeKey compositeKey,
         org.agrona.MutableDirectBuffer buffer,
         int offset)

Saves the given composite key to a buffer.

Parameters:

compositeKey - the key to save

buffer - the buffer to save it to

offset - the offset within the buffer to start saving at

Returns:

the length used to save the key, or INSUFFICIENT_SPACE otherwise

load

CompositeKey load(org.agrona.DirectBuffer buffer,
                  int offset,
                  int length)

Loads a composite key from a buffer.

Parameters:

buffer - the buffer to save it to

offset - the offset within the buffer to start saving at

length - the length within the buffer to read from

Returns:

the loaded key or null if there was a failure.

validateCompIds

int validateCompIds(CompositeKey compositeKey,
                    uk.co.real_logic.artio.decoder.SessionHeaderDecoder header)

Check that the header of a message matches the expected composite key of the session.

Parameters:

compositeKey - the expected key.

header - the header of the message that is to be validated.

Returns:

the tag number that is invalid or 0 if everything is valid.