Apache Mesos
authenticatee.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_AUTHENTICATEE_HPP__
18 #define __MESOS_AUTHENTICATION_AUTHENTICATEE_HPP__
19 
20 #include <mesos/mesos.hpp>
21 
23 
24 #include <process/future.hpp>
25 #include <process/pid.hpp>
26 
27 namespace mesos {
28 
30 {
31 public:
33 
34  virtual ~Authenticatee() {}
35 
36  // 'pid' is the process to authenticate against (master).
37  // 'client' is the process to be authenticated (slave / framework).
38  // 'credential' is used to authenticate the 'client'.
39  // Returns true if successfully authenticated otherwise false or an
40  // error. Note that we distinguish authentication failure (false)
41  // from a failed future in the event the future failed due to a
42  // transient error and authentication can (should) be
43  // retried. Discarding the future will cause the future to fail if
44  // it hasn't already completed since we have already started the
45  // authentication procedure and can't reliably cancel.
47  const process::UPID& pid,
48  const process::UPID& client,
49  const mesos::Credential& credential) = 0;
50 };
51 
52 } // namespace mesos {
53 
54 #endif // __MESOS_AUTHENTICATION_AUTHENTICATEE_HPP__
virtual ~Authenticatee()
Definition: authenticatee.hpp:34
Authenticatee()
Definition: authenticatee.hpp:32
An "untyped" PID, used to encapsulate the process ID for lower-layer abstractions (eg...
Definition: pid.hpp:39
Definition: spec.hpp:26
virtual process::Future< bool > authenticate(const process::UPID &pid, const process::UPID &client, const mesos::Credential &credential)=0
Definition: authenticatee.hpp:29