# Copyright (C) 2021-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#

global:
    cpp_namespace: "mongo"

imports:
     - "mongo/db/basic_types.idl"
     - "mongo/rpc/metadata/impersonated_user_metadata.idl"

structs:
    AuthenticationMetadata:
        # Since we need to store this struct in collection,
        # we need to redefine the ImpersonatedUserMetadata struct because
        # it has fields prefixed with with '$' dollar sign that are not supported
        # by our storage engine.
        description: "A struct representing the impersonated users associated with a specific operation."
        strict: false
        fields:
            users:
                type: array<UserName>
                optional: true
            user:
                type: UserName
                optional: true
            roles:
                type: array<RoleName>

    ForwardableOperationMetadataBase:
        description: "Used to store metadata of an operation context that can be safely passed among different threads."
        strict: false
        fields:
            comment:
                type: object_owned
                description: "The comment assiociated with the operation."
                optional: true
            impersonatedUserMetadata:
                type: AuthenticationMetadata
                description: "The impersonated users associated with the operation."
                optional: true
            mayBypassWriteBlocking:
                type: optionalBool
                description: "Whether this operation is allowed to bypass user write blocking."