OW_NAMESPACE::AuthenticatorIFC Class Reference

#include <OW_AuthenticatorIFC.hpp>

Inheritance diagram for OW_NAMESPACE::AuthenticatorIFC:

[legend]Collaboration diagram for OW_NAMESPACE::AuthenticatorIFC:

[legend]List of all members.

Public Member Functions
	AuthenticatorIFC ()
virtual	~AuthenticatorIFC ()
void	init (const ServiceEnvironmentIFCRef &env)
	Called when authenticator is loaded.
bool	authenticate (String &userName, const String &info, String &details, OperationContext &context)
	Authenticates a user.
Protected Member Functions
virtual bool	doAuthenticate (String &userName, const String &info, String &details, OperationContext &context)=0
	Authenticates a user.
virtual void	doInit (ServiceEnvironmentIFCRef)
	Called when authenticator is loaded Exceptions: Any  exception may be thrown because other classes which derive from this may need to throw exceptions in init().
Protected Attributes
Mutex	m_mutex
Private Attributes
UInt32	signature

---

Detailed Description

Definition at line 52 of file OW_AuthenticatorIFC.hpp.

---

Constructor & Destructor Documentation

OW_NAMESPACE::AuthenticatorIFC::AuthenticatorIFC (   )  [inline]

Definition at line 55 of file OW_AuthenticatorIFC.hpp.

OW_NAMESPACE::AuthenticatorIFC::~AuthenticatorIFC (   )  [virtual]

Definition at line 43 of file OW_AuthenticatorIFC.cpp.

---

Member Function Documentation

bool OW_NAMESPACE::AuthenticatorIFC::authenticate (  String &  userName, const String &  info, String &  details, OperationContext &  context )  [inline]

Authenticates a user. Parameters: userName  The name of the of the user being authenticated type  A string describing the type of authentication info  The authentication credentials details  An out parameter used to provide information as to why the authentication failed. context  An operation context. Returns: True if user is authenticated Definition at line 84 of file OW_AuthenticatorIFC.hpp. References context, and m_mutex.

virtual bool OW_NAMESPACE::AuthenticatorIFC::doAuthenticate (  String &  userName, const String &  info, String &  details, OperationContext &  context )  [protected, pure virtual]

Authenticates a user. Parameters: userName  The name of the of the user being authenticated info  The authentication credentials details  An out parameter used to provide information as to why the authentication failed context  An operation context. . Returns: True if user is authenticated Implemented in OW_NAMESPACE::AIXAuthentication, OW_NAMESPACE::NonAuthenticatingAuthenticator, OW_NAMESPACE::LinuxPAMAuthentication, OW_NAMESPACE::LinuxPAMAuthenticationCL, and OW_NAMESPACE::ListenerAuthenticator.

void OW_NAMESPACE::AuthenticatorIFC::doInit (  ServiceEnvironmentIFCRef   )  [protected, virtual]

Called when authenticator is loaded Exceptions: Any  exception may be thrown because other classes which derive from this may need to throw exceptions in init(). Reimplemented in OW_NAMESPACE::AIXAuthentication, OW_NAMESPACE::NonAuthenticatingAuthenticator, OW_NAMESPACE::LinuxPAMAuthentication, OW_NAMESPACE::LinuxPAMAuthenticationCL, and OW_NAMESPACE::ListenerAuthenticator. Definition at line 49 of file OW_AuthenticatorIFC.cpp.

void OW_NAMESPACE::AuthenticatorIFC::init (  const ServiceEnvironmentIFCRef &  env  )  [inline]

Called when authenticator is loaded. Parameters: env  A reference to an ServiceEnvironment for the authenticator to use. Exceptions: Any  exception may be thrown because other classes which derive from this may need to throw exceptions in init() Definition at line 66 of file OW_AuthenticatorIFC.hpp. References env.

---

Member Data Documentation

Mutex OW_NAMESPACE::AuthenticatorIFC::m_mutex [protected]

Definition at line 116 of file OW_AuthenticatorIFC.hpp. Referenced by OW_NAMESPACE::ListenerAuthenticator::getNewCredentials(), and OW_NAMESPACE::ListenerAuthenticator::removeCredentials().

UInt32 OW_NAMESPACE::AuthenticatorIFC::signature [private]

Definition at line 91 of file OW_AuthenticatorIFC.hpp.

---

The documentation for this class was generated from the following files:

• OW_AuthenticatorIFC.hpp
• OW_AuthenticatorIFC.cpp

---