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
  28 #include <unordered_map>
  29
  30 namespace seastar {
  31
  32 namespace httpd {
  33
  34 typedef const http::request& const_req;
  35
  36 /**
  37  * handlers holds the logic for serving an incoming request.
  38  * All handlers inherit from the base httpserver_handler and
  39  * implement the handle method.
  40  *
  41  */
  42 class handler_base {
  43 public:
  44     /**
  45      * All handlers should implement this method.
  46      *  It fill the reply according to the request.
  47      * @param path the url path used in this call
  48      * @param req the original request
  49      * @param rep the reply
  50      */
  51     virtual future<std::unique_ptr<http::reply> > handle(const sstring& path,
  52             std::unique_ptr<http::request> req, std::unique_ptr<http::reply> rep) = 0;
  53
  54     virtual ~handler_base() = default;
  55
  56     /**
  57      * Add a mandatory parameter
  58      * @param param a parameter name
  59      * @return a reference to the handler
  60      */
  61     handler_base& mandatory(const sstring& param) {
  62         _mandatory_param.push_back(param);
  63         return *this;
  64     }
  65
  66     std::vector<sstring> _mandatory_param;
  67
  68 };
  69
  70 }
  71
  72 }
  73