/usr/include/xmltooling/soap/SOAPClient.h is in libxmltooling-dev 1.6.4-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 108 109 110 111 112 113 114 115 116 117 118 119 120 | /**
* 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 xmltooling/soap/SOAPClient.h
*
* Implements SOAP 1.1 messaging over a transport.
*/
#ifndef __xmltooling_soap11client_h__
#define __xmltooling_soap11client_h__
#include <xmltooling/soap/SOAPTransport.h>
namespace soap11 {
class XMLTOOL_API Envelope;
class XMLTOOL_API Fault;
/**
* Implements SOAP 1.1 messaging over a transport.
*
* In the abstract, this can be a one-way exchange, or use asynchronous
* transports, but this is mostly theoretical at this point.
*/
class XMLTOOL_API SOAPClient
{
MAKE_NONCOPYABLE(SOAPClient);
public:
/**
* Constructor
*
* @param validate true iff schema validation should be used
*/
SOAPClient(bool validate=false);
virtual ~SOAPClient();
/**
* Controls schema validation of incoming XML messages.
* This is separate from other forms of programmatic validation of objects,
* but can detect a much wider range of syntax errors.
*
* @param validate true iff the client should use a validating XML parser
*/
void setValidating(bool validate=true);
/**
* Sends the supplied envelope to the identified recipient/endpoint.
*
* <p>The client object will instantiate a transport layer object
* appropriate for the endpoint URL provided and supply it to the
* prepareTransport() method below.
*
* <p>To authenticate the server end, the transport layer object
* exposes a method to load a TrustEngine and CredentialResolver
* in a subclass-specific version of the prepareTransport() method.
*
* @param env SOAP envelope to send
* @param addr addressing information
*/
virtual void send(const Envelope& env, const xmltooling::SOAPTransport::Address& addr);
/**
* Returns the response message, if any. As long as a response is
* "expected" but not available, nullptr will be returned. If no response
* will be forthcoming, an exception is raised.
*
* <p>The caller is responsible for freeing the returned envelope.
*/
virtual Envelope* receive();
/**
* Resets the object for another call.
*/
virtual void reset();
protected:
/**
* Allows client to supply transport-layer settings prior to sending message.
*
* @param transport reference to transport layer
*/
virtual void prepareTransport(xmltooling::SOAPTransport& transport);
/**
* Handling of SOAP faults.
*
* @param fault SOAP Fault received by client
* @return true iff the Fault should be treated as a fatal error
*/
virtual bool handleFault(const soap11::Fault& fault);
/** Flag controlling schema validation. */
bool m_validate;
/** Holds response until retrieved by caller. */
xmltooling::SOAPTransport* m_transport;
};
};
#endif /* __xmltooling_soap11client_h__ */
|