PLCnext API Documentation  22.3.0.20
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 #include "ChannelInformation.hpp"
15 
16 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IPasswordAuthenticationService.cs
17 
18 namespace Arp { namespace System { namespace Um { namespace Services
19 {
20 
21 using namespace Arp;
22 using namespace Arp::System::Rsc::Services;
23 
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
85  virtual AuthenticationError CreateSession(const RscString<64>& userName, const SecureString<128>& password, const ChannelInformation& channelInformation, SecurityToken& securityToken, uint32& penaltyDelayMillis, uint32& initialTimeOutMillis) = 0;
86 
96  virtual void ProlongSession(SecurityToken securityToken, uint32& newTimeOutMillis) = 0;
97 
101  virtual void CloseSession(SecurityToken securityToken) = 0;
102 };
103 
105 // inline methods of class IPasswordAuthenticationService
106 inline IRscServiceProxyFactory& IPasswordAuthenticationService::GetProxyFactory()
107 {
108  return PasswordAuthenticationServiceProxyFactory::GetInstance();
109 }
110 
111 }}}} // end of namespace Arp::System::Um::Services
Definition: SecurityToken.hpp:11
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:9
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:35
Describes an external channel at which the authentication of a user was requested.
Definition: ChannelInformation.hpp:43
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
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
Create and close sessions at the UserManager.
Definition: IPasswordAuthenticationService.hpp:33