PLCnext API Documentation  22.9.0.33
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 "Arp/System/Rsc/Services/RscString.hxx"
10 #include "Arp/System/Rsc/Services/SecureString.hxx"
11 #include "Arp/System/Security/SecurityToken.hpp"
12 #include "Arp/System/Um/Services/AuthenticationError.hpp"
13 #include "Arp/System/Um/Services/ChannelInformation.hpp"
14 #include "Arp/System/Um/Services/PasswordAuthenticationServiceProxyFactory.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 
35 {
36 public: // typedefs
37  using Ptr = std::shared_ptr<IPasswordAuthenticationService>;
38 
39 public: // construction/destruction
42 
43 public: // static policy operation
44  static IRscServiceProxyFactory& GetProxyFactory(void);
45 
46 public: // abstract operations
86  virtual AuthenticationError CreateSession(const RscString<64>& userName, const SecureString<128>& password, const ChannelInformation& channelInformation, SecurityToken& securityToken, uint32& penaltyDelayMillis, uint32& initialTimeOutMillis) = 0;
87 
97  virtual void ProlongSession(SecurityToken securityToken, uint32& newTimeOutMillis) = 0;
98 
102  virtual void CloseSession(SecurityToken securityToken) = 0;
103 };
104 
106 // inline methods of class IPasswordAuthenticationService
107 inline IRscServiceProxyFactory& IPasswordAuthenticationService::GetProxyFactory()
108 {
109  return PasswordAuthenticationServiceProxyFactory::GetInstance();
110 }
111 
112 }}}} // end of namespace Arp::System::Um::Services
Base interface for all Rsc service interface.
Definition: IRscService.hpp:19
Contains a static string with string lentgh up to N characters. The string has to be null terminated.
Definition: RscString.hxx:21
Specialized version of RscString for security context. Not implemented in this version....
Definition: SecureString.hxx:19
Definition: SecurityToken.hpp:12
Describes an external channel at which the authentication of a user was requested.
Definition: ChannelInformation.hpp:44
Create and close sessions at the UserManager.
Definition: IPasswordAuthenticationService.hpp:35
virtual void ProlongSession(SecurityToken securityToken, uint32 &newTimeOutMillis)=0
Prolongs the timeout of the current session (as referenced by the securityToken within an extended Re...
virtual AuthenticationError CreateSession(const RscString< 64 > &userName, const SecureString< 128 > &password, const ChannelInformation &channelInformation, SecurityToken &securityToken, uint32 &penaltyDelayMillis, uint32 &initialTimeOutMillis)=0
Creates a new Session against the UserManager.
virtual void CloseSession(SecurityToken securityToken)=0
Closed the current session (as referenced by the securityToken within an extended Remoting header).
IPasswordAuthenticationService(void)=default
Constructs an IPasswordAuthenticationService instance.
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:35
@ System
System components used by the System, Device, Plc or Io domains.
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:10
AuthenticationError
Describes several error codes which can occur during an authentication request.
Definition: AuthenticationError.hpp:19
Root namespace for the PLCnext API