saml/saml2/binding/SAML2SOAPClient.h

   1 /*
   2  *  Copyright 2001-2007 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/SAML2SOAPClient.h
  19  *
  20  * Specialized SOAPClient for SAML 2.0 SOAP binding.
  21  */
  22
  23 #ifndef __saml2_soap11client_h__
  24 #define __saml2_soap11client_h__
  25
  26 #include <saml/binding/SOAPClient.h>
  27
  28 namespace opensaml {
  29     namespace saml2p {
  30
  31         class SAML_API RequestAbstractType;
  32         class SAML_API StatusResponseType;
  33         class SAML_API Status;
  34
  35         /**
  36          * Specialized SOAPClient for SAML 2.0 SOAP binding.
  37          */
  38         class SAML_API SAML2SOAPClient : opensaml::SOAPClient
  39         {
  40         public:
  41             /**
  42              * Creates a SOAP client instance with a particular SecurityPolicy.
  43              *
  44              * @param policy    reference to SecurityPolicy to apply
  45              */
  46             SAML2SOAPClient(SecurityPolicy& policy) : opensaml::SOAPClient(policy), m_correlate(NULL) {}
  47
  48             virtual ~SAML2SOAPClient() {
  49                 XMLString::release(&m_correlate);
  50             }
  51
  52             /**
  53              * Specialized method for sending SAML 2.0 requests. The SOAP layer will be
  54              * constructed automatically.
  55              *
  56              * <p>The request will be freed by the client object if the method succeeds.
  57              *
  58              * @param request   SAML request to send
  59              * @param peer      peer to send message to, expressed in metadata terms
  60              * @param endpoint  URL of endpoint to recieve message
  61              */
  62             virtual void sendSAML(RequestAbstractType* request, const saml2md::RoleDescriptor& peer, const char* endpoint);
  63
  64             /**
  65              * Specialized method for receiving SAML 2.0 responses. The SOAP layer will be
  66              * evaluated automatically, and the attached policy will be applied to the Response.
  67              *
  68              * <p>The caller is responsible for freeing the response.
  69              *
  70              * @return SAML 2.0 response, after SecurityPolicy has been applied
  71              */
  72             virtual StatusResponseType* receiveSAML();
  73
  74         protected:
  75             /**
  76              * Handling of SAML errors.
  77              *
  78              * @param status SAML Status received by client
  79              * @return true iff the error should be treated as a fatal error
  80              */
  81             virtual bool handleError(const Status& status);
  82
  83         private:
  84             XMLCh* m_correlate;
  85         };
  86
  87     };
  88 };
  89
  90 #endif /* __saml2_soap11client_h__ */