Blame D4Connect.h

Packit a4aae4
Packit a4aae4
// -*- mode: c++; c-basic-offset:4 -*-
Packit a4aae4
Packit a4aae4
// This file is part of libdap, A C++ implementation of the OPeNDAP Data
Packit a4aae4
// Access Protocol.
Packit a4aae4
Packit a4aae4
// Copyright (c) 2013 OPeNDAP, Inc.
Packit a4aae4
// Author: James Gallagher <jgallagher@opendap.org>
Packit a4aae4
//
Packit a4aae4
// This library is free software; you can redistribute it and/or
Packit a4aae4
// modify it under the terms of the GNU Lesser General Public
Packit a4aae4
// License as published by the Free Software Foundation; either
Packit a4aae4
// version 2.1 of the License, or (at your option) any later version.
Packit a4aae4
//
Packit a4aae4
// This library is distributed in the hope that it will be useful,
Packit a4aae4
// but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit a4aae4
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit a4aae4
// Lesser General Public License for more details.
Packit a4aae4
//
Packit a4aae4
// You should have received a copy of the GNU Lesser General Public
Packit a4aae4
// License along with this library; if not, write to the Free Software
Packit a4aae4
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
Packit a4aae4
//
Packit a4aae4
// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
Packit a4aae4
Packit a4aae4
#ifndef _d4connect_h
Packit a4aae4
#define _d4connect_h
Packit a4aae4
Packit a4aae4
#include <string>
Packit a4aae4
Packit a4aae4
#define DAP4_CE_QUERY_KEY "dap4.ce"
Packit a4aae4
Packit a4aae4
namespace libdap
Packit a4aae4
{
Packit a4aae4
Packit a4aae4
class HTTPConnect;
Packit a4aae4
class DMR;
Packit a4aae4
class Response;
Packit a4aae4
Packit a4aae4
class D4Connect
Packit a4aae4
{
Packit a4aae4
private:
Packit a4aae4
    HTTPConnect *d_http;
Packit a4aae4
Packit a4aae4
    bool d_local;  // Is this a local connection?
Packit a4aae4
    std::string d_URL;  // URL to remote dataset (minus CE)
Packit a4aae4
    std::string d_UrlQueryString; 	// CE
Packit a4aae4
Packit a4aae4
    std::string d_server; // Server implementation information (the XDAP-Server header)
Packit a4aae4
    std::string d_protocol; // DAP protocol from the server (XDAP)
Packit a4aae4
Packit a4aae4
    void process_data(DMR &data, Response &rs);
Packit a4aae4
    void process_dmr(DMR &data, Response &rs);
Packit a4aae4
Packit a4aae4
    // Use when you cannot use but have a complete response with MIME headers
Packit a4aae4
    void parse_mime(Response &rs);
Packit a4aae4
Packit a4aae4
    std::string build_dap4_ce(const std::string requestSuffix, const std::string expr);
Packit a4aae4
Packit a4aae4
protected:
Packit a4aae4
    /** @name Suppress the C++ defaults for these. */
Packit a4aae4
    D4Connect();
Packit a4aae4
    D4Connect(const D4Connect &);
Packit a4aae4
    D4Connect &operator=(const D4Connect &);
Packit a4aae4
Packit a4aae4
public:
Packit a4aae4
    D4Connect(const std::string &url, std::string uname = "", std::string password = "");
Packit a4aae4
Packit a4aae4
    virtual ~D4Connect();
Packit a4aae4
Packit a4aae4
    bool is_local() const { return d_local; }
Packit a4aae4
Packit a4aae4
    virtual std::string URL() const { return d_URL; }
Packit a4aae4
    virtual std::string CE() const { return d_UrlQueryString; }
Packit a4aae4
Packit a4aae4
    void set_credentials(std::string u, std::string p);
Packit a4aae4
    void set_accept_deflate(bool deflate);
Packit a4aae4
    void set_xdap_protocol(int major, int minor);
Packit a4aae4
Packit a4aae4
    void set_cache_enabled(bool enabled);
Packit a4aae4
    bool is_cache_enabled();
Packit a4aae4
Packit a4aae4
    void set_xdap_accept(int major, int minor);
Packit a4aae4
Packit a4aae4
    /** Return the protocol/implementation version of the most recent
Packit a4aae4
    response. This is a poorly designed method, but it returns
Packit a4aae4
    information that is useful when used correctly. Before a response is
Packit a4aae4
    made, this contains the std::string "unknown." This should ultimately hold
Packit a4aae4
    the \e protocol version; it currently holds the \e implementation
Packit a4aae4
    version.
Packit a4aae4
Packit a4aae4
        @see get_protocol()
Packit a4aae4
        @deprecated */
Packit a4aae4
    std::string get_version() { return d_server; }
Packit a4aae4
Packit a4aae4
    /** Return the DAP protocol version of the most recent
Packit a4aae4
        response. Before a response is made, this contains the std::string "2.0."
Packit a4aae4
        */
Packit a4aae4
    std::string get_protocol() { return d_protocol; }
Packit a4aae4
Packit a4aae4
    virtual void request_dmr(DMR &dmr, const std::string expr = "");
Packit a4aae4
    virtual void request_dap4_data(DMR &dmr, const std::string expr = "");
Packit a4aae4
#if 0
Packit a4aae4
    virtual void request_version();
Packit a4aae4
#endif
Packit a4aae4
Packit a4aae4
    virtual void read_dmr(DMR &dmr, Response &rs);
Packit a4aae4
    virtual void read_dmr_no_mime(DMR &dmr, Response &rs);
Packit a4aae4
Packit a4aae4
    virtual void read_data(DMR &data, Response &rs);
Packit a4aae4
    virtual void read_data_no_mime(DMR &data, Response &rs);
Packit a4aae4
};
Packit a4aae4
Packit a4aae4
} // namespace libdap
Packit a4aae4
Packit a4aae4
#endif // _d4connect_h