summaryrefslogtreecommitdiff
path: root/src/mongo/idl/command_generic_argument.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/mongo/idl/command_generic_argument.h')
-rw-r--r--src/mongo/idl/command_generic_argument.h62
1 files changed, 62 insertions, 0 deletions
diff --git a/src/mongo/idl/command_generic_argument.h b/src/mongo/idl/command_generic_argument.h
new file mode 100644
index 00000000000..69d695250ec
--- /dev/null
+++ b/src/mongo/idl/command_generic_argument.h
@@ -0,0 +1,62 @@
+/**
+ * Copyright (C) 2018-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.
+ */
+
+#pragma once
+
+#include "mongo/base/string_data.h"
+
+namespace mongo {
+
+/**
+ * Returns true if the provided argument is one that is handled by the command processing layer
+ * and should generally be ignored by individual command implementations. In particular,
+ * commands that fail on unrecognized arguments must not fail for any of these.
+ */
+bool isGenericArgument(StringData arg);
+
+/**
+ * Returns true if arg must be stripped from requests that are forwarded to shards.
+ * Only generic arguments are stripped, and some of them are not.
+ * See 'CommandHelpers::filterCommandRequestForPassthrough'.
+ */
+bool isRequestStripArgument(StringData arg);
+
+/**
+ * Returns true if arg is not safe to blindly forward from shards to clients.
+ * See 'CommandHelpers::filterCommandReplyForPassthrough'.
+ */
+bool isReplyStripArgument(StringData arg);
+
+/**
+ * Returns true if the provided argument is one that should be handled by a mongocryptd process.
+ */
+bool isMongocryptdArgument(StringData arg);
+
+
+} // namespace mongo