1 lawrence.luo 1.2 //%LICENSE////////////////////////////////////////////////////////////////
  2                  //
  3                  // Licensed to The Open Group (TOG) under one or more contributor license
  4                  // agreements.  Refer to the OpenPegasusNOTICE.txt file distributed with
  5                  // this work for additional information regarding copyright ownership.
  6                  // Each contributor licenses this file to you under the OpenPegasus Open
  7                  // Source License; you may not use this file except in compliance with the
  8                  // License.
  9                  //
 10                  // Permission is hereby granted, free of charge, to any person obtaining a
 11                  // copy of this software and associated documentation files (the "Software"),
 12                  // to deal in the Software without restriction, including without limitation
 13                  // the rights to use, copy, modify, merge, publish, distribute, sublicense,
 14                  // and/or sell copies of the Software, and to permit persons to whom the
 15                  // Software is furnished to do so, subject to the following conditions:
 16                  //
 17                  // The above copyright notice and this permission notice shall be included
 18                  // in all copies or substantial portions of the Software.
 19                  //
 20                  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 21                  // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 22 lawrence.luo 1.2 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 23                  // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 24                  // CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 25                  // TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 26                  // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 27                  //
 28                  //////////////////////////////////////////////////////////////////////////
 29                  //
 30                  //%/////////////////////////////////////////////////////////////////////////////
 31                  
 32                  #ifndef Pegasus_WebRequest_h
 33                  #define Pegasus_WebRequest_h
 34                  
 35                  #include <Pegasus/Common/HTTPMessage.h>
 36                  
 37                  PEGASUS_NAMESPACE_BEGIN
 38                  
 39                  
 40                  /**
 41                   * Container for the request values of interest for the WebProcessor.
 42                   */
 43 lawrence.luo 1.2 class PEGASUS_WEBSERVER_LINKAGE WebRequest
 44                  {
 45                  
 46                  public:
 47                  
 48                      /**
 49                       * Constructor.
 50                       *
 51                       * @param queueId
 52                       *      Request's queueId required for generation of the response
 53                       *             for a successful delivery back to the requester.
 54                       */
 55                      WebRequest(Uint32 queueId)
 56                          :_queueId(queueId)
 57                      {
 58                      }
 59                  
 60                  
 61                      /**
 62                       * Destructor.
 63                       */
 64 lawrence.luo 1.2     ~WebRequest()
 65                      {
 66                      }
 67                  
 68                      Uint32 getQueueId() const
 69                      {
 70                          return _queueId;
 71                      }
 72                  
 73                  
 74                      /**
 75                       * URI of the request.
 76                       */
 77                      String requestURI;
 78                  
 79                      /**
 80                       * HTTP version.
 81                       */
 82                      String httpVersion;
 83                  
 84                      /**
 85 lawrence.luo 1.2      * Method of the request.
 86                       */
 87                      HttpMethod httpMethod;
 88                  
 89                      /*
 90                       * HTTP-header: Accept
 91                       */
 92                      String mimeTypes;
 93                  
 94                      /*
 95                       * HTTP-header: Accept-Charset
 96                       */
 97                      String charSets;
 98                  
 99                      /*
100                       * HTTP-header: Accept-Encoding
101                       */
102                      String encodings;
103                  
104                      /*
105                       * Type of user-authentication, currently not used.
106 lawrence.luo 1.2      */
107                      String authType;
108                  
109                      /*
110                       * Username/requester, currently not used.
111                       */
112                      String userName;
113                  
114                      /*
115                       * List of languages acceptable for a response, currently not used
116                       */
117                      AcceptLanguageList acceptLanguages;
118                  
119                      /**
120                       * IP-Address, currently not used.
121                       */
122                      String ipAddress;
123                  
124                  
125                  
126                  private:
127 lawrence.luo 1.2 
128                      /**
129                       * QueueID of request, required for a successful delivery of the response.
130                       */
131                      Uint32 _queueId;
132                  };
133                  
134                  PEGASUS_NAMESPACE_END
135                  
136                  #endif /* Pegasus_WebRequest_h */