Wt  3.3.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Types | Public Member Functions | List of all members
Wt::Auth::AuthTokenResult Class Reference

The result of processing an authentication token. More...

#include <Wt/Auth/AuthService>

Public Types

enum  Result { Invalid, Valid }
 Enumeration that describes the result. More...
 

Public Member Functions

 AuthTokenResult (Result result, const User &user=User(), const std::string &newToken=std::string())
 Constructor. More...
 
Result result () const
 Returns the result.
 
const Useruser () const
 Returns the identified user. More...
 
std::string newToken () const
 Returns a new token for this user. More...
 

Detailed Description

The result of processing an authentication token.

An authentication token is usually taken from a browser cookie, and used to identify (and possibly authenticate) a user across sessions.

See Also
AuthService::processAuthToken()
AuthService::createAuthToken()

Member Enumeration Documentation

Enumeration that describes the result.

Enumerator
Invalid 

The presented auth token could be used to identify a user.

Valid 

The presented auth token was invalid.

Constructor & Destructor Documentation

Wt::Auth::AuthTokenResult::AuthTokenResult ( Result  result,
const User user = User(),
const std::string &  newToken = std::string() 
)

Constructor.

Creates an authentication token result.

Member Function Documentation

std::string Wt::Auth::AuthTokenResult::newToken ( ) const

Returns a new token for this user.

An authentication token can be used only once, and needs to be replaced by a new token.

The returned token is valid only if the result() == Valid.

const User & Wt::Auth::AuthTokenResult::user ( ) const

Returns the identified user.

The user is valid only if the the result() == Valid.


Generated on Wed Oct 23 2013 for the C++ Web Toolkit (Wt) by doxygen 1.8.4