Package com.mongodb.internal.session

Class BaseClientSessionImpl

java.lang.Object

com.mongodb.internal.session.BaseClientSessionImpl

All Implemented Interfaces:

ClientSession, java.io.Closeable, java.lang.AutoCloseable

public class BaseClientSessionImpl
extends java.lang.Object
implements ClientSession

Constructor Summary

Constructors

Constructor	Description
BaseClientSessionImpl(ServerSessionPool serverSessionPool, java.lang.Object originator, ClientSessionOptions options)

Method Summary

Modifier and Type	Method	Description
void	advanceClusterTime(BsonDocument newClusterTime)
void	advanceOperationTime(BsonTimestamp newOperationTime)	Set the operation time of the last operation executed in this session.
void	close()
BsonDocument	getClusterTime()
BsonTimestamp	getOperationTime()	Gets the operation time of the last operation executed in this session.
ClientSessionOptions	getOptions()	Get the options for this session.
java.lang.Object	getOriginator()	Gets the originator for the session.
ServerAddress	getPinnedServerAddress()	Get the server address of the pinned mongos on this session.
BsonDocument	getRecoveryToken()	Get the recovery token from the latest outcome in a sharded transaction.
ServerSession	getServerSession()
boolean	isCausallyConsistent()	Returns true if operations in this session must be causally consistent
void	setPinnedServerAddress(ServerAddress address)	Set the server address of the pinned mongos.
void	setRecoveryToken(BsonDocument recoveryToken)	Set the recovery token.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseClientSessionImpl

public BaseClientSessionImpl(ServerSessionPool serverSessionPool,
                             java.lang.Object originator,
                             ClientSessionOptions options)

Method Detail

getPinnedServerAddress

@Nullable
public ServerAddress getPinnedServerAddress()

Description copied from interface: ClientSession

Get the server address of the pinned mongos on this session. For internal use only.

Specified by:

getPinnedServerAddress in interface ClientSession

Returns:

the server address of the pinned mongos

setPinnedServerAddress

public void setPinnedServerAddress(@Nullable
                                   ServerAddress address)

Description copied from interface: ClientSession

Set the server address of the pinned mongos. For internal use only.

Specified by:

setPinnedServerAddress in interface ClientSession

Parameters:

address - the server address to pin

getRecoveryToken

public BsonDocument getRecoveryToken()

Description copied from interface: ClientSession

Get the recovery token from the latest outcome in a sharded transaction. For internal use only.

Specified by:

getRecoveryToken in interface ClientSession

Returns:

the recovery token

setRecoveryToken

public void setRecoveryToken(BsonDocument recoveryToken)

Description copied from interface: ClientSession

Set the recovery token. For internal use only.

Specified by:

setRecoveryToken in interface ClientSession

Parameters:

recoveryToken - the recovery token

getOptions

public ClientSessionOptions getOptions()

Description copied from interface: ClientSession

Get the options for this session.

Specified by:

getOptions in interface ClientSession

Returns:

the options, which may not be null

isCausallyConsistent

public boolean isCausallyConsistent()

Description copied from interface: ClientSession

Returns true if operations in this session must be causally consistent

Specified by:

isCausallyConsistent in interface ClientSession

Returns:

whether operations in this session must be causally consistent.

getOriginator

public java.lang.Object getOriginator()

Description copied from interface: ClientSession

Gets the originator for the session.

Important because sessions must only be used by their own originator.

Specified by:

getOriginator in interface ClientSession

Returns:

the sessions originator

getClusterTime

public BsonDocument getClusterTime()

Specified by:

getClusterTime in interface ClientSession

Returns:

the latest cluster time seen by this session

getOperationTime

public BsonTimestamp getOperationTime()

Description copied from interface: ClientSession

Gets the operation time of the last operation executed in this session.

Specified by:

getOperationTime in interface ClientSession

Returns:

the operation time

getServerSession

public ServerSession getServerSession()

Specified by:

getServerSession in interface ClientSession

Returns:

the server session

advanceOperationTime

public void advanceOperationTime(BsonTimestamp newOperationTime)

Description copied from interface: ClientSession

Set the operation time of the last operation executed in this session.

Specified by:

advanceOperationTime in interface ClientSession

Parameters:

newOperationTime - the operation time

advanceClusterTime

public void advanceClusterTime(BsonDocument newClusterTime)

Specified by:

advanceClusterTime in interface ClientSession

Parameters:

newClusterTime - the cluster time to advance to

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface ClientSession

Specified by:

close in interface java.io.Closeable