NCBI C++ ToolKit
Public Member Functions | Protected Member Functions | Private Attributes
CSoapHttpClient Class Reference

Search Toolkit Book for CSoapHttpClient

#include <serial/soap/soap_client.hpp>

+ Inheritance diagram for CSoapHttpClient:
+ Collaboration diagram for CSoapHttpClient:

List of all members.

Public Member Functions

 CSoapHttpClient (const string &server_url, const string &namespace_name)
 ~CSoapHttpClient (void)
void SetServerUrl (const string &server_url)
 Set SOAP server URL.
const stringGetServerUrl (void) const
 Get SOAP server URL.
void SetDefaultNamespaceName (const string &namespace_name)
 Set default namespace name.
const stringGetDefaultNamespaceName (void) const
 Get default namespace name.
void SetUserHeader (const string &user_header)
 Set additional HTTP user header to use in Invoke calls.
const stringGetUserHeader (void) const
 Get additional HTTP user header.
void RegisterObjectType (TTypeInfoGetter type_getter)
 Register incoming object type.
void Invoke (CSoapMessage &response, const CSoapMessage &request, CConstRef< CSoapFault > *fault=0, const string &soap_action=kEmptyStr) const
 Invoke SOAP server procedure synchronously: send 'request' and receive 'response'.

Protected Member Functions

void SetOmitScopePrefixes (bool bOmit)
bool GetOmitScopePrefixes () const

Private Attributes

string m_ServerUrl
string m_DefNamespace
string m_UserHeader
vector< TTypeInfoGetterm_Types
bool m_OmitScopePrefixes

Detailed Description

Definition at line 42 of file soap_client.hpp.


Constructor & Destructor Documentation

CSoapHttpClient::CSoapHttpClient ( const string server_url,
const string namespace_name 
)

Definition at line 44 of file soap_client.cpp.

Definition at line 51 of file soap_client.cpp.


Member Function Documentation

Get default namespace name.

Definition at line 67 of file soap_client.cpp.

References m_DefNamespace.

Referenced by CSampleSoapClient::GetDescription(), and CSampleSoapClient::GetVersion().

bool CSoapHttpClient::GetOmitScopePrefixes ( ) const [inline, protected]

Definition at line 102 of file soap_client.hpp.

References m_OmitScopePrefixes.

Get SOAP server URL.

Definition at line 59 of file soap_client.cpp.

References m_ServerUrl.

Get additional HTTP user header.

Definition at line 76 of file soap_client.cpp.

References m_UserHeader.

void CSoapHttpClient::Invoke ( CSoapMessage response,
const CSoapMessage request,
CConstRef< CSoapFault > *  fault = 0,
const string soap_action = kEmptyStr 
) const

Invoke SOAP server procedure synchronously: send 'request' and receive 'response'.

Parameters:
responseServer response
requestClient request
faultOn failure, Fault message returned by the server.
soap_actionHTTP SOAPAction header

Definition at line 98 of file soap_client.cpp.

References eENCOD_None, eMIME_T_Text, eMIME_Xml, eSerial_Xml, eSerialSkipUnknown_Yes, eSerialVerifyData_No, auto_ptr< X >::get(), m_OmitScopePrefixes, m_ServerUrl, m_Types, m_UserHeader, MAX_CONTENT_TYPE_LEN, MIME_ComposeContentTypeEx(), CObjectOStream::Open(), CObjectIStream::Open(), CSoapMessage::RegisterObjectType(), CSoapMessage::Reset(), CObjectIStream::SetSkipUnknownMembers(), CObjectIStream::SetVerifyData(), and x_ParseHttpHeader().

Referenced by CSampleSoapClient::DoMath(), CSampleSoapClient::GetDescription(), and CSampleSoapClient::GetVersion().

Register incoming object type.

This is needed so that the SOAP message parser could recognize these objects in incoming data and parse them correctly

Parameters:
type_getterFunction that returns TTypeInfo information

Definition at line 81 of file soap_client.cpp.

References m_Types.

Referenced by CSampleSoapClient::CSampleSoapClient().

Set default namespace name.

NOTE: Client does not use this name directly, it only stores it.

Definition at line 63 of file soap_client.cpp.

References m_DefNamespace.

void CSoapHttpClient::SetOmitScopePrefixes ( bool  bOmit) [protected]

Definition at line 147 of file soap_client.cpp.

References m_OmitScopePrefixes.

void CSoapHttpClient::SetServerUrl ( const string server_url)

Set SOAP server URL.

Definition at line 55 of file soap_client.cpp.

References m_ServerUrl.

void CSoapHttpClient::SetUserHeader ( const string user_header)

Set additional HTTP user header to use in Invoke calls.

When communicating with SOAP server, the client adds this text AS IS into HTTP header.

Definition at line 72 of file soap_client.cpp.

References m_UserHeader.


Member Data Documentation

Definition at line 109 of file soap_client.hpp.

Referenced by GetDefaultNamespaceName(), and SetDefaultNamespaceName().

Definition at line 112 of file soap_client.hpp.

Referenced by GetOmitScopePrefixes(), Invoke(), and SetOmitScopePrefixes().

Definition at line 108 of file soap_client.hpp.

Referenced by GetServerUrl(), Invoke(), and SetServerUrl().

Definition at line 111 of file soap_client.hpp.

Referenced by Invoke(), and RegisterObjectType().

Definition at line 110 of file soap_client.hpp.

Referenced by GetUserHeader(), Invoke(), and SetUserHeader().


The documentation for this class was generated from the following files:
Modified on Wed Aug 20 19:58:12 2014 by modify_doxy.py rev. 426318