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 xmltooling/soap/SOAPTransport.h
20 * Encapsulates a transport layer protocol for sending/receiving messages.
23 #ifndef __xmltooling_soaptrans_h__
24 #define __xmltooling_soaptrans_h__
26 #include <xmltooling/base.h>
29 namespace xmltooling {
31 class XMLTOOL_API Credential;
32 class XMLTOOL_API CredentialResolver;
33 class XMLTOOL_API X509TrustEngine;
36 * Encapsulates a transport layer protocol for sending/receiving messages.
38 * Most of the methods are const, meaning they don't affect the transport
39 * layer until the data is sent.
41 class XMLTOOL_API SOAPTransport
43 MAKE_NONCOPYABLE(SOAPTransport);
47 virtual ~SOAPTransport() {}
50 * Indicates whether transport provides confidentiality.
52 * @return true iff transport layer provides confidentiality
54 virtual bool isConfidential() const=0;
57 * Sets the connection timeout.
59 * @param timeout time to wait for connection to server in seconds, or -1 for no timeout
60 * @return true iff the transport supports connection timeouts
62 virtual bool setConnectTimeout(long timeout)=0;
65 * Sets the request timeout.
67 * @param timeout time to wait for a response in seconds, or -1 for no timeout
68 * @return true iff the transport supports request/response timeouts
70 virtual bool setTimeout(long timeout)=0;
73 * Common types of transport authentication that may be supported.
75 enum transport_auth_t {
76 transport_auth_none = 0,
77 transport_auth_basic = 1,
78 transport_auth_digest = 2,
79 transport_auth_ntlm = 3,
80 transport_auth_gss = 4
84 * Sets a particular form of transport authentication and credentials.
86 * @param authType type of transport authentication to use
87 * @param username username for transport authentication
88 * @param password simple password/credential for transport authentication
89 * @return true iff the transport supports the indicated form of authentication
91 virtual bool setAuth(transport_auth_t authType, const char* username=NULL, const char* password=NULL)=0;
94 * Determines whether TLS/SSL connections include a check of the server's certificate
95 * against the expected hostname or address. Defaults to true, and has no effect for
98 * @param verify true iff the hostname should be verified against the server's certificate
99 * @return true iff the transport supports hostname verification
101 virtual bool setVerifyHost(bool verify)=0;
103 #ifndef XMLTOOLING_NO_XMLSEC
105 * Supplies transport credentials.
107 * <p>The lifetime of the credential must be longer than the lifetime of this object.
109 * @param credential a Credential instance, or NULL
110 * @return true iff the transport supports the use of the Credential
112 virtual bool setCredential(const Credential* credential=NULL)=0;
115 * Provides an X509TrustEngine to the transport to authenticate the transport peer.
116 * The lifetime of the engine must be longer than the lifetime of this object.
118 * @param trustEngine an X509TrustEngine instance, or NULL
119 * @param credResolver a CredentialResolver to supply the peer's trusted credentials, or NULL
120 * @param criteria optional criteria for selecting peer credentials
121 * @param mandatory flag controls whether message is sent at all if the
122 * transport isn't authenticated using the TrustEngine
123 * @return true iff the transport supports the use of a TrustEngine
125 virtual bool setTrustEngine(
126 const X509TrustEngine* trustEngine=NULL,
127 const CredentialResolver* credResolver=NULL,
128 CredentialCriteria* criteria=NULL,
134 * Sends a stream of data over the transport. The function may return without
135 * having received any data, depending on the nature of the transport.
137 * @param in input stream to send
139 virtual void send(std::istream& in)=0;
142 * Returns reference to response stream. The resulting stream must be
143 * checked directly to determine whether data is available.
145 * @return reference to a stream containing the response, if any
147 virtual std::istream& receive()=0;
150 * Returns result of authenticating transport peer.
152 * @return true iff TrustEngine or other mechanism successfully authenticated the peer
154 virtual bool isSecure() const=0;
157 * Returns the MIME type of the response, if any.
159 * @return MIME type of response, or an empty string
161 virtual std::string getContentType() const=0;
164 #ifndef XMLTOOLING_NO_XMLSEC
166 * Registers SOAPTransport classes into the runtime.
168 void XMLTOOL_API registerSOAPTransports();
171 * Notifies transport infrastructure to initialize.
173 void XMLTOOL_API initSOAPTransports();
176 * Notifies transport infrastructure to shutdown.
178 void XMLTOOL_API termSOAPTransports();
183 #endif /* __xmltooling_soaptrans_h__ */