saml/saml2/binding/SAML2Redirect.h

   1 /*
   2  *  Copyright 2001-2006 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 saml/saml2/binding/SAML2Redirect.h
  19  *
  20  * SAML 2.0 HTTP Redirect compression functionality
  21  */
  22
  23 #include <saml/base.h>
  24 #include <iostream>
  25
  26 namespace opensaml {
  27     namespace saml2p {
  28         /**
  29          * Deflates data in accordance with RFC1951. The caller must free the
  30          * resulting buffer using delete[]
  31          *
  32          * @param in        the data to compress
  33          * @param in_len    length of input data
  34          * @param out_len   will contain the length of the resulting data
  35          * @return  allocated buffer of out_len bytes containing deflated data
  36          */
  37         char* deflate(char* in, unsigned int in_len, unsigned int* out_len);
  38
  39         /**
  40          * Inflates data compressed in accordance with RFC1951 and sends the
  41          * results to an output stream.
  42          *
  43          * @param in        the data to inflate
  44          * @param in_len    length of input data
  45          * @param out       reference to output stream to receive data
  46          * @return  number of bytes written to stream
  47          */
  48         unsigned int inflate(char* in, unsigned int in_len, std::ostream& out);
  49     };
  50 };