PLCnext API Documentation  21.6.0.46
IPasswordAuthenticationService.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include "Arp/System/Rsc/Services/IRscService.hpp"
9 #include "PasswordAuthenticationServiceProxyFactory.hpp"
10 #include "Arp/System/Rsc/Services/RscString.hxx"
11 #include "Arp/System/Rsc/Services/SecureString.hxx"
12 #include "Arp/System/Security/SecurityToken.hpp"
13 #include "AuthenticationError.hpp"
14 
15 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IPasswordAuthenticationService.cs
16 
17 namespace Arp { namespace System { namespace Security { namespace Services
18 {
19 
20 using namespace Arp;
21 using namespace Arp::System::Rsc::Services;
22 
34 {
35 public: // typedefs
36  using Ptr = std::shared_ptr<IPasswordAuthenticationService>;
37 
38 public: // construction/destruction
40  IPasswordAuthenticationService(void) = default;
41 
42 public: // static policy operation
43  static IRscServiceProxyFactory& GetProxyFactory(void);
44 
45 public: // abstract operations
106  virtual AuthenticationError CreateSession(const RscString<64>& username, const SecureString<128>& password, SecurityToken& securityToken, int32& penaltyDelayMillis) = 0;
107 
114  virtual void CloseSession(SecurityToken securityToken) = 0;
115 };
116 
118 // inline methods of class IPasswordAuthenticationService
119 inline IRscServiceProxyFactory& IPasswordAuthenticationService::GetProxyFactory()
120 {
121  return PasswordAuthenticationServiceProxyFactory::GetInstance();
122 }
123 
124 }}}} // end of namespace Arp::System::Security::Services
Definition: SecurityToken.hpp:11
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:9
Specialized version of RscString for security context. Not implemented in this version. Wraps only RscString
Definition: RscType.hpp:27
Root namespace for the PLCnext API
Base interface for all Rsc service interface.
Definition: IRscService.hpp:18
std::int32_t int32
The Arp integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:37
System components used by the System, Device, Plc or Io domains.
Contains a static string with string lentgh up to N characters. The string has to be null terminated...
Definition: RscString.hxx:18
This service allows a Remoting client to authenticate a user to the gateway (device) and by this star...
Definition: IPasswordAuthenticationService.hpp:33