LoginResponse Class Reference

LoginResponse contains the API that allows access to the information sent in response to a successful RETS LOGIN transaction. More...

#include <librets/LoginResponse.h>

Inheritance diagram for LoginResponse:

KeyValueResponse RetsObject

List of all members.

Public Member Functions

std::string GetMemberName () const
 Get the Member's full name.
std::string GetUserInfo () const
 Get the User specific information.
std::string GetBroker () const
 Get the broker code and branch.
std::string GetMetadataVersion () const
 Get the current metadata version.
std::string GetMetadataTimestamp () const
 Get the timestamp of the metadata.
std::string GetMinMetadataTimestamp () const
 Get the minimum metadata timestamp.
std::string GetOfficeList () const
 Get the Office List information.
std::string GetBalance () const
 Get the Accounting Information.
std::string GetTimeout () const
 Get the timeout value.
std::string GetPasswordExpire () const
 Get the password expiration date.
std::string GetActionUrl () const
 Get the RETS "ACTION" URL.
std::string GetChangePasswordUrl () const
 Get the RETS "CHANGE PASSWORD" URL.
std::string GetGetObjectUrl () const
 Get the RETS "GET OBJECT" URL.
std::string GetLoginUrl () const
 Get the RETS "LOGIN" URL.
std::string GetLoginCompleteUrl () const
 Get the RETS "LOGIN COMPLETE" URL.
std::string GetLogoutUrl () const
 Get the RETS "LOGOUT" URL.
std::string GetSearchUrl () const
 Get the RETS "SEARCH" URL.
std::string GetGetMetadataUrl () const
 Get the RETS "METADATA" URL.
std::string GetServerInformationUrl () const
 Get the RETS "SERVER INFORMATION" URL.
std::string GetUpdateUrl () const
 Get the RETS "UPDATE" URL.
CapabilityUrlsAPtr CreateCapabilityUrls (std::string baseUrl) const
 (Internal) Create the CapabilityUrl object with the URLs enumerated.
void Parse (istreamPtr inputStream, RetsVersion retsVersion)
 Parse the input stream, converting the data into keys and values.
void Parse (istreamPtr inputStream, RetsVersion retsVersion, EncodingType encoding)
 Parse the input stream, converting the data into keys and values.
std::string GetValue (std::string key) const
 For a given key, return the associated value.
int GetRetsReplyCode () const
 Returns an integer representing the RETS Response Code for this object.
std::string GetRetsReplyText () const
 Returns a string representing the RETS Reply Text.
virtual std::ostream & Print (std::ostream &outputStream) const
std::string ToString () const
virtual bool Equals (const RetsObject *object) const

Protected Member Functions

RetsXmlTextEventPtr GetBodyEventFromStandardResponse (RetsXmlEventListPtr eventList)
RetsXmlTextEventPtr GetBodyEventFromResponseWithNoRetsResponse (RetsXmlEventListPtr eventList)
RetsXmlTextEventPtr GetBodyEventFromShortResponse (RetsXmlEventListPtr eventList)
virtual void ParsingFinished ()

Static Protected Member Functions

static void AssertEquals (const std::string &expected, const std::string &actual)
static void AssertEquals (int expected, int actual)
static void AssertEventListSize (int expected, RetsXmlEventListPtr eventList)
static void AssertNotEquals (const std::string &expected, const std::string &actual)


Detailed Description

LoginResponse contains the API that allows access to the information sent in response to a successful RETS LOGIN transaction.

Member Function Documentation

static void AssertEquals ( int  expected,
int  actual 
) [static, protected, inherited]

static void AssertEquals ( const std::string &  expected,
const std::string &  actual 
) [static, protected, inherited]

static void AssertEventListSize ( int  expected,
RetsXmlEventListPtr  eventList 
) [static, protected, inherited]

static void AssertNotEquals ( const std::string &  expected,
const std::string &  actual 
) [static, protected, inherited]

CapabilityUrlsAPtr CreateCapabilityUrls ( std::string  baseUrl  )  const

(Internal) Create the CapabilityUrl object with the URLs enumerated.

Parameters:
baseUrl A string containing the base URL for the RETS server.

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

std::string GetActionUrl (  )  const

Get the RETS "ACTION" URL.

Returns:
A string containing the URL or an empty string if none exists.

std::string GetBalance (  )  const

Get the Accounting Information.

Returns:
A string containing user readable balance information.

RetsXmlTextEventPtr GetBodyEventFromResponseWithNoRetsResponse ( RetsXmlEventListPtr  eventList  )  [protected, inherited]

RetsXmlTextEventPtr GetBodyEventFromShortResponse ( RetsXmlEventListPtr  eventList  )  [protected, inherited]

RetsXmlTextEventPtr GetBodyEventFromStandardResponse ( RetsXmlEventListPtr  eventList  )  [protected, inherited]

std::string GetBroker (  )  const

Get the broker code and branch.

Returns:
A string containing the broker code and branch.

std::string GetChangePasswordUrl (  )  const

Get the RETS "CHANGE PASSWORD" URL.

Returns:
A string containing the URL for the RETS ChangePassword transaction. This may be the empty string if none exists.

std::string GetGetMetadataUrl (  )  const

Get the RETS "METADATA" URL.

Returns:
A string containing the URL for the RETS GetMetadata transaction.

std::string GetGetObjectUrl (  )  const

Get the RETS "GET OBJECT" URL.

Returns:
A string containing the URL for the RETS GetObject tarnsaction. This may be the empty string if none exists.

std::string GetLoginCompleteUrl (  )  const

Get the RETS "LOGIN COMPLETE" URL.

Returns:
A string containing the URL for the RETS Login Complete operation. Note that this is currently a reserved operation.

std::string GetLoginUrl (  )  const

Get the RETS "LOGIN" URL.

Returns:
A string containing the URL for the RETS Login transaction.

std::string GetLogoutUrl (  )  const

Get the RETS "LOGOUT" URL.

Returns:
A string containing the URL for the RETS Logout transaction.

std::string GetMemberName (  )  const

Get the Member's full name.

Returns:
A string containing the Member's name.

std::string GetMetadataTimestamp (  )  const

Get the timestamp of the metadata.

Returns:
A string containing the timestamp for the metadata.

std::string GetMetadataVersion (  )  const

Get the current metadata version.

Returns:
A string containing the current metadata version.

std::string GetMinMetadataTimestamp (  )  const

Get the minimum metadata timestamp.

Returns:
A string containing the minimum metadata timestamp.

std::string GetOfficeList (  )  const

Get the Office List information.

Returns:
A string containing the Office List information.

std::string GetPasswordExpire (  )  const

Get the password expiration date.

Returns:
A string representing the RFC 1123 format date of the expiration.

int GetRetsReplyCode (  )  const [inherited]

Returns an integer representing the RETS Response Code for this object.

This is really only used internally to indicate login failures on those servers that don't return a 401 Unauthorized response but do return the RETS Response Code.

Returns:
An integer containing the RETS Response Code.

std::string GetRetsReplyText (  )  const [inherited]

Returns a string representing the RETS Reply Text.

Returns:
A string containing the RETS Reply Text.

std::string GetSearchUrl (  )  const

Get the RETS "SEARCH" URL.

Returns:
A string containing the URL for the RETS Search transaction.

std::string GetServerInformationUrl (  )  const

Get the RETS "SERVER INFORMATION" URL.

This is for RETS 1.7 and later and will return an empty string if it is not implemented.

Returns:
A string containing the URL for the RETS ServerInformation transaction. It will be an empty string if not supported.

std::string GetTimeout (  )  const

Get the timeout value.

Returns:
A string representing the timeout in seconds.

std::string GetUpdateUrl (  )  const

Get the RETS "UPDATE" URL.

Returns:
A string containing the URL for the RETS Update transaction. It will be an empty string if not supported.

std::string GetUserInfo (  )  const

Get the User specific information.

Returns:
A string containing the User specific information.

std::string GetValue ( std::string  key  )  const [inherited]

For a given key, return the associated value.

If the key is not found and empty string is returned.

Parameters:
key A string representing the key whose value is to be returned.
Returns:
A string containing the value.

void Parse ( istreamPtr  inputStream,
RetsVersion  retsVersion,
EncodingType  encoding 
) [inherited]

Parse the input stream, converting the data into keys and values.

Parameters:
inputStream A pointer to the input stream.
retsVersion The RETS version.
encoding The character encoding to use when parsing.

void Parse ( istreamPtr  inputStream,
RetsVersion  retsVersion 
) [inherited]

Parse the input stream, converting the data into keys and values.

Parameters:
inputStream A pointer to the input stream.
retsVersion The RETS version.

virtual void ParsingFinished (  )  [protected, virtual, inherited]

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

std::string ToString (  )  const [inherited]


Generated by  doxygen