net/base/cookie_policy.h

// Copyright (c) 2010 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef NET_BASE_COOKIE_POLICY_H_
#define NET_BASE_COOKIE_POLICY_H_
#pragma once

#include <string>

#include "net/base/completion_callback.h"

class GURL;

namespace net {

// Alternative success codes for CookiePolicy::Can{Get,Set}Cookie(s).
enum {
  OK_FOR_SESSION_ONLY = 1,  // The cookie may be set but not persisted.
};

class CookiePolicy {
 public:
  // Determines if the URL's cookies may be read.
  //
  // Returns:
  //   OK                   -  if allowed to read cookies
  //   ERR_ACCESS_DENIED    -  if not allowed to read cookies
  //   ERR_IO_PENDING       -  if the result will be determined asynchronously
  //
  // If the return value is ERR_IO_PENDING, then the given callback will be
  // notified once the final result is determined.  Note: The callback must
  // remain valid until notified.
  virtual int CanGetCookies(const GURL& url,
                            const GURL& first_party_for_cookies,
                            CompletionCallback* callback) = 0;

  // Determines if the URL's cookies may be written.  Returns OK if allowed to
  // write a cookie for the given URL.  Returns ERR_IO_PENDING to indicate that
  // the completion callback will be notified (asynchronously and on the
  // current thread) of the final result.  Note: The completion callback must
  // remain valid until notified.

  // Determines if the URL's cookies may be written.
  //
  // Returns:
  //   OK                   -  if allowed to write cookies
  //   OK_FOR_SESSION_ONLY  -  if allowed to write cookies, but forces them to
  //                           be stored as session cookies
  //   ERR_ACCESS_DENIED    -  if not allowed to write cookies
  //   ERR_IO_PENDING       -  if the result will be determined asynchronously
  //
  // If the return value is ERR_IO_PENDING, then the given callback will be
  // notified once the final result is determined.  Note: The callback must
  // remain valid until notified.
  virtual int CanSetCookie(const GURL& url,
                           const GURL& first_party_for_cookies,
                           const std::string& cookie_line,
                           CompletionCallback* callback) = 0;

 protected:
  virtual ~CookiePolicy() {}
};

}  // namespace net

#endif // NET_BASE_COOKIE_POLICY_H_