Virgil Security C++ SDK
Public Member Functions | List of all members
virgil::sdk::jwt::TokenContext Class Reference

Class used to provide additional info for AccessTokenProviderInterface implementations and explain why token is needed. More...

#include <TokenContext.h>

Public Member Functions

 TokenContext (std::string operation, std::string service, std::string identity=std::string(), bool forceReload=false)
 Constructor. More...
 
const std::string & identity () const
 Getter. More...
 
const std::string & service () const
 Getter. More...
 
const std::string & operation () const
 Getter. More...
 
bool forceReload () const
 Getter. More...
 

Detailed Description

Class used to provide additional info for AccessTokenProviderInterface implementations and explain why token is needed.

Constructor & Destructor Documentation

virgil::sdk::jwt::TokenContext::TokenContext ( std::string  operation,
std::string  service,
std::string  identity = std::string(),
bool  forceReload = false 
)

Constructor.

Parameters
operationstd::string with operation for which token is needed. CardManager uses following operations:
  • "get"
  • "search"
  • "publish"
servicestd::string with requested service
identitystd::string with identity to use in token
forceReloadif true AccessTokenProviderInterface implementation should reset cached token, if such exist

Member Function Documentation

bool virgil::sdk::jwt::TokenContext::forceReload ( ) const

Getter.

Returns
if true AccessTokenProviderInterface implementation should reset cached token, if such exist
const std::string& virgil::sdk::jwt::TokenContext::identity ( ) const

Getter.

Returns
std::string with identity to use in token
const std::string& virgil::sdk::jwt::TokenContext::operation ( ) const

Getter.

Returns
std::string with operation for which token is needed
Note
CardManager uses following operations:
  • "get"
  • "search"
  • "publish"
const std::string& virgil::sdk::jwt::TokenContext::service ( ) const

Getter.

Returns
requested service

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