Package com.mongodb.session

Interface SessionContext

public interface SessionContext

The session context.

Since:

3.6

Method Summary

Modifier and Type	Method	Description
void	advanceClusterTime(BsonDocument clusterTime)	Advance the cluster time.
void	advanceOperationTime(BsonTimestamp operationTime)	Advance the operation time.
long	advanceTransactionNumber()	Advance the transaction number.
BsonDocument	getClusterTime()	Gets the current cluster time for this session context.
BsonTimestamp	getOperationTime()	Gets the current operation time for this session context
BsonDocument	getSessionId()	Gets the session identifier if this context has a session backing it.
boolean	hasSession()	Returns true if there is a true server session associated with this context.
boolean	isCausallyConsistent()	Gets whether this context is associated with a causally consistent session.

Method Detail

hasSession

boolean hasSession()

Returns true if there is a true server session associated with this context.

Returns:

true if there is a true server session associated with this context.

getSessionId

BsonDocument getSessionId()

Gets the session identifier if this context has a session backing it.

Returns:

the session id

isCausallyConsistent

boolean isCausallyConsistent()

Gets whether this context is associated with a causally consistent session.

Returns:

true ift his context is associated with a causally consistent session

advanceTransactionNumber

long advanceTransactionNumber()

Advance the transaction number.

Returns:

the next transaction number for the session

getOperationTime

BsonTimestamp getOperationTime()

Gets the current operation time for this session context

Returns:

the current operation time, which may be null

advanceOperationTime

void advanceOperationTime(BsonTimestamp operationTime)

Advance the operation time. If the current operation time is greater than the given operation time, this method has no effect.

Parameters:

operationTime - the new operation time time

getClusterTime

BsonDocument getClusterTime()

Gets the current cluster time for this session context.

Returns:

the cluster time, which may be null

advanceClusterTime

void advanceClusterTime(BsonDocument clusterTime)

Advance the cluster time. If the current cluster time is greater than the given cluster time, this method has no effect.

Parameters:

clusterTime - the new cluster time