ceph/src/seastar/include/seastar/http/handlers.hh

   1 /*
   2  * This file is open source software, licensed to you under the terms
   3  * of the Apache License, Version 2.0 (the "License").  See the NOTICE file
   4  * distributed with this work for additional information regarding copyright
   5  * ownership.  You may not use this file except in compliance with the License.
   6  *
   7  * You may obtain a copy of the License at
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing,
  12  * software distributed under the License is distributed on an
  13  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  14  * KIND, either express or implied.  See the License for the
  15  * specific language governing permissions and limitations
  16  * under the License.
  17  */
  18 /*
  19  * Copyright 2015 Cloudius Systems
  20  */
  21
  22 #pragma once
  23
  24 #include <seastar/http/request.hh>
  25 #include <seastar/http/common.hh>
  26 #include <seastar/http/reply.hh>
  27 #include <seastar/core/future-util.hh>
  28
  29 #include <unordered_map>
  30
  31 namespace seastar {
  32
  33 namespace httpd {
  34
  35 typedef const httpd::request& const_req;
  36
  37 /**
  38  * handlers holds the logic for serving an incoming request.
  39  * All handlers inherit from the base httpserver_handler and
  40  * implement the handle method.
  41  *
  42  */
  43 class handler_base {
  44 public:
  45     /**
  46      * All handlers should implement this method.
  47      *  It fill the reply according to the request.
  48      * @param path the url path used in this call
  49      * @param params optional parameter object
  50      * @param req the original request
  51      * @param rep the reply
  52      */
  53     virtual future<std::unique_ptr<reply> > handle(const sstring& path,
  54             std::unique_ptr<request> req, std::unique_ptr<reply> rep) = 0;
  55
  56     virtual ~handler_base() = default;
  57
  58     /**
  59      * Add a mandatory parameter
  60      * @param param a parameter name
  61      * @return a reference to the handler
  62      */
  63     handler_base& mandatory(const sstring& param) {
  64         _mandatory_param.push_back(param);
  65         return *this;
  66     }
  67
  68     std::vector<sstring> _mandatory_param;
  69
  70 };
  71
  72 }
  73
  74 }
  75