reSIProcate/DialogUsageManager  9694
Public Types | Public Member Functions | Private Attributes
resip::UserAuthInfo Class Reference

#include <UserAuthInfo.hxx>

Inheritance diagram for resip::UserAuthInfo:
Inheritance graph
[legend]
Collaboration diagram for resip::UserAuthInfo:
Collaboration graph
[legend]

List of all members.

Public Types

enum  InfoMode {
  UserUnknown, RetrievedA1, Stale, DigestAccepted,
  DigestNotAccepted, Error
}

Public Member Functions

 UserAuthInfo (const resip::Data &user, const resip::Data &realm, InfoMode mode, const resip::Data &transactionId)
 UserAuthInfo (const resip::Data &user, const resip::Data &realm, const resip::Data &a1, const resip::Data &transactionId)
 UserAuthInfo (const resip::Data &user, const resip::Data &realm, const resip::Data &transactionId, resip::TransactionUser *transactionUser)
 ~UserAuthInfo ()
InfoMode getMode () const
const resip::DatagetA1 () const
const resip::DatagetRealm () const
const resip::DatagetUser () const
void setMode (InfoMode mode)
void setA1 (const resip::Data &a1)
virtual resip::Data brief () const
virtual resip::Messageclone () const
virtual EncodeStreamencode (EncodeStream &strm) const
virtual EncodeStreamencodeBrief (EncodeStream &strm) const
 output a brief description to stream

Private Attributes

InfoMode mMode
resip::Data mUser
resip::Data mRealm
resip::Data mA1

Detailed Description

Definition at line 10 of file UserAuthInfo.hxx.


Member Enumeration Documentation

Enumerator:
UserUnknown 
RetrievedA1 
Stale 
DigestAccepted 
DigestNotAccepted 
Error 

Definition at line 14 of file UserAuthInfo.hxx.

      {
        UserUnknown,       // the user/realm is not known
        RetrievedA1,       // the A1 string has been retrieved
        Stale,             // the nonce is stale, challenge again
        DigestAccepted,    // the digest was accepted, no A1 returned
        DigestNotAccepted, // the digest was wrong, challenge again/deny
        Error              // some error occurred
      };

Constructor & Destructor Documentation

UserAuthInfo::UserAuthInfo ( const resip::Data user,
const resip::Data realm,
InfoMode  mode,
const resip::Data transactionId 
)

Definition at line 13 of file UserAuthInfo.cxx.

                                                     :
   DumFeatureMessage(transactionId),
   mMode(mode),
   mUser(user),
   mRealm(realm)
{
}
UserAuthInfo::UserAuthInfo ( const resip::Data user,
const resip::Data realm,
const resip::Data a1,
const resip::Data transactionId 
)

Definition at line 24 of file UserAuthInfo.cxx.

                                                     :
   DumFeatureMessage(transactionId),
   mMode(RetrievedA1),
   mUser(user),
   mRealm(realm),
   mA1(a1)
{
}
UserAuthInfo::UserAuthInfo ( const resip::Data user,
const resip::Data realm,
const resip::Data transactionId,
resip::TransactionUser transactionUser 
)

Definition at line 36 of file UserAuthInfo.cxx.

References resip::Message::mTu.

                                                                  :
   DumFeatureMessage(transactionId),
   mMode(RetrievedA1),
   mUser(user),
   mRealm(realm)
{
   mTu = transactionUser;
}
UserAuthInfo::~UserAuthInfo ( )

Definition at line 48 of file UserAuthInfo.cxx.

{
}

Member Function Documentation

Data UserAuthInfo::brief ( ) const [virtual]

Reimplemented from resip::Message.

Definition at line 89 of file UserAuthInfo.cxx.

References mA1, mRealm, and mUser.

Referenced by encode().

{  
   Data buffer;
   DataStream strm(buffer);
   strm << "UserAuthInfo " << mUser << " @ " << mRealm << " A1=" << mA1;
   strm.flush();
   return buffer;
}
resip::Message * UserAuthInfo::clone ( ) const [virtual]

Reimplemented from resip::DumFeatureMessage.

Definition at line 99 of file UserAuthInfo.cxx.

{
   assert(false); return NULL;
}
EncodeStream & UserAuthInfo::encode ( EncodeStream strm) const [virtual]

Reimplemented from resip::DumFeatureMessage.

Definition at line 105 of file UserAuthInfo.cxx.

References brief().

Referenced by encodeBrief().

{
   strm << brief();
   return strm;
}

Here is the call graph for this function:

EncodeStream & UserAuthInfo::encodeBrief ( EncodeStream str) const [virtual]

output a brief description to stream

Reimplemented from resip::DumFeatureMessage.

Definition at line 112 of file UserAuthInfo.cxx.

References encode().

{
   return encode(strm);
}

Here is the call graph for this function:

const Data & UserAuthInfo::getA1 ( ) const

Definition at line 59 of file UserAuthInfo.cxx.

References mA1.

Referenced by resip::ServerAuthManager::handleUserAuthInfo().

{
   return mA1;
}
UserAuthInfo::InfoMode UserAuthInfo::getMode ( ) const

Definition at line 53 of file UserAuthInfo.cxx.

References mMode.

Referenced by resip::ServerAuthManager::handleUserAuthInfo().

{
   return mMode;
}
const Data & UserAuthInfo::getRealm ( ) const

Definition at line 65 of file UserAuthInfo.cxx.

References mRealm.

Referenced by resip::ServerAuthManager::handleUserAuthInfo().

{
   return mRealm;
}
const Data & UserAuthInfo::getUser ( ) const

Definition at line 71 of file UserAuthInfo.cxx.

References mUser.

Referenced by resip::ServerAuthManager::handleUserAuthInfo().

{
   return mUser;
}
void UserAuthInfo::setA1 ( const resip::Data a1)

Definition at line 83 of file UserAuthInfo.cxx.

References mA1.

{
   mA1 = a1;
}
void UserAuthInfo::setMode ( InfoMode  mode)

Definition at line 77 of file UserAuthInfo.cxx.

References mMode.

{
   mMode = mode;
}

Member Data Documentation

Definition at line 60 of file UserAuthInfo.hxx.

Referenced by brief(), getA1(), and setA1().

Definition at line 57 of file UserAuthInfo.hxx.

Referenced by getMode(), and setMode().

Definition at line 59 of file UserAuthInfo.hxx.

Referenced by brief(), and getRealm().

Definition at line 58 of file UserAuthInfo.hxx.

Referenced by brief(), and getUser().


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