Home | History | Annotate | Download | only in public 
      1 /*
      2  * Copyright (C) 2009 Google 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 are
      6  * met:
      7  *
      8  *     * Redistributions of source code must retain the above copyright
      9  * notice, this list of conditions and the following disclaimer.
     10  *     * Redistributions in binary form must reproduce the above
     11  * copyright notice, this list of conditions and the following disclaimer
     12  * in the documentation and/or other materials provided with the
     13  * distribution.
     14  *     * Neither the name of Google Inc. nor the names of its
     15  * contributors may be used to endorse or promote products derived from
     16  * this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef WebDataSource_h
     32 #define WebDataSource_h
     33 
     34 #include "WebCommon.h"
     35 #include "WebNavigationType.h"
     36 
     37 namespace WebKit {
     38 
     39 class WebApplicationCacheHost;
     40 class WebString;
     41 class WebURL;
     42 class WebURLRequest;
     43 class WebURLResponse;
     44 template <typename T> class WebVector;
     45 
     46 class WebDataSource {
     47 public:
     48     class ExtraData {
     49     public:
     50         virtual ~ExtraData() { }
     51     };
     52 
     53     // Returns the original request that resulted in this datasource.
     54     virtual const WebURLRequest& originalRequest() const = 0;
     55 
     56     // Returns the request corresponding to this datasource.  It may
     57     // include additional request headers added by WebKit that were not
     58     // present in the original request.  This request may also correspond
     59     // to a location specified by a redirect that was followed.
     60     virtual const WebURLRequest& request() const = 0;
     61 
     62     // Returns the response associated with this datasource.
     63     virtual const WebURLResponse& response() const = 0;
     64 
     65     // When this datasource was created as a result of WebFrame::loadData,
     66     // there may be an associated unreachableURL.
     67     virtual bool hasUnreachableURL() const = 0;
     68     virtual WebURL unreachableURL() const = 0;
     69 
     70     // Returns all redirects that occurred (both client and server) before
     71     // at last committing the current page.  This will contain one entry
     72     // for each intermediate URL, and one entry for the last URL (so if
     73     // there are no redirects, it will contain exactly the current URL, and
     74     // if there is one redirect, it will contain the source and destination
     75     // URL).
     76     virtual void redirectChain(WebVector<WebURL>&) const = 0;
     77 
     78     // Returns the title for the current page.
     79     virtual WebString pageTitle() const = 0;
     80 
     81     // The type of navigation that triggered the creation of this datasource.
     82     virtual WebNavigationType navigationType() const = 0;
     83 
     84     // The time in seconds (since the epoch) of the event that triggered
     85     // the creation of this datasource.  Returns 0 if unknown.
     86     virtual double triggeringEventTime() const = 0;
     87 
     88     // Extra data associated with this datasource.  If non-null, the extra
     89     // data pointer will be deleted when the datasource is destroyed.
     90     // Setting the extra data pointer will cause any existing non-null
     91     // extra data pointer to be deleted.
     92     virtual ExtraData* extraData() const = 0;
     93     virtual void setExtraData(ExtraData*) = 0;
     94 
     95     // The application cache host associated with this datasource.
     96     virtual WebApplicationCacheHost* applicationCacheHost() = 0;
     97 
     98     // Set deferMainResourceDataLoad flag on the loader.  This is used for
     99     // testing.
    100     virtual void setDeferMainResourceDataLoad(bool) = 0;
    101 
    102 protected:
    103     ~WebDataSource() { }
    104 };
    105 
    106 } // namespace WebKit
    107 
    108 #endif
    109