/usr/include/ptclib/psoap.h is in libpt-dev 2.10.10~dfsg-4.1.
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 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 | /*
* psoap.h
*
* SOAP client / server classes.
*
* Portable Windows Library
*
* Copyright (c) 2003 Andreas Sikkema
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is Portable Windows Library.
*
* The Initial Developer of the Original Code is Andreas Sikkema
*
* Contributor(s): ______________________________________.
*
* $Revision: 24177 $
* $Author: rjongbloed $
* $Date: 2010-04-05 06:52:04 -0500 (Mon, 05 Apr 2010) $
*/
#ifndef PTLIB_PSOAP_H
#define PTLIB_PSOAP_H
#ifdef P_USE_PRAGMA
#pragma interface
#endif
#if P_SOAP
#include <ptclib/pxml.h>
#include <ptclib/http.h>
#define DEFAULT_SOAP_URL "/soap"
/**
SOAP Message classes
*/
//! SOAP message according to http://www.w3.org/TR/SOAP/
class PSOAPMessage : public PXML
{
PCLASSINFO(PSOAPMessage, PXML);
public:
//! Construct a SOAP message
PSOAPMessage( int options = PXMLParser::Indent + PXMLParser::NewLineAfterElement );
//! Construct a SOAP message with method name and namespace already provided
PSOAPMessage( const PString & method, const PString & nameSpace );
//! Set the method name and namespace
void SetMethod( const PString & name, const PString & nameSpace, const PString & methodPrefix = "m:" );
//! Get the method name and namespace
void GetMethod( PString & name, PString & nameSpace );
//! Add a simple parameter called name, with type type and value value
void AddParameter( PString name, PString type, PString value );
//! Add a parameter using a PXMLElement
void AddParameter( PXMLElement* parameter, PBoolean dirty = true );
//! Get parameter "name" with type "string"
PBoolean GetParameter( const PString & name, PString & value );
//! Get parameter "name" with type "int"
PBoolean GetParameter( const PString & name, int & value );
//! Get parameter "name"
PXMLElement* GetParameter( const PString & name );
//! Parse a string for a valid SOAP message
PBoolean Load(const PString & str);
//! State of the PSOAPMessage when used as a response
enum
{
//! Everything is alright
NoFault,
//! Invalid namespace for SOAP Envelope
VersionMismatch,
//! Error processing SOAP Header field "mustUnderstand"
MustUnderstand,
//! The request was incorrectly formed or did not contain the appropriate information in order to succeed
Client,
//! The request could not be processed for reasons not directly attributable to the contents of the message itself but rather to the processing of the message
Server
};
PINDEX GetFaultCode() const { return faultCode; }
PString GetFaultText() const { return faultText; }
void SetFault( PINDEX code, const PString & text );
private:
PXMLElement* pSOAPBody;
PXMLElement* pSOAPMethod;
PString faultText;
PINDEX faultCode;
};
/**
SOAP Server classes
*/
class PSOAPServerRequestResponse : public PObject
{
PCLASSINFO( PSOAPServerRequestResponse, PObject );
public:
PSOAPServerRequestResponse( PSOAPMessage & req )
: request( req ) { }
PSOAPMessage & request;
PSOAPMessage response;
};
//! Create an association between a method and its "notifier", the handler function
class PSOAPServerMethod : public PString
{
PCLASSINFO( PSOAPServerMethod, PString );
public:
PSOAPServerMethod( const PString & name )
: PString( name ) { }
PNotifier methodFunc;
};
PSORTED_LIST(PSOAPServerMethodList, PSOAPServerMethod);
//! This resource will bind the methods to an http resource (a url)
class PSOAPServerResource : public PHTTPResource
{
PCLASSINFO( PSOAPServerResource, PHTTPResource );
public:
PSOAPServerResource();
PSOAPServerResource(
const PHTTPAuthority & auth ///< Authorisation for the resource.
);
PSOAPServerResource(
const PURL & url ///< Name of the resource in URL space.
);
PSOAPServerResource(
const PURL & url, ///< Name of the resource in URL space.
const PHTTPAuthority & auth ///< Authorisation for the resource.
);
// overrides from PHTTPResource
PBoolean LoadHeaders( PHTTPRequest & request );
PBoolean OnPOSTData( PHTTPRequest & request, const PStringToString & data );
// new functions
virtual PBoolean OnSOAPRequest( const PString & body, PString & reply );
virtual PBoolean SetMethod( const PString & methodName, const PNotifier & func );
PBoolean OnSOAPRequest( const PString & methodName, PSOAPMessage & request, PString & reply );
virtual PSOAPMessage FormatFault( PINDEX code, const PString & str );
//! Use this method to have the server check for SOAPAction field in HTTP header
/*! Default is " ", which means don't care, more or less. Anything else means
the header has to be filled in with something meaningful. It has to exist
anyway. */
void SetSOAPAction( PString saction ) { soapAction = saction; }
protected:
PMutex methodMutex;
PSOAPServerMethodList methodList;
private:
PString soapAction;
};
/**
SOAP client classes
*/
class PSOAPClient : public PObject
{
PCLASSINFO( PSOAPClient, PObject );
public:
PSOAPClient( const PURL & url );
void SetTimeout( const PTimeInterval & _timeout ) { timeout = _timeout; }
PBoolean MakeRequest( const PString & method, const PString & nameSpace );
PBoolean MakeRequest( const PString & method, const PString & nameSpace, PSOAPMessage & response );
PBoolean MakeRequest( PSOAPMessage & request, PSOAPMessage & response );
PString GetFaultText() const { return faultText; }
PINDEX GetFaultCode() const { return faultCode; }
//! Set a specific SOAPAction field in the HTTTP header, default = " "
void setSOAPAction( PString saction ) { soapAction = saction; }
protected:
PBoolean PerformRequest( PSOAPMessage & request, PSOAPMessage & response );
PURL url;
PINDEX faultCode;
PString faultText;
PTimeInterval timeout;
private:
PString soapAction;
};
#endif // P_SOAP
#endif // PTLIB_PSOAP_H
// End of file ////////////////////////////////////////////////////////////////
|