xmltooling/soap/HTTPSOAPTransport.h

   1 /*
   2  *  Copyright 2001-2010 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file xmltooling/soap/HTTPSOAPTransport.h
  19  *
  20  * Encapsulates HTTP SOAP transport layer.
  21  */
  22
  23 #ifndef __xmltooling_httpsoaptrans_h__
  24 #define __xmltooling_httpsoaptrans_h__
  25
  26 #include <xmltooling/soap/SOAPTransport.h>
  27 #include <string>
  28 #include <vector>
  29
  30 namespace xmltooling {
  31
  32     /**
  33      * Encapsulates HTTP SOAP transport layer.
  34      */
  35     class XMLTOOL_API HTTPSOAPTransport : public virtual SOAPTransport
  36     {
  37     protected:
  38         HTTPSOAPTransport();
  39     public:
  40         virtual ~HTTPSOAPTransport();
  41
  42         /**
  43          * Indicate whether content should be sent using HTTP 1.1 and
  44          * Chunked Transport-Encoding, or buffered and sent with a Content-Length.
  45          *
  46          * @param chunked true iff chunked encoding should be used
  47          * @return  true iff the property is successfully set
  48          */
  49         virtual bool useChunkedEncoding(bool chunked=true)=0;
  50
  51         /**
  52          * Sets an outgoing HTTP request header.
  53          *
  54          * @param name   name of header, without the colon separator
  55          * @param value  header value to send
  56          * @return  true iff the header is successfully set
  57          */
  58         virtual bool setRequestHeader(const char* name, const char* value)=0;
  59
  60         /**
  61          * Controls redirect behavior.
  62          *
  63          * @param follow    true iff Location-based redirects should be honored
  64          * @param maxRedirs maximum number of redirects to permit
  65          */
  66         virtual bool followRedirects(bool follow, unsigned int maxRedirs);
  67
  68         /**
  69          * Returns the values of an HTTP response header.
  70          *
  71          * @param name  name of header, without the colon separator
  72          * @return  reference to array of header values
  73          */
  74         virtual const std::vector<std::string>& getResponseHeader(const char* name) const=0;
  75     };
  76
  77 };
  78
  79 #endif /* __xmltooling_httpsoaptrans_h__ */