cel_credprovider.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
//
// (C) 2003-2006 Celartem Technology Inc. All rights reserved.
//----------------------------------------------------------------------------

#ifndef _cel_credprovider_h_
#define _cel_credprovider_h_


#include "cel_referable.h"
#include "cel_memory.h"
#include "cel_string.h"

namespace Celartem
{
    enum AuthTargetType
    {
        authGeneral = 0, 
        authHttpBasic = 1,  
        authHttpProxy = 2, 
        authPixelSafe2Local = 3, 
        authPixelSafe2 = 4, 
        authPixelSafe3 = 5, 
    };

    class CredentialInfo : public Referable
    {
    public:
        virtual String getTarget() const = 0;

        virtual String getUserName() const = 0;

        virtual String getPassword() const = 0;

        virtual void confirm(bool inCredentialIsConfirmed) = 0;
        
        virtual bool isConfirmed() const = 0;
    };

    class CredentialProvider : public Referable
    {
    public:
        enum GetCredentialFlag
        {
            gcfNoUserInteractionIfCan = 1, //<! Instructs not to interact with user if there's a valid credential cached.
            gcfPreviousCredentialIsInvalid = 2, //<! Previous \ref CredentialInfo is invalid.
        };
    
        virtual AutoPtr<CredentialInfo> getCredential(
            AuthTargetType inAuthTargetType,
            const String& inAuthTarget,
            u32 inFlags = 0) = 0;

        static AutoPtr<CredentialProvider> createFromStrings(
            const String& inUserName,
            const String& inPassword,
            const String& inTarget = NullString);

        static AutoPtr<CredentialProvider> create(
            void *inParentHandle,
            const String& inCaption,
            const String& inMessage = NullString,
            unsigned long inFlags = 0);
    };

}


#endif // _cel_credprovider_h_

---

This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:21:54 2008.