Apache Mesos
authenticator.hpp
Go to the documentation of this file.
1 // Licensed to the Apache Software Foundation (ASF) under one
2 // or more contributor license agreements. See the NOTICE file
3 // distributed with this work for additional information
4 // regarding copyright ownership. The ASF licenses this file
5 // to you under the Apache License, Version 2.0 (the
6 // "License"); you may not use this file except in compliance
7 // with the License. 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, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
16 
17 #ifndef __MESOS_AUTHENTICATION_AUTHENTICATOR_HPP__
18 #define __MESOS_AUTHENTICATION_AUTHENTICATOR_HPP__
19 
20 #include <string>
21 
22 #include <mesos/mesos.hpp>
23 
25 
26 #include <process/future.hpp>
27 #include <process/pid.hpp>
28 
29 #include <stout/nothing.hpp>
30 #include <stout/option.hpp>
31 
32 namespace mesos {
33 
35 {
36 public:
38 
39  virtual ~Authenticator() {}
40 
41  virtual Try<Nothing> initialize(const Option<Credentials>& credentials) = 0;
42 
43  // Returns the principal of the Authenticatee if successfully
44  // authenticated otherwise None or an error. Note that we
45  // distinguish authentication failure (None) from a failed future
46  // in the event the future failed due to a transient error and
47  // authentication can (should) be retried. Discarding the future
48  // will cause the future to fail if it hasn't already completed
49  // since we have already started the authentication procedure and
50  // can't reliably cancel.
52  const process::UPID& pid) = 0;
53 };
54 
55 } // namespace mesos {
56 
57 #endif // __MESOS_AUTHENTICATION_AUTHENTICATOR_HPP__
Definition: option.hpp:28
Definition: check.hpp:33
virtual Try< Nothing > initialize(const Option< Credentials > &credentials)=0
An "untyped" PID, used to encapsulate the process ID for lower-layer abstractions (eg...
Definition: pid.hpp:39
Definition: spec.hpp:30
Definition: authenticator.hpp:34
virtual process::Future< Option< std::string > > authenticate(const process::UPID &pid)=0
Authenticator()
Definition: authenticator.hpp:37
virtual ~Authenticator()
Definition: authenticator.hpp:39
Definition: future.hpp:58