UserAgentAuthCalculator Class Reference

(Internal) UserAgentAuthCalculator is an internal support class used during the calculation of User Agent Authentication value. More...

#include <librets/UserAgentAuthCalculator.h>

Inheritance diagram for UserAgentAuthCalculator:

RetsObject

List of all members.

Public Member Functions

 UserAgentAuthCalculator ()
UserAgentAuthType GetUserAgentAuthType () const
 Get the User Agent authorization type currently set.
void SetUserAgent (std::string userAgent)
 Set the User Agent name.
void SetUserAgentAuthType (UserAgentAuthType userAgentAuthType)
 Set the User Agent authorization type.
void SetUserAgentPassword (std::string userAgentPassword)
 Set the Uesr Agent Password.
void SetRequestId (std::string requestId)
 Set the Requst Id.
void SetSessionId (std::string sessionId)
 Set the Session Id.
void SetVersionInfo (std::string versionInfo)
 Set the version information.
bool HasAuthorizationValue () const
 Indicate whether or not an authorization value has been calculated.
std::string AuthorizationValue () const
 Returns the Authorization Value.
virtual std::ostream & Print (std::ostream &outputStream) const
std::string ToString () const
virtual bool Equals (const RetsObject *object) const


Detailed Description

(Internal) UserAgentAuthCalculator is an internal support class used during the calculation of User Agent Authentication value.

Constructor & Destructor Documentation

UserAgentAuthCalculator (  )  [inline]


Member Function Documentation

std::string AuthorizationValue (  )  const

Returns the Authorization Value.

Returns:
The calculated Authorization Value as a string.

virtual bool Equals ( const RetsObject object  )  const [virtual, inherited]

UserAgentAuthType GetUserAgentAuthType (  )  const

Get the User Agent authorization type currently set.

Returns:
The UserAgentAuthType

bool HasAuthorizationValue (  )  const

Indicate whether or not an authorization value has been calculated.

Returns:
A boolean that if true indicates a valid authorization value has been calculated.

virtual std::ostream& Print ( std::ostream &  outputStream  )  const [virtual, inherited]

void SetRequestId ( std::string  requestId  ) 

Set the Requst Id.

Parameters:
requestId A string containing the Request ID from the http header.

void SetSessionId ( std::string  sessionId  ) 

Set the Session Id.

Parameters:
sessionId A string containing the Session ID from the http header.

void SetUserAgent ( std::string  userAgent  ) 

Set the User Agent name.

Parameters:
userAgent A string containing the User Agent Name.

void SetUserAgentAuthType ( UserAgentAuthType  userAgentAuthType  ) 

Set the User Agent authorization type.

Parameters:
userAgentAuthType A UserAgentAuthType method.

void SetUserAgentPassword ( std::string  userAgentPassword  ) 

Set the Uesr Agent Password.

Parameters:
userAgentPassword A string containing the User Agent Password.

void SetVersionInfo ( std::string  versionInfo  ) 

Set the version information.

Parameters:
versionInfo A string containing the version information.

std::string ToString (  )  const [inherited]


Generated by  doxygen