splinter 0.6.14

Splinter is a privacy-focused platform for distributed applications that provides a blockchain-inspired networking environment for communication and transactions between organizations.
Documentation 
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

// Copyright 2018-2020 Cargill Incorporated
//
// Licensed 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.

//! REST API endpoints for the maintenance mode authorization handler

#[cfg(feature = "rest-api-actix-web-1")]
mod actix;
#[cfg(feature = "rest-api-actix-web-1")]
mod resources;

use crate::rest_api::actix_web_1::{Resource, RestResourceProvider};
#[cfg(feature = "rest-api-actix-web-1")]
use crate::rest_api::auth::authorization::Permission;

use super::MaintenanceModeAuthorizationHandler;

#[cfg(feature = "rest-api-actix-web-1")]
const AUTHORIZATION_MAINTENANCE_READ_PERMISSION: Permission = Permission::Check {
    permission_id: "authorization.maintenance.read",
    permission_display_name: "Maintenance mode read",
    permission_description: "Allows the client to check maintenance mode status",
};
#[cfg(feature = "rest-api-actix-web-1")]
const AUTHORIZATION_MAINTENANCE_WRITE_PERMISSION: Permission = Permission::Check {
    permission_id: "authorization.maintenance.write",
    permission_display_name: "Maintenance mode write",
    permission_description: "Allows the client to enable/disable maintenance mode",
};

/// The `MaintenanceModeAuthorizationHandler` provides the following endpoints as REST API
/// resources:
///
/// * `GET /authorization/maintenance` - Check if maintenance mode is enabled
/// * `POST /authorization/maintenance` - Enable/disable maintenance mode
///
/// These endpoints are only available if the following REST API backend feature is enabled:
///
/// * `rest-api-actix`
impl RestResourceProvider for MaintenanceModeAuthorizationHandler {
    fn resources(&self) -> Vec<Resource> {
        // Allowing unused_mut because resources must be mutable if feature rest-api-actix is
        // enabled
        #[allow(unused_mut)]
        let mut resources = Vec::new();

        #[cfg(feature = "rest-api-actix-web-1")]
        {
            resources.push(actix::make_maintenance_resource(self.clone()));
        }

        resources
    }
}