1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
/**
* Licensed to the University Corporation for Advanced Internet
* Development, Inc. (UCAID) under one or more contributor license
* agreements. See the NOTICE file distributed with this work for
* additional information regarding copyright ownership.
*
* UCAID licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the
* License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the License.
*/
/**
* @file saml/saml2/binding/SAML2SOAPClient.h
*
* Specialized SOAPClient for SAML 2.0 SOAP binding.
*/
#ifndef __saml2_soap11client_h__
#define __saml2_soap11client_h__
#include <saml/base.h>
namespace opensaml {
class SAML_API SOAPClient;
namespace saml2md {
class SAML_API MetadataCredentialCriteria;
};
namespace saml2p {
class SAML_API RequestAbstractType;
class SAML_API StatusResponseType;
class SAML_API Status;
/**
* Specialized SOAPClient for SAML 2.0 SOAP binding.
*/
class SAML_API SAML2SOAPClient
{
public:
/**
* Constructor
*
* @param soaper reference to SOAPClient object to use for call
* @param fatalSAMLErrors true iff a non-successful SAML Status code should be fatal
*/
SAML2SOAPClient(SOAPClient& soaper, bool fatalSAMLErrors=true);
virtual ~SAML2SOAPClient();
/**
* Specialized method for sending SAML 2.0 requests. The SOAP layer will be
* constructed automatically.
*
* <p>The request will be freed by the client object regardless of the outcome.
*
* @param request SAML request to send
* @param to peer to send message to, expressed in metadata criteria terms
* @param from identity of sending application
* @param endpoint URL of endpoint to recieve message
*/
virtual void sendSAML(RequestAbstractType* request, const char* from, saml2md::MetadataCredentialCriteria& to, const char* endpoint);
/**
* Specialized method for receiving SAML 2.0 responses. The SOAP layer will be
* evaluated automatically, and the attached policy will be applied to the Response.
*
* <p>The caller is responsible for freeing the response.
*
* @return SAML 2.0 response, after SecurityPolicy has been applied
*/
virtual StatusResponseType* receiveSAML();
protected:
/**
* Handling of SAML errors.
*
* @param status SAML Status received by client
* @return true iff the error should be treated as a fatal error
*/
virtual bool handleError(const Status& status);
/** SOAP client object */
SOAPClient& m_soaper;
/** Flag controlling default error handler. */
bool m_fatal;
private:
XMLCh* m_correlate;
};
};
};
#endif /* __saml2_soap11client_h__ */
|
