1 
2 /**
3  *    Copyright (C) 2018-present MongoDB, Inc.
4  *
5  *    This program is free software: you can redistribute it and/or modify
6  *    it under the terms of the Server Side Public License, version 1,
7  *    as published by MongoDB, Inc.
8  *
9  *    This program is distributed in the hope that it will be useful,
10  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  *    Server Side Public License for more details.
13  *
14  *    You should have received a copy of the Server Side Public License
15  *    along with this program. If not, see
16  *    <http://www.mongodb.com/licensing/server-side-public-license>.
17  *
18  *    As a special exception, the copyright holders give permission to link the
19  *    code of portions of this program with the OpenSSL library under certain
20  *    conditions as described in each individual source file and distribute
21  *    linked combinations including the program with the OpenSSL library. You
22  *    must comply with the Server Side Public License in all respects for
23  *    all of the code used other than as permitted herein. If you modify file(s)
24  *    with this exception, you may extend this exception to your version of the
25  *    file(s), but you are not obligated to do so. If you do not wish to do so,
26  *    delete this exception statement from your version. If you delete this
27  *    exception statement from all source files in the program, then also delete
28  *    it in the license file.
29  */
30 
31 #pragma once
32 
33 #include <memory>
34 
35 #include "mongo/db/logical_session_id.h"
36 #include "mongo/db/sessions_collection.h"
37 #include "mongo/util/time_support.h"
38 
39 namespace mongo {
40 
41 class OperationContext;
42 
43 /**
44  * Accesses the sessions collection for mongos and shard servers.
45  */
46 class SessionsCollectionSharded : public SessionsCollection {
47 public:
48     /**
49      * Ensures that the sessions collection exists, is sharded,
50      * and has the proper indexes.
51      */
52     Status setupSessionsCollection(OperationContext* opCtx) override;
53 
54     /**
55      * Checks if the sessions collection exists. Does not check if the index exists in the sharded
56      * version of this function.
57      */
58     virtual Status checkSessionsCollectionExists(OperationContext* opCtx) override;
59 
60     /**
61      * Updates the last-use times on the given sessions to be greater than
62      * or equal to the current time.
63      */
64     Status refreshSessions(OperationContext* opCtx,
65                            const LogicalSessionRecordSet& sessions) override;
66 
67     /**
68      * Removes the authoritative records for the specified sessions.
69      */
70     Status removeRecords(OperationContext* opCtx, const LogicalSessionIdSet& sessions) override;
71 
72     StatusWith<LogicalSessionIdSet> findRemovedSessions(
73         OperationContext* opCtx, const LogicalSessionIdSet& sessions) override;
74 
75     Status removeTransactionRecords(OperationContext* opCtx,
76                                     const LogicalSessionIdSet& sessions) override;
77 
78 protected:
79     Status _checkCacheForSessionsCollection(OperationContext* opCtx);
80 };
81 
82 }  // namespace mongo
83