com.mongodb.internal.connection

Class NoOpSessionContext

java.lang.Object

com.mongodb.internal.connection.NoOpSessionContext

All Implemented Interfaces:

SessionContext

Direct Known Subclasses:

ReadConcernAwareNoOpSessionContext

public class NoOpSessionContext
extends java.lang.Object
implements SessionContext

A SessionContext implementation that does nothing and reports that it has no session.

This class should not be considered a part of the public API.

Field Summary

Fields

Modifier and Type	Field and Description
static NoOpSessionContext	INSTANCE A singleton instance of a NoOpSessionContext

Constructor Summary

Constructors

Constructor and Description
NoOpSessionContext()

Method Summary

Modifier and Type	Method and 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
ReadConcern	getReadConcern() Gets the read concern to apply to operations on this binding.
BsonDocument	getSessionId() Gets the session identifier if this context has a session backing it.
long	getTransactionNumber() Gets the current transaction number.
boolean	hasActiveTransaction() Gets whether the session has an active transaction
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.
boolean	isImplicitSession() Returns true if the session is implicit, and false if the application started the session explicity.
boolean	isSessionMarkedDirty() Whether the server session is marked dirty.
void	markSessionDirty() Mark the session as dirty.
boolean	notifyMessageSent() Notify the session context that a message has been sent.
void	setRecoveryToken(BsonDocument recoveryToken) Sets the recovery token in the session.
void	unpinServerAddress() Unpin a mongos from a session.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final NoOpSessionContext INSTANCE

A singleton instance of a NoOpSessionContext

Constructor Detail

NoOpSessionContext

public NoOpSessionContext()

Method Detail

hasSession

public boolean hasSession()

Description copied from interface: SessionContext

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

Specified by:

hasSession in interface SessionContext

Returns:

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

isImplicitSession

public boolean isImplicitSession()

Description copied from interface: SessionContext

Returns true if the session is implicit, and false if the application started the session explicity.

Specified by:

isImplicitSession in interface SessionContext

Returns:

true if the session is implicit

getSessionId

public BsonDocument getSessionId()

Description copied from interface: SessionContext

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

Specified by:

getSessionId in interface SessionContext

Returns:

the session id

isCausallyConsistent

public boolean isCausallyConsistent()

Description copied from interface: SessionContext

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

Specified by:

isCausallyConsistent in interface SessionContext

Returns:

true ift his context is associated with a causally consistent session

getTransactionNumber

public long getTransactionNumber()

Description copied from interface: SessionContext

Gets the current transaction number.

Specified by:

getTransactionNumber in interface SessionContext

Returns:

the current transaction number

advanceTransactionNumber

public long advanceTransactionNumber()

Description copied from interface: SessionContext

Advance the transaction number.

Specified by:

advanceTransactionNumber in interface SessionContext

Returns:

the next transaction number for the session

notifyMessageSent

public boolean notifyMessageSent()

Description copied from interface: SessionContext

Notify the session context that a message has been sent.

Specified by:

notifyMessageSent in interface SessionContext

Returns:

true if this is the first message sent, false otherwise

getOperationTime

public BsonTimestamp getOperationTime()

Description copied from interface: SessionContext

Gets the current operation time for this session context

Specified by:

getOperationTime in interface SessionContext

Returns:

the current operation time, which may be null

advanceOperationTime

public void advanceOperationTime(BsonTimestamp operationTime)

Description copied from interface: SessionContext

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

Specified by:

advanceOperationTime in interface SessionContext

Parameters:

operationTime - the new operation time time

getClusterTime

public BsonDocument getClusterTime()

Description copied from interface: SessionContext

Gets the current cluster time for this session context.

Specified by:

getClusterTime in interface SessionContext

Returns:

the cluster time, which may be null

advanceClusterTime

public void advanceClusterTime(BsonDocument clusterTime)

Description copied from interface: SessionContext

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

Specified by:

advanceClusterTime in interface SessionContext

Parameters:

clusterTime - the new cluster time

hasActiveTransaction

public boolean hasActiveTransaction()

Description copied from interface: SessionContext

Gets whether the session has an active transaction

Specified by:

hasActiveTransaction in interface SessionContext

Returns:

true if the session has an active transaction

getReadConcern

public ReadConcern getReadConcern()

Description copied from interface: SessionContext

Gets the read concern to apply to operations on this binding.

Specified by:

getReadConcern in interface SessionContext

Returns:

the read concern to apply to operations on this binding

setRecoveryToken

public void setRecoveryToken(BsonDocument recoveryToken)

Description copied from interface: SessionContext

Sets the recovery token in the session.

Specified by:

setRecoveryToken in interface SessionContext

Parameters:

recoveryToken - the recovery token

unpinServerAddress

public void unpinServerAddress()

Description copied from interface: SessionContext

Unpin a mongos from a session.

Specified by:

unpinServerAddress in interface SessionContext

markSessionDirty

public void markSessionDirty()

Description copied from interface: SessionContext

Mark the session as dirty. This happens when a command fails with a network error. Dirty sessions are later discarded from the server session pool.

Specified by:

markSessionDirty in interface SessionContext

isSessionMarkedDirty

public boolean isSessionMarkedDirty()

Description copied from interface: SessionContext

Whether the server session is marked dirty.

Specified by:

isSessionMarkedDirty in interface SessionContext

Returns:

true if the session has been marked dirty