286415e0877ab07842ccd92aa2084a0840e576a9
[WebKit-https.git] / Source / WebCore / platform / network / AuthenticationChallengeBase.h
1 /*
2  * Copyright (C) 2007 Apple Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25 #ifndef AuthenticationChallengeBase_h
26 #define AuthenticationChallengeBase_h
27
28 #include "Credential.h"
29 #include "ProtectionSpace.h"
30 #include "ResourceResponse.h"
31 #include "ResourceError.h"
32
33 namespace WebCore {
34
35 class AuthenticationChallenge;
36
37 class AuthenticationChallengeBase {
38 public:
39     AuthenticationChallengeBase();
40     AuthenticationChallengeBase(const ProtectionSpace& protectionSpace, const Credential& proposedCredential, unsigned previousFailureCount, const ResourceResponse& response, const ResourceError& error);
41
42     unsigned previousFailureCount() const;
43     const Credential& proposedCredential() const;
44     const ProtectionSpace& protectionSpace() const;
45     const ResourceResponse& failureResponse() const;
46     const ResourceError& error() const;
47     
48     bool isNull() const;
49     void nullify();
50     
51     uint64_t identifier() const { return m_identifier; }
52
53     static bool compare(const AuthenticationChallenge& a, const AuthenticationChallenge& b);
54
55 protected:
56     // The AuthenticationChallenge subclass may "shadow" this method to compare platform specific fields
57     static bool platformCompare(const AuthenticationChallengeBase&, const AuthenticationChallengeBase&) { return true; }
58
59     bool m_isNull;
60     ProtectionSpace m_protectionSpace;
61     Credential m_proposedCredential;
62     unsigned m_previousFailureCount;
63     ResourceResponse m_failureResponse;
64     ResourceError m_error;
65     uint64_t m_identifier;
66 };
67
68 inline bool operator==(const AuthenticationChallenge& a, const AuthenticationChallenge& b) { return AuthenticationChallengeBase::compare(a, b); }
69 inline bool operator!=(const AuthenticationChallenge& a, const AuthenticationChallenge& b) { return !(a == b); }
70
71 }
72
73 #endif