libdap++ Updated for version 3.8.2

libdap::HTTPConnect Class Reference

#include <HTTPConnect.h>

Collaboration diagram for libdap::HTTPConnect:

List of all members.

Public Member Functions

HTTPResponsefetch_url (const string &url)
 HTTPConnect (RCReader *rcr)
bool is_cache_enabled ()
void set_accept_deflate (bool defalte)
void set_cache_enabled (bool enabled)
void set_cookie_jar (const string &cookie_jar)
void set_credentials (const string &u, const string &p)
void set_xdap_protocol (int major, int minor)
virtual ~HTTPConnect ()

Protected Member Functions

Suppress default methods

These methods are not supported and are implemented here as protected methods to suppress the C++-supplied default versions (which will break this object).

 HTTPConnect ()
 HTTPConnect (const HTTPConnect &)
HTTPConnectoperator= (const HTTPConnect &)

Friends

class HTTPConnectTest
class ParseHeader
size_t save_raw_http_header (void *ptr, size_t size, size_t nmemb, void *http_connect)

Detailed Description

Use the CURL library to dereference a HTTP URL. Scan the response for headers used by the DAP 2.0 and extract their values. The body of the response is made available by a FILE pointer.

Todo:
Change the way this class returns information so that the headers and the stream (aka FILE pointer) are returned using an object. Design this object so that its destructor closes the stream (this will prevent resource leaks). It will also obviate the need for the (now broken) is_response_present() predicate.
Author:
jhrg

Definition at line 77 of file HTTPConnect.h.


Constructor & Destructor Documentation

libdap::HTTPConnect::HTTPConnect ( ) [inline, protected]

Definition at line 122 of file HTTPConnect.h.

libdap::HTTPConnect::HTTPConnect ( const HTTPConnect ) [inline, protected]

Definition at line 125 of file HTTPConnect.h.

libdap::HTTPConnect::~HTTPConnect ( ) [virtual]

Definition at line 545 of file HTTPConnect.cc.

References DBG2.


Member Function Documentation

HTTPResponse * libdap::HTTPConnect::fetch_url ( const string &  url)

Dereference a URL. This method dereferences a URL and stores the result (i.e., it formulates an HTTP request and processes the HTTP server's response). After this method is successfully called, the value of is_response_present() will be true and the methods get_response_headers(), type() and server_version() may be called.

Parameters:
urlThe URL to dereference.
Returns:
A pointer to the stream.
Exceptions:
ErrorThrown if the URL could not be dereferenced.
InternalErrThrown if a temporary file to hold the response could not be opened.

Definition at line 567 of file HTTPConnect.cc.

References libdap::HTTPResponse::get_headers(), libdap::Response::get_status(), libdap::HTTPCache::is_cache_enabled(), ParseHeader, libdap::Response::set_protocol(), libdap::Response::set_type(), and libdap::Response::set_version().

Referenced by main(), libdap::Connect::request_das(), libdap::Connect::request_das_url(), libdap::Connect::request_data(), libdap::Connect::request_data_ddx(), libdap::Connect::request_data_ddx_url(), libdap::Connect::request_data_url(), libdap::Connect::request_dds(), libdap::Connect::request_dds_url(), libdap::Connect::request_ddx(), libdap::Connect::request_ddx_url(), libdap::Connect::request_protocol(), and libdap::Connect::request_version().

Here is the call graph for this function:

bool libdap::HTTPConnect::is_cache_enabled ( ) [inline]

Return the current state of the HTTP cache.

Definition at line 165 of file HTTPConnect.h.

References libdap::HTTPCache::is_cache_enabled().

Referenced by libdap::Connect::is_cache_enabled().

Here is the call graph for this function:

HTTPConnect& libdap::HTTPConnect::operator= ( const HTTPConnect ) [inline, protected]

Definition at line 128 of file HTTPConnect.h.

void libdap::HTTPConnect::set_accept_deflate ( bool  deflate)

Set the accept deflate property. If true, the DAP client announces to a server that it can accept responses compressed using the deflate algorithm. This property is automatically set using a value from the .dodsrc configuration file. This method provides a way to override that behavior.

Note:
If the configuration file is not present or does not include a value for this property, it is set to false.
Parameters:
deflateTrue sets the accept deflate property, False clears it.

Definition at line 895 of file HTTPConnect.cc.

References DBG, and libdap::deflate.

Referenced by main(), and libdap::Connect::set_accept_deflate().

void libdap::HTTPConnect::set_cache_enabled ( bool  enabled) [inline]

Set the state of the HTTP cache. By default, the HTTP cache is enabled or disabled using the value of the USE_CACHE property in the .dodsrc file. Use this method to set the state from within a program.

Parameters:
enabledTrue to use the cache, False to disable.

Definition at line 158 of file HTTPConnect.h.

References libdap::HTTPCache::set_cache_enabled().

Referenced by libdap::Connect::set_cache_enabled().

Here is the call graph for this function:

void libdap::HTTPConnect::set_cookie_jar ( const string &  cookie_jar) [inline]

Set the cookie jar. This function sets the name of a file used to store cookies returned by servers. This will help with things like single sign on systems.

Parameters:
cookie_jarThe pathname to the file that stores cookies. If this is the empty string saving cookies is disabled.

Definition at line 148 of file HTTPConnect.h.

void libdap::HTTPConnect::set_credentials ( const string &  u,
const string &  p 
)

Set the credentials for responding to challenges while dereferencing URLs. Alternatively, these can be embedded in the URL. This method provides a way for clients of HTTPConnect to get credentials from users (say using a pop up dialog) and to not hack the URL to pass that information to libcurl. Note that the 'credentials in the URL' scheme is part of the URL standard.

This method does nothing if u, the username, is empty.

Parameters:
uThe username.
pThe password.
Exceptions:
InternalErrThe credentials could not be registered with libcurl.
See also:
extract_auth_info()

Definition at line 969 of file HTTPConnect.cc.

Referenced by libdap::Connect::set_credentials().

void libdap::HTTPConnect::set_xdap_protocol ( int  major,
int  minor 
)

Set the xdap_accept property/HTTP-header. This sets the value of the DAP which the client advertises to servers that it understands. The information (client protocol major and minor versions) are recorded in the instance and the information is sent to servers using the XDAP-Accept HTTP request header.

Parameters:
majorThe dap client major protocol version
minorThe dap client minor protocol version

Definition at line 932 of file HTTPConnect.cc.

References DBG.

Referenced by libdap::Connect::set_xdap_protocol().


Friends And Related Function Documentation

friend class HTTPConnectTest [friend]

Definition at line 113 of file HTTPConnect.h.

friend class ParseHeader [friend]

Definition at line 114 of file HTTPConnect.h.

Referenced by fetch_url().

size_t save_raw_http_header ( void *  ptr,
size_t  size,
size_t  nmemb,
void *  http_connect 
) [friend]

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