AuthenticatedEntity Class Reference

#include <Authentication/Common/authenticatedentity.h>

Public Member Functions
	AuthenticatedEntity ()
	AuthenticatedEntity (AuthenticatedEntity &&)=delete
	AuthenticatedEntity (const AuthenticatedEntity &)=delete
	AuthenticatedEntity (const QString &authenticationProvider, const QString &authenticationProviderVersion, Credentials *authenticationCredentials=nullptr)
virtual	~AuthenticatedEntity ()
const Credentials *	getAuthenticationCredentials () const
const QString &	getAuthenticationProvider () const
const QString &	getAuthenticationProviderVersion () const
AuthenticatedEntity &	operator= (AuthenticatedEntity &&)=delete
AuthenticatedEntity &	operator= (const AuthenticatedEntity &)=delete
void	setAuthenticationCredentials (const QString &credentials)
void	setAuthenticationProvider (const QString &provider)
void	setAuthenticationProviderVersion (const QString &version)

Detailed Description

Represents an entity (person or otherwise) that has access to a remote resource. They have associated credentials that can be checked by an Authenticator.

Constructor & Destructor Documentation

AuthenticatedEntity() [1/4]

AuthenticatedEntity

(

)

Default constructor.

AuthenticatedEntity() [2/4]

AuthenticatedEntity ( const AuthenticatedEntity &  )

delete

AuthenticatedEntity() [3/4]

AuthenticatedEntity ( AuthenticatedEntity &&  )

delete

AuthenticatedEntity() [4/4]

AuthenticatedEntity	(	const QString &	authenticationProvider,
		const QString &	authenticationProviderVersion,
		Credentials *	authenticationCredentials = nullptr
	)

Initialising constructor.

Parameters

authenticationProvider	The authentication provider
authenticationProviderVersion	The authentication provider version
authenticationCredentials	Credentials to use when authenticating against the provided provider

~AuthenticatedEntity()

~AuthenticatedEntity ( )

virtualdefault

Destructor.

Member Function Documentation

getAuthenticationCredentials()

const Credentials * getAuthenticationCredentials

(

)

const

Returns the authentication credentials associated with this entity.

Returns

The credentials associated with this entity.

getAuthenticationProvider()

const QString & getAuthenticationProvider

(

)

const

Returns the authentication provider associated with this entity.

Returns

The authentication provider assocaited with this entity.

getAuthenticationProviderVersion()

const QString & getAuthenticationProviderVersion

(

)

const

Gets the authentication provider version associated with this entity.

Returns

The version of the authentication provider.

operator=() [1/2]

AuthenticatedEntity & operator= ( AuthenticatedEntity &&  )

delete

operator=() [2/2]

AuthenticatedEntity & operator= ( const AuthenticatedEntity &  )

delete

setAuthenticationCredentials()

void setAuthenticationCredentials

(

const QString &

credentials

)

Sets the authentication credentials associated with this authenticated entity.

Parameters

credentials

The credentials associated with this authenticated entity.

setAuthenticationProvider()

void setAuthenticationProvider

(

const QString &

provider

)

Sets the authentication provider associated with this entity.

Parameters

provider

The authentication provider associated with this entity.

setAuthenticationProviderVersion()

void setAuthenticationProviderVersion

(

const QString &

version

)

Sets the authentication provider version associated with this entity.

Parameters

version

The version of the associated authentication provider.