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/saml2/binding/SAML2SOAPClient.h
20 * Specialized SOAPClient for SAML 2.0 SOAP binding.
23 #ifndef __saml2_soap11client_h__
24 #define __saml2_soap11client_h__
26 #include <saml/binding/SOAPClient.h>
31 class SAML_API RequestAbstractType;
32 class SAML_API StatusResponseType;
33 class SAML_API Status;
36 * Specialized SOAPClient for SAML 2.0 SOAP binding.
38 class SAML_API SAML2SOAPClient : opensaml::SOAPClient
42 * Creates a SOAP client instance with a particular SecurityPolicy.
44 * @param policy reference to SecurityPolicy to apply
45 * @param validating controls schema validation
47 SAML2SOAPClient(SecurityPolicy& policy, bool validating=false) : opensaml::SOAPClient(policy, validating) {}
49 virtual ~SAML2SOAPClient() {}
52 * Specialized method for sending SAML 2.0 requests. The SOAP layer will be
53 * constructed automatically.
55 * <p>The request will be freed by the client object if the method succeeds.
57 * @param request SAML request to send
58 * @param peer peer to send message to, expressed in metadata terms
59 * @param endpoint URL of endpoint to recieve message
61 virtual void sendSAML(RequestAbstractType* request, const saml2md::RoleDescriptor& peer, const char* endpoint);
64 * Specialized method for receiving SAML 2.0 responses. The SOAP layer will be
65 * evaluated automatically, and the attached policy will be applied to the Response.
67 * <p>The caller is responsible for freeing the response.
69 * @return SAML 2.0 response, after SecurityPolicy has been applied
71 virtual StatusResponseType* receiveSAML();
75 * Handling of SAML errors.
77 * @param status SAML Status received by client
78 * @return true iff the error should be treated as a fatal error
80 virtual bool handleError(const Status& status);
86 #endif /* __saml2_soap11client_h__ */