tenduke::oauth::OAuthStateImpl Class Reference

#include <OAuthStateImpl.h>

Detailed Description

Implementation of OAuthState.

Inheritance diagram for tenduke::oauth::OAuthStateImpl:

Public Member Functions
	OAuthStateImpl (std::string accessToken, std::string refreshToken, int64_t expiresAt, bool infinite, std::map< std::string, std::string > additionalProperties)
	Constructs new instance.
	OAuthStateImpl (std::string accessToken, std::string refreshToken, int64_t expiresAt, std::map< std::string, std::string > additionalProperties)
	Constructs new instance.
const std::string &	getAccessToken () const override
	Returns the access token.
const std::string &	getRefreshToken () const override
	Returns the refresh token.
std::int64_t	getExpiresAt () const override
	Returns timestamp (as epoch seconds) when the current access token expires.
const std::map< std::string, std::string > &	getAdditionalProperties () const override
	Returns all additional properties returned by the server.
const std::string *	getAdditionalProperty (const std::string &name) const override
	Returns additional property returned by the server.
bool	hasAdditionalProperty (const std::string &name) const override
	Checks if the state has additional property.
bool	hasAccessToken () const override
	Returns true if the state contains an access token.
bool	doesExpire () const override
	Returns true if the access token expires.
bool	isRefreshable () const override
	Returns true if the state is refreshable (i.e.
void	setAccessToken (const std::string &newAccessToken) override
	Set the access token.
void	setExpiresAt (std::int64_t newExpiresAt) override
	Set the "expires at".
void	setRefreshToken (const std::string &newRefreshToken) override
	Set the refresh token.
void	refreshFrom (const OAuthState &state) override
	Refreshes the state from another state, This is called after refreshing the state with the service.
void	removeAdditionalProperty (const std::string &propertyName) override
	Removes given additional property.

Constructor & Destructor Documentation

OAuthStateImpl() [1/2]

tenduke::oauth::OAuthStateImpl::OAuthStateImpl ( std::string accessToken, std::string refreshToken, int64_t expiresAt, bool infinite, std::map< std::string, std::string > additionalProperties )

inline

Constructs new instance.

Parameters

accessToken	-
refreshToken	-
expiresAt	-
infinite	-
additionalProperties	-

OAuthStateImpl() [2/2]

tenduke::oauth::OAuthStateImpl::OAuthStateImpl ( std::string accessToken, std::string refreshToken, int64_t expiresAt, std::map< std::string, std::string > additionalProperties )

inline

Constructs new instance.

Parameters

accessToken	-
refreshToken	-
expiresAt	-
additionalProperties	-

Member Function Documentation

doesExpire()

bool tenduke::oauth::OAuthStateImpl::doesExpire ( ) const

inlineoverridevirtual

Returns true if the access token expires.

Returns false if the access token does not expire.

Returns

-

Implements tenduke::oauth::OAuthState.

getAccessToken()

const std::string & tenduke::oauth::OAuthStateImpl::getAccessToken ( ) const

inlineoverridevirtual

Returns the access token.

Implements tenduke::oauth::OAuthState.

getAdditionalProperties()

const std::map< std::string, std::string > & tenduke::oauth::OAuthStateImpl::getAdditionalProperties ( ) const

inlineoverridevirtual

Returns all additional properties returned by the server.

Returns

-

Implements tenduke::oauth::OAuthState.

getAdditionalProperty()

const std::string * tenduke::oauth::OAuthStateImpl::getAdditionalProperty ( const std::string & name ) const

inlineoverridevirtual

Returns additional property returned by the server.

Parameters

name	property name

Returns

property value or nullptr if no such property

Implements tenduke::oauth::OAuthState.

getExpiresAt()

std::int64_t tenduke::oauth::OAuthStateImpl::getExpiresAt ( ) const

inlineoverridevirtual

Returns timestamp (as epoch seconds) when the current access token expires.

Returns

expiration of current accesstime in epoch seconds. Returns tenduke::oauth::TOKEN_DOES_NOT_EXPIRE if server did not return "expires_at".

Implements tenduke::oauth::OAuthState.

getRefreshToken()

const std::string & tenduke::oauth::OAuthStateImpl::getRefreshToken ( ) const

inlineoverridevirtual

Returns the refresh token.

Returns

the refresh-token. Returns empty string if no refresh token.

Implements tenduke::oauth::OAuthState.

hasAccessToken()

bool tenduke::oauth::OAuthStateImpl::hasAccessToken ( ) const

inlineoverridevirtual

Returns true if the state contains an access token.

(Uninitialized states do not contain access token).

Returns

-

Implements tenduke::oauth::OAuthState.

hasAdditionalProperty()

bool tenduke::oauth::OAuthStateImpl::hasAdditionalProperty ( const std::string & name ) const

inlineoverridevirtual

Checks if the state has additional property.

Parameters

name

-

Returns

-

Implements tenduke::oauth::OAuthState.

isRefreshable()

bool tenduke::oauth::OAuthStateImpl::isRefreshable ( ) const

inlineoverridevirtual

Returns true if the state is refreshable (i.e.

it contains refresh-token).

Returns

-

Implements tenduke::oauth::OAuthState.

refreshFrom()

void tenduke::oauth::OAuthStateImpl::refreshFrom ( const OAuthState & state )

inlineoverridevirtual

Refreshes the state from another state, This is called after refreshing the state with the service.

Parameters

state

-

Implements tenduke::oauth::OAuthState.

removeAdditionalProperty()

void tenduke::oauth::OAuthStateImpl::removeAdditionalProperty ( const std::string & propertyName )

inlineoverridevirtual

Removes given additional property.

Parameters

propertyName

-

Implements tenduke::oauth::OAuthState.

setAccessToken()

void tenduke::oauth::OAuthStateImpl::setAccessToken ( const std::string & newAccessToken )

inlineoverridevirtual

Set the access token.

Parameters

newAccessToken

-

Implements tenduke::oauth::OAuthState.

setExpiresAt()

void tenduke::oauth::OAuthStateImpl::setExpiresAt ( std::int64_t newExpiresAt )

inlineoverridevirtual

Set the "expires at".

Parameters

newExpiresAt

-

Implements tenduke::oauth::OAuthState.

setRefreshToken()

void tenduke::oauth::OAuthStateImpl::setRefreshToken ( const std::string & newRefreshToken )

inlineoverridevirtual

Set the refresh token.

Parameters

newRefreshToken

-

Implements tenduke::oauth::OAuthState.

---

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

• core/oidc/core/src/oauth/OAuthStateImpl.h