2 * Copyright 2001-2009 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/base.h>
30 class SAML_API SOAPClient;
33 class SAML_API MetadataCredentialCriteria;
38 class SAML_API Request;
39 class SAML_API Response;
40 class SAML_API Status;
43 * Client class for SAML 1.x SOAP binding.
45 class SAML_API SAML1SOAPClient
51 * @param soaper reference to SOAPClient object to use for call
52 * @param fatalSAMLErrors true iff a non-successful SAML Status code should be fatal
54 SAML1SOAPClient(SOAPClient& soaper, bool fatalSAMLErrors=true) : m_soaper(soaper), m_fatal(fatalSAMLErrors), m_correlate(NULL) {
57 virtual ~SAML1SOAPClient() {
58 xercesc::XMLString::release(&m_correlate);
62 * Specialized method for sending SAML 1.x requests. The SOAP layer will be
63 * constructed automatically.
65 * <p>The request will be freed by the client object regardless of the outcome.
67 * @param request SAML request to send
68 * @param from identity of sending application
69 * @param to peer to send message to, expressed in metadata criteria terms
70 * @param endpoint URL of endpoint to recieve message
72 virtual void sendSAML(Request* request, const char* from, saml2md::MetadataCredentialCriteria& to, const char* endpoint);
75 * Specialized method for receiving SAML 1.x responses. The SOAP layer will be
76 * evaluated automatically, and the attached policy will be applied to the Response.
78 * <p>The caller is responsible for freeing the Response.
80 * @return SAML 1.x Response, after SecurityPolicy has been applied
82 virtual Response* receiveSAML();
86 * Handling of SAML errors.
88 * @param status SAML Status received by client
89 * @return true iff the error should be treated as a fatal error
91 virtual bool handleError(const Status& status);
93 /** SOAP client object. */
96 /** Flag controlling default error handler. */
106 #endif /* __saml1_soap11client_h__ */