shibsp/binding/SOAPClient.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 shibsp/binding/SOAPClient.h
  19  *
  20  * Specialized SOAPClient for SP environment.
  21  */
  22
  23 #ifndef __shibsp_soap11client_h__
  24 #define __shibsp_soap11client_h__
  25
  26 #include <shibsp/Application.h>
  27 #include <saml/binding/SOAPClient.h>
  28 #include <xmltooling/security/CredentialResolver.h>
  29
  30 namespace shibsp {
  31
  32     /**
  33      * Specialized SOAPClient for SP environment.
  34      */
  35     class SHIBSP_API SOAPClient : public opensaml::SOAPClient
  36     {
  37     public:
  38         /**
  39          * Creates a SOAP client instance for an Application to use.
  40          *
  41          * @param application   reference to Application
  42          * @param policy        reference to (empty) SecurityPolicy to apply
  43          */
  44         SOAPClient(const Application& application, opensaml::SecurityPolicy& policy);
  45
  46         virtual ~SOAPClient() {
  47             if (m_credResolver)
  48                 m_credResolver->unlock();
  49         }
  50
  51         /**
  52          * Override handles message signing for SAML payloads.
  53          *
  54          * @param env       SOAP envelope to send
  55          * @param peer      peer to send message to, expressed in metadata terms
  56          * @param endpoint  URL of endpoint to recieve message
  57          */
  58         void send(const soap11::Envelope& env, opensaml::saml2md::MetadataCredentialCriteria& peer, const char* endpoint);
  59
  60         void reset();
  61
  62     protected:
  63         /**
  64          * Override prepares transport by applying policy settings from Application.
  65          *
  66          * @param transport reference to transport layer
  67          */
  68         void prepareTransport(xmltooling::SOAPTransport& transport);
  69
  70         /** Application supplied to client. */
  71         const Application& m_app;
  72
  73         /** Properties associated with the Application's security policy. */
  74         const PropertySet* m_settings;
  75
  76         /** RelyingParty properties, set after transport prep. */
  77         const PropertySet* m_relyingParty;
  78
  79         /** Locked CredentialResolver for transport, set after transport prep. */
  80         xmltooling::CredentialResolver* m_credResolver;
  81     };
  82
  83 };
  84
  85 #endif /* __shibsp_soap11client_h__ */