Package com.opencloud.sentinel.common

Interface SentinelCommonSessionState

All Superinterfaces:

NullSentinelSessionState

All Known Subinterfaces:

SentinelByNameSessionState, SentinelDiameterMediationSessionState, SentinelDiameterSessionState, SentinelPromotionsSessionState, SentinelSessionState, SentinelSipSessionState, SentinelSs7CommonSessionState, SentinelSs7SessionState, SessionCountersSessionState

@SessionStateInterface
public interface SentinelCommonSessionState
extends NullSentinelSessionState

Session state interface with the fields most commonly needed by features.

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	_initialSessionHasEnded
static SessionType	_initialSessionType

Method Summary

Modifier and Type	Method	Description
com.opencloud.sentinel.common.SentinelProtocol	getProtocol()	Returns the current protocol in use by the service.
com.opencloud.sentinel.common.SentinelSelectionKey	getSentinelSelectionKey()	Get the sentinel selection key associated with this session.
boolean	getSessionHasEnded()	Check if the current session has ended or not.
SessionType	getSessionType()	Get the type of this session.
java.lang.String	getSubscriber()	Get the subscriber associated with the current session.
void	setProtocol(com.opencloud.sentinel.common.SentinelProtocol protocol)	Sets the current protocol in use by the service.
void	setSentinelSelectionKey(com.opencloud.sentinel.common.SentinelSelectionKey SentinelSelectionKey)	Set the current sentinel selection key associated with this session.
void	setSessionHasEnded(boolean SessionHasEnded)	Record that the session has ended.
void	setSessionType(SessionType SessionType)	Set the session type
void	setSubscriber(java.lang.String Subscriber)	set the Subscriber for this session

Field Detail

_initialSessionType

static final SessionType _initialSessionType

_initialSessionHasEnded

static final boolean _initialSessionHasEnded

See Also:

Constant Field Values

Method Detail

setSubscriber

void setSubscriber(java.lang.String Subscriber)

set the Subscriber for this session

getSubscriber

java.lang.String getSubscriber()

Get the subscriber associated with the current session. This field will be initialised through an analysis by the respective Sentinel core service. Thus it will be available irrespective of what features have been running before.

Returns:

the subscriber

setSentinelSelectionKey

@DatatypeCodecType(com.opencloud.sentinel.common.impl.SentinelSelectionKeyCodec.class)
void setSentinelSelectionKey(com.opencloud.sentinel.common.SentinelSelectionKey SentinelSelectionKey)

Set the current sentinel selection key associated with this session. Features should first getSentinelSelectionKey() and update the sentinel selection key that is returned.

getSentinelSelectionKey

com.opencloud.sentinel.common.SentinelSelectionKey getSentinelSelectionKey()

Get the sentinel selection key associated with this session. If a feature updates the sentinel selection key they must then inform sentinel by setSentinelSelectionKey.

Returns:

the current sentinel selection key

setSessionType

@InitialValueField
void setSessionType(SessionType SessionType)

Set the session type

getSessionType

SessionType getSessionType()

Get the type of this session.

Returns:

the session type

setSessionHasEnded

@InitialValueField
void setSessionHasEnded(boolean SessionHasEnded)

Record that the session has ended.

getSessionHasEnded

boolean getSessionHasEnded()

Check if the current session has ended or not.

Returns:

true iff the initiating session has ended

setProtocol

void setProtocol(com.opencloud.sentinel.common.SentinelProtocol protocol)

Sets the current protocol in use by the service.

getProtocol

com.opencloud.sentinel.common.SentinelProtocol getProtocol()

Returns the current protocol in use by the service.