File size: 3,400 Bytes
855c073 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 | // Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you 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.
// Middleware for handling Flight SQL Sessions including session cookie handling.
#pragma once
#include <functional>
#include <map>
#include <optional>
#include <shared_mutex>
#include <string_view>
#include "arrow/flight/server_middleware.h"
#include "arrow/flight/sql/types.h"
#include "arrow/status.h"
namespace arrow {
namespace flight {
namespace sql {
static constexpr char const kSessionCookieName[] = "arrow_flight_session_id";
class ARROW_FLIGHT_SQL_EXPORT FlightSession {
protected:
std::map<std::string, SessionOptionValue> map_;
std::shared_mutex map_lock_;
public:
/// \brief Get session option by name
std::optional<SessionOptionValue> GetSessionOption(const std::string& name);
/// \brief Get a copy of the session options map.
///
/// The returned options map may be modified by further calls to this FlightSession
std::map<std::string, SessionOptionValue> GetSessionOptions();
/// \brief Set session option by name to given value
void SetSessionOption(const std::string& name, const SessionOptionValue value);
/// \brief Idempotently remove name from this session
void EraseSessionOption(const std::string& name);
};
/// \brief A middleware to handle session option persistence and related cookie headers.
///
/// WARNING that client cookie invalidation does not currently work due to a gRPC
/// transport bug.
class ARROW_FLIGHT_SQL_EXPORT ServerSessionMiddleware : public ServerMiddleware {
public:
static constexpr char const kMiddlewareName[] =
"arrow::flight::sql::ServerSessionMiddleware";
std::string name() const override { return kMiddlewareName; }
/// \brief Is there an existing session (either existing or new)
virtual bool HasSession() const = 0;
/// \brief Get existing or new call-associated session
///
/// May return NULLPTR if there is an id generation collision.
virtual arrow::Result<std::shared_ptr<FlightSession>> GetSession() = 0;
/// Close the current session.
///
/// This is presently unsupported in C++ until middleware handling can be fixed.
virtual Status CloseSession() = 0;
/// \brief Get request headers, in lieu of a provided or created session.
virtual const CallHeaders& GetCallHeaders() const = 0;
};
/// \brief Returns a ServerMiddlewareFactory that handles session option storage.
/// \param[in] id_gen A thread-safe, collision-free generator for session id strings.
ARROW_FLIGHT_SQL_EXPORT std::shared_ptr<ServerMiddlewareFactory>
MakeServerSessionMiddlewareFactory(std::function<std::string()> id_gen);
} // namespace sql
} // namespace flight
} // namespace arrow
|