2 * Copyright 2001-2007 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file saml/saml1/binding/SAML1SOAPClient.h
20 * Client class for SAML 1.x SOAP binding.
23 #ifndef __saml1_soap11client_h__
24 #define __saml1_soap11client_h__
26 #include <saml/binding/SOAPClient.h>
32 class SAML_API Request;
33 class SAML_API Response;
34 class SAML_API Status;
37 * Client class for SAML 1.x SOAP binding.
39 class SAML_API SAML1SOAPClient
45 * @param soaper reference to SOAPClient object to use for call
46 * @param fatalSAMLErrors true iff a non-successful SAML Status code should be fatal
48 SAML1SOAPClient(SOAPClient& soaper, bool fatalSAMLErrors=true) : m_soaper(soaper), m_fatal(fatalSAMLErrors), m_correlate(NULL) {
51 virtual ~SAML1SOAPClient() {
52 xercesc::XMLString::release(&m_correlate);
56 * Specialized method for sending SAML 1.x requests. The SOAP layer will be
57 * constructed automatically.
59 * <p>The request will be freed by the client object regardless of the outcome.
61 * @param request SAML request to send
62 * @param peer peer to send message to, expressed in metadata criteria terms
63 * @param endpoint URL of endpoint to recieve message
65 virtual void sendSAML(Request* request, saml2md::MetadataCredentialCriteria& peer, const char* endpoint);
68 * Specialized method for receiving SAML 1.x responses. The SOAP layer will be
69 * evaluated automatically, and the attached policy will be applied to the Response.
71 * <p>The caller is responsible for freeing the Response.
73 * @return SAML 1.x Response, after SecurityPolicy has been applied
75 virtual Response* receiveSAML();
79 * Handling of SAML errors.
81 * @param status SAML Status received by client
82 * @return true iff the error should be treated as a fatal error
84 virtual bool handleError(const Status& status);
86 /** SOAP client object. */
89 /** Flag controlling default error handler. */
99 #endif /* __saml1_soap11client_h__ */