ACE/protocols/ace/INet/HTTP_Request.h

   1 /**
   2  * @file HTTP_Request.h
   3  *
   4  * @author Martin Corino <mcorino@remedy.nl>
   5  */
   6
   7 #ifndef ACE_HTTP_REQUEST_H
   8 #define ACE_HTTP_REQUEST_H
   9
  10 #include /**/ "ace/pre.h"
  11
  12 #include /**/ "ace/config-all.h"
  13
  14 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  15 # pragma once
  16 #endif /* ACE_LACKS_PRAGMA_ONCE */
  17
  18 #include "ace/Containers_T.h"
  19 #include "ace/INet/INet_Export.h"
  20 #include "ace/INet/Request.h"
  21 #include "ace/INet/HTTP_Header.h"
  22
  23 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  24
  25 namespace ACE
  26   {
  27     namespace HTTP
  28       {
  29         class ACE_INET_Export Request
  30           : public ACE::INet::Request, public Header
  31           {
  32             public:
  33               /// Constructor; creates a GET / HTTP/1.0 HTTP request.
  34               Request();
  35
  36               /// Constructor; creates a GET request with given version.
  37               Request(const ACE_CString& version);
  38
  39               /// Constructor; creates a HTTP/1.0 request with given method and URI.
  40               Request(const ACE_CString& method, const ACE_CString& uri);
  41
  42               /// Constructor; creates an HTTP request with given method, URI and version.
  43               Request(const ACE_CString& method, const ACE_CString& uri, const ACE_CString& version);
  44
  45               /// Destructor
  46               virtual ~Request();
  47
  48               /// Reset the request object
  49               void reset ();
  50
  51               void reset (const ACE_CString& version);
  52
  53               void reset (const ACE_CString& method, const ACE_CString& uri);
  54
  55               void reset (const ACE_CString& method, const ACE_CString& uri, const ACE_CString& version);
  56
  57               /// Set the method.
  58               void set_method(const ACE_CString& method);
  59
  60               /// Return the method.
  61               const ACE_CString& get_method() const;
  62
  63               /// Set the request URI.
  64               void set_URI(const ACE_CString& uri);
  65
  66               /// Return the request URI.
  67               const ACE_CString& get_URI() const;
  68
  69               /// Set the Host header field.
  70               void set_host(const ACE_CString& host);
  71
  72               void set_host(const ACE_CString& host, u_short port);
  73
  74               /// Returns true if Host header field has been set.
  75               bool has_host () const;
  76
  77               /// Returns the value of the Host header field.
  78               ACE_CString get_host() const;
  79
  80               /// Adds a Cookie header.
  81               void add_cookie(const ACE_CString & cookie);
  82
  83               /// Get cookies from Cookie header(s).
  84               void get_cookies(ACE_Array<ACE_CString> & cookies) const;
  85
  86               /// Returns true if the request contains authentication
  87               /// information in the form of an Authorization header.
  88               bool has_credentials() const;
  89
  90               /// Returns the authentication scheme and authentication information
  91               void get_credentials(ACE_CString& scheme, ACE_CString& auth_info) const;
  92
  93               /// Set the authentication scheme and information
  94               void set_credentials(const ACE_CString& scheme, const ACE_CString& auth_info);
  95
  96               /// Writes the HTTP request to the given stream
  97               void write(std::ostream& str) const;
  98
  99               /// Reads the HTTP request from the
 100               /// given stream.
 101               bool read(std::istream& str);
 102
 103               static const ACE_CString HTTP_GET;
 104               static const ACE_CString HTTP_HEAD;
 105               static const ACE_CString HTTP_PUT;
 106               static const ACE_CString HTTP_POST;
 107               static const ACE_CString HTTP_OPTIONS;
 108               static const ACE_CString HTTP_DELETE;
 109               static const ACE_CString HTTP_TRACE;
 110               static const ACE_CString HTTP_CONNECT;
 111
 112               static const ACE_CString HOST;
 113               static const ACE_CString COOKIE;
 114               static const ACE_CString AUTHORIZATION;
 115
 116             private:
 117               enum Limits
 118               {
 119                 MAX_METHOD_LENGTH  = 32,
 120                 MAX_URI_LENGTH     = 4096,
 121                 MAX_VERSION_LENGTH = 8
 122               };
 123
 124               ACE_CString method_;
 125               ACE_CString uri_;
 126           };
 127       }
 128   }
 129
 130 ACE_END_VERSIONED_NAMESPACE_DECL
 131
 132 #if defined (__ACE_INLINE__)
 133 #include "ace/INet/HTTP_Request.inl"
 134 #endif
 135
 136 #include /**/ "ace/post.h"
 137 #endif /* ACE_HTTP_REQUEST_H */