/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.mongodb.session;

import com.mongodb.ReadConcern;
import org.bson.BsonDocument;
import org.bson.BsonTimestamp;

The session context.
Since:
3.6/**
 * The session context.
 *
 * @since 3.6
 */
public interface SessionContext {

    
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./**
     * Returns true if there is a true server session associated with this context.
     *
     * @return true if there is a true server session associated with this context.
     */
    boolean hasSession();

    
Returns true if the session is implicit, and false if the application started the session explicity.
Returns:
true if the session is implicit
Since:
3.8/**
     * Returns true if the session is implicit, and false if the application started the session explicity.
     *
     * @return true if the session is implicit
     * @since 3.8
     */
    boolean isImplicitSession();

    
Gets the session identifier if this context has a session backing it.
Returns:
the session id/**
     * Gets the session identifier if this context has a session backing it.
     *
     * @return the session id
     */
    BsonDocument getSessionId();

    
Gets whether this context is associated with a causally consistent session.
Returns:
true ift his context is associated with a causally consistent session/**
     * Gets whether this context is associated with a causally consistent session.
     *
     * @return true ift his context is associated with a causally consistent session
     */
    boolean isCausallyConsistent();

    
Gets the current transaction number.
Returns:
the current transaction number
Since:
3.8/**
     * Gets the current transaction number.
     *
     * @return the current transaction number
     * @since 3.8
     */
    long getTransactionNumber();

    
Advance the transaction number.
Returns:
the next transaction number for the session/**
     * Advance the transaction number.
     *
     * @return the next transaction number for the session
     */
    long advanceTransactionNumber();

    
 Notify the session context that a message has been sent.
Returns:
true if this is the first message sent, false otherwise
Since:
3.8/**
     *  Notify the session context that a message has been sent.
     *
     * @return true if this is the first message sent, false otherwise
     * @since 3.8
     */
    boolean notifyMessageSent();

    
Gets the current operation time for this session context
Returns:
the current operation time, which may be null/**
     * Gets the current operation time for this session context
     *
     * @return the current operation time, which may be null
     */
    BsonTimestamp getOperationTime();

    
Advance the operation time.  If the current operation time is greater than the given operation time, this method has no effect.
Params:
operationTime – the new operation time time/**
     * Advance the operation time.  If the current operation time is greater than the given operation time, this method has no effect.
     *
     * @param operationTime the new operation time time
     */
    void advanceOperationTime(BsonTimestamp operationTime);

    
Gets the current cluster time for this session context.
Returns:
the cluster time, which may be null/**
     * Gets the current cluster time for this session context.
     *
     * @return the cluster time, which may be null
     */
    BsonDocument getClusterTime();

    
Advance the cluster time. If the current cluster time is greater than the given cluster time, this method has no effect.
Params:
clusterTime – the new cluster time/**
     * Advance the cluster time. If the current cluster time is greater than the given cluster time, this method has no effect.
     *
     * @param clusterTime the new cluster time
     */
    void advanceClusterTime(BsonDocument clusterTime);

    
Gets whether the session has an active transaction
Returns:
true if the session has an active transaction
Since:
3.8
@mongodb.server.release
4.0/**
     * Gets whether the session has an active transaction
     *
     * @return true if the session has an active transaction
     * @since 3.8
     * @mongodb.server.release 4.0
     */
    boolean hasActiveTransaction();

    
Gets the read concern to apply to operations on this binding.
Returns:
the read concern to apply to operations on this binding
Since:
3.8/**
     * Gets the read concern to apply to operations on this binding.
     *
     * @return the read concern to apply to operations on this binding
     * @since 3.8
     */
    ReadConcern getReadConcern();

    
Sets the recovery token in the session.
Params:
recoveryToken – the recovery token
Since:
3.11/**
     * Sets the recovery token in the session.
     *
     * @param recoveryToken the recovery token
     * @since 3.11
     */
    void setRecoveryToken(BsonDocument recoveryToken);

    
Unpin a mongos from a session.
Since:
3.11/**
     * Unpin a mongos from a session.
     *
     * @since 3.11
     */
    void unpinServerAddress();
}