You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by na...@apache.org on 2006/04/19 21:41:12 UTC
svn commit: r395370 [1/4] - in /webservices/axis/trunk/c/include/axis: ./
client/
Author: nadiramra
Date: Wed Apr 19 12:41:10 2006
New Revision: 395370
URL: http://svn.apache.org/viewcvs?rev=395370&view=rev
Log:
beatify header files...
Modified:
webservices/axis/trunk/c/include/axis/Axis.h
webservices/axis/trunk/c/include/axis/AxisUserAPI.h
webservices/axis/trunk/c/include/axis/AxisUserAPI.hpp
webservices/axis/trunk/c/include/axis/GDefine.h
webservices/axis/trunk/c/include/axis/GDefine.hpp
webservices/axis/trunk/c/include/axis/Handler.hpp
webservices/axis/trunk/c/include/axis/IAttribute.hpp
webservices/axis/trunk/c/include/axis/IHandlerSoapSerializer.hpp
webservices/axis/trunk/c/include/axis/IHeaderBlock.hpp
webservices/axis/trunk/c/include/axis/IMessageData.hpp
webservices/axis/trunk/c/include/axis/INamespace.hpp
webservices/axis/trunk/c/include/axis/ISoapAttachment.hpp
webservices/axis/trunk/c/include/axis/ISoapFault.hpp
webservices/axis/trunk/c/include/axis/IWrapperSoapDeSerializer.hpp
webservices/axis/trunk/c/include/axis/IWrapperSoapSerializer.hpp
webservices/axis/trunk/c/include/axis/OtherFaultException.hpp
webservices/axis/trunk/c/include/axis/SoapEnvVersions.hpp
webservices/axis/trunk/c/include/axis/SoapFaultException.hpp
webservices/axis/trunk/c/include/axis/TypeMapping.h
webservices/axis/trunk/c/include/axis/TypeMapping.hpp
webservices/axis/trunk/c/include/axis/client/Call.hpp
webservices/axis/trunk/c/include/axis/client/Stub.hpp
Modified: webservices/axis/trunk/c/include/axis/Axis.h
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/Axis.h?rev=395370&r1=395369&r2=395370&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/Axis.h (original)
+++ webservices/axis/trunk/c/include/axis/Axis.h Wed Apr 19 12:41:10 2006
@@ -39,6 +39,10 @@
#endif
/**
+ * @file Axis.h
+ */
+
+/**
*
* Contains methods to initialize and terminate the Axis runtime. Creating a stub also initializes
* the Axis runtime and deleting the stub terminates it. So simple applications that only ever
@@ -50,49 +54,49 @@
*/
/**
- * Initializes the Axis runtime.
- * @param bIsServer should be set to false for client applications.
- * @return AXISC_SUCCESS or AXISC_FAIL to indicate success or fail
- */
+ * Initializes the Axis runtime.
+ * @param bIsServer should be set to false for client applications.
+ * @return AXISC_SUCCESS or AXISC_FAIL to indicate success or fail
+ */
AXISC_STORAGE_CLASS_INFO
int axiscAxisInitialize(AxiscBool bIsServer);
/**
- * Terminates the Axis runtime.
- * @return AXISC_SUCCESS or AXISC_FAIL to indicate success or fail
- */
+ * Terminates the Axis runtime.
+ * @return AXISC_SUCCESS or AXISC_FAIL to indicate success or fail
+ */
AXISC_STORAGE_CLASS_INFO
int axiscAxisTerminate();
/**
- * Deletes storage allocated by the Axis engine, that is no longer required
- * by the customer application.
- *
- * @param pValue
- * @param type The XSDTYPE of the storage item to be deleted.
- * @return AXISC_SUCCESS or AXISC_FAIL to indicate success or fail
- */
+ * Deletes storage allocated by the Axis engine, that is no longer required
+ * by the customer application.
+ *
+ * @param pValue Pointer to storage to be reclaimed
+ * @param type The XSDTYPE of the storage item to be deleted.
+ * @return AXISC_SUCCESS or AXISC_FAIL to indicate success or fail
+ */
AXISC_STORAGE_CLASS_INFO
int axiscAxisDelete(void * pValue, AXISC_XSDTYPE type);
/**
- * Allocates storage to be used by Axis engine. All proxy code and allocated
- * storage required by the client for basic types must use this
- * function in order that it may be freed by proxy code or the Axis engine.
- *
- * @param size - size of storage to be allocated
- * @return pointer to allocated storage
- */
+ * Allocates storage to be used by Axis engine. All proxy code and allocated
+ * storage required by the client for basic types must use this
+ * function in order that it may be freed by proxy code or the Axis engine.
+ *
+ * @param size - size of storage to be allocated
+ * @return pointer to allocated storage
+ */
AXISC_STORAGE_CLASS_INFO
void * axiscAxisNew(AXISC_XSDTYPE type, int size);
/**
- * Registers a function that will be invoked to handle Axis engine
- * exceptions. The function will be called with two parameters,
- * the error code and the error message, if any.
- *
- * @param fp - pointer to exception handler function.
- */
+ * Registers a function that will be invoked to handle Axis engine
+ * exceptions. The function will be called with two parameters,
+ * the error code and the error message, if any.
+ *
+ * @param fp - pointer to exception handler function.
+ */
typedef void (* AXIS_EXCEPTION_HANDLER_FUNCT)(int errorCode, const char *errorString);
@@ -100,12 +104,12 @@
void axiscAxisRegisterExceptionHandler(AXIS_EXCEPTION_HANDLER_FUNCT);
/**
- * Invokes the registered exception handler. If an exception handler was not
- * registered, the errorCode and errorString are printed to stderr.
- *
- * @param errorCode - error code.
- * @param errorString - error string.
- */
+ * Invokes the registered exception handler. If an exception handler was not
+ * registered, the errorCode and errorString are printed to stderr.
+ *
+ * @param errorCode - error code.
+ * @param errorString - error string.
+ */
AXISC_STORAGE_CLASS_INFO
void axiscAxisInvokeExceptionHandler(int errorCode, const char *errorString);
Modified: webservices/axis/trunk/c/include/axis/AxisUserAPI.h
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/AxisUserAPI.h?rev=395370&r1=395369&r2=395370&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/AxisUserAPI.h (original)
+++ webservices/axis/trunk/c/include/axis/AxisUserAPI.h Wed Apr 19 12:41:10 2006
@@ -179,7 +179,19 @@
* @typedef xsdc__boolean
* Axis C++ defined type for xml basic type boolean
*/
-typedef enum { false_=0, true_ } xsdc__boolean;
+typedef enum
+{
+ /**
+ * False
+ */
+ false_=0,
+
+ /**
+ * True
+ */
+ true_
+} xsdc__boolean;
+
/**
* @typedef xsdc__byte
* Axis C++ defined type for xml basic type byte
Modified: webservices/axis/trunk/c/include/axis/AxisUserAPI.hpp
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/AxisUserAPI.hpp?rev=395370&r1=395369&r2=395370&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/AxisUserAPI.hpp (original)
+++ webservices/axis/trunk/c/include/axis/AxisUserAPI.hpp Wed Apr 19 12:41:10 2006
@@ -306,7 +306,7 @@
* Copy Constructor
* @param original xsd__base64Binary object to be copied.
*/
- xsd__base64Binary(const xsd__base64Binary & original);
+ xsd__base64Binary(const xsd__base64Binary & original);
/**
* Destructor
@@ -318,27 +318,27 @@
* @param data binary data
* @param size length, in bytes, of binary data
*/
- void set(xsd__unsignedByte * data, xsd__int size);
+ void set(xsd__unsignedByte * data, xsd__int size);
/**
* Get binary data from xsd__base64Binary object.
* @param size is updated with length, in bytes, of binary data
* @return binary data
*/
- xsd__unsignedByte * get(xsd__int & size) const;
+ xsd__unsignedByte * get(xsd__int & size) const;
/**
* Get length, in bytes, of binary data.
* @return length, in bytes, of binary data
*/
- xsd__int getSize(void) const;
+ xsd__int getSize(void) const;
/**
* Assignment operator
* @param original xsd__base64Binary object from which data is to be assigned
* @return reference to this
*/
- xsd__base64Binary & operator=(const xsd__base64Binary & original);
+ xsd__base64Binary & operator=(const xsd__base64Binary & original);
private:
/**
* Binary data
@@ -371,7 +371,7 @@
/**
* Destructor
*/
- ~xsd__hexBinary();
+ ~xsd__hexBinary();
/**
* Set binary data into xsd__hexBinary object.
Modified: webservices/axis/trunk/c/include/axis/GDefine.h
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/GDefine.h?rev=395370&r1=395369&r2=395370&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/GDefine.h (original)
+++ webservices/axis/trunk/c/include/axis/GDefine.h Wed Apr 19 12:41:10 2006
@@ -34,43 +34,141 @@
#endif
/*
+ * @file GDefine.h
+ *
* This file contains all global definitions that are valid across whole
* Axis C++ project.
*/
-
-typedef enum {AXISC_SECURE, AXISC_UNSECURE} AXISC_SECURE_PROTOCOL;
-
typedef enum
{
- AXISC_SUCCESS=0,
+ /**
+ * Success
+ */
+ AXISC_SUCCESS=0,
+
+ /**
+ * Failure
+ */
AXISC_FAIL = -1,
+
+ /**
+ * Object already exists
+ */
AXISC_OBJECT_ALREADY_EXISTS=1,
+
+ /**
+ * A matching handler does not exist
+ */
AXISC_NO_SUCH_HANDLER,
- AXISC_NO_SUCH_SERVICE
+
+ /**
+ * A matching service does not exist
+ */
+ AXISC_NO_SUCH_SERVICE,
+
+ /**
+ * No SOAP header blocks remaining
+ */
+ AXISC_NO_REMAINING_SOAP_HEADERS
} AXISC_GLOBAL_ERROR;
+/**
+ * @enum AXIS_PROTOCOL_TYPE
+ * Enumeration of transport protocols.
+ */
typedef enum
{
- AXISC_PT_UNKNOWN = -1,
- AXISC_PTHTTP1_0=0,
- AXISC_PTHTTP1_1,
- AXISC_PTFTP,
- AXISC_PTSMTP,
- AXISC_PTHTTPS,
- AXISC_PTOTHER
+ /**
+ * Unknown
+ */
+ AXISC_APT_UNKNOWN = -1,
+
+ /**
+ * HTTP 1.0
+ */
+ AXISC_APTHTTP1_0=0,
+
+ /**
+ * HTTP 1.1
+ */
+ AXISC_APTHTTP1_1,
+
+ /**
+ * FTP
+ */
+ AXISC_APTFTP,
+
+ /**
+ * SMTP
+ */
+ AXISC_APTSMTP,
+
+ /**
+ * HTTPS
+ */
+ AXISC_APTHTTPS,
+
+ /**
+ * Other
+ */
+ AXISC_APTOTHER
} AXISC_PROTOCOL_TYPE;
+/**
+ * @enum AXIS_TRANSPORT_INFORMATION_TYPE
+ * Enumeration of the different information types used by the transport.
+ */
typedef enum
{
+ /**
+ * SoapAction header field
+ */
AXISC_SOAPACTION_HEADER,
+
+ /**
+ * URI to service
+ */
AXISC_SERVICE_URI,
+
+ /**
+ * Name of operation on service
+ */
AXISC_OPERATION_NAME,
+
+ /**
+ * Length of SOAP message
+ */
AXISC_SOAP_MESSAGE_LENGTH,
+
+ /**
+ * Generic transport properties
+ */
AXISC_TRANSPORT_PROPERTIES,
+
+ /**
+ * Properties for secure transport
+ */
AXISC_SECURE_PROPERTIES,
+
+ /**
+ * Name of transport library
+ */
AXISC_DLL_NAME,
+
+ /**
+ * Name of SSL channel library
+ */
AXISC_CHANNEL_HTTP_SSL_DLL_NAME = AXISC_DLL_NAME,
- AXISC_CHANNEL_HTTP_DLL_NAME
+
+ /**
+ * Name of non-SSL channel library
+ */
+ AXISC_CHANNEL_HTTP_DLL_NAME,
+
+ /**
+ * Content type
+ */
+ AXISC_CONTENT_TYPE
} AXISC_TRANSPORT_INFORMATION_TYPE;
#define AXISC_SOAPACTIONHEADER "SOAPAction"
Modified: webservices/axis/trunk/c/include/axis/GDefine.hpp
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/GDefine.hpp?rev=395370&r1=395369&r2=395370&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/GDefine.hpp (original)
+++ webservices/axis/trunk/c/include/axis/GDefine.hpp Wed Apr 19 12:41:10 2006
@@ -164,7 +164,7 @@
/**
* Generic transport properties
*/
- TRANSPORT_PROPERTIES,
+ TRANSPORT_PROPERTIES,
/**
* Properties for secure transport
@@ -179,17 +179,17 @@
/**
* Name of SSL channel library
*/
- CHANNEL_HTTP_SSL_DLL_NAME = DLL_NAME,
+ CHANNEL_HTTP_SSL_DLL_NAME = DLL_NAME,
/**
* Name of non-SSL channel library
*/
- CHANNEL_HTTP_DLL_NAME,
+ CHANNEL_HTTP_DLL_NAME,
/**
* Content type
*/
- CONTENT_TYPE
+ CONTENT_TYPE
} AXIS_TRANSPORT_INFORMATION_TYPE;
#define SOAPACTIONHEADER "SOAPAction"
Modified: webservices/axis/trunk/c/include/axis/Handler.hpp
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/Handler.hpp?rev=395370&r1=395369&r2=395370&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/Handler.hpp (original)
+++ webservices/axis/trunk/c/include/axis/Handler.hpp Wed Apr 19 12:41:10 2006
@@ -49,67 +49,67 @@
class Handler : public HandlerBase
{
public:
- /**
- * Constructor.
- */
+ /**
+ * Constructor.
+ */
Handler(){};
- /**
- * Destructor.
- */
+ /**
+ * Destructor.
+ */
virtual ~Handler(){};
- /**
- * Returns the value of the given option.
- *
- * @param sArg The option name, i.e key
- * @return The option value.
- */
+ /**
+ * Returns the value of the given option.
+ *
+ * @param sArg The option name, i.e key
+ * @return The option value.
+ */
const string& getOption(const string& sArg)
- {
- m_sEmpty = "";
+ {
+ m_sEmpty = "";
- map<string, string>::const_iterator it = m_pOption->find(sArg);
- if (it != m_pOption->end())
- {
- return (*it).second;
- }
- return m_sEmpty;
- }
-
- /**
- * This method is automatically called by the Axis Engine when it loads a
- * Handler. The purpose of this method is described below:
- * For each Handler we could configure various parameters/options in the
- * Server.wsdd or Client.wsdd. If the engine finds any such options then
- * the engine will automaticaly call this method of each handler and will
- * set those options to each Handler by calling this method of each
- * Handler which those configuration options belong to. Normaly a Handler
- * writer doesn't need to interact/deal with this method.
- *
- * @param OptionList The map which contains the options to be set.
- */
+ map<string, string>::const_iterator it = m_pOption->find(sArg);
+ if (it != m_pOption->end())
+ {
+ return (*it).second;
+ }
+ return m_sEmpty;
+ }
+
+ /**
+ * This method is automatically called by the Axis Engine when it loads a
+ * Handler. The purpose of this method is described below:
+ * For each Handler we could configure various parameters/options in the
+ * Server.wsdd or Client.wsdd. If the engine finds any such options then
+ * the engine will automaticaly call this method of each handler and will
+ * set those options to each Handler by calling this method of each
+ * Handler which those configuration options belong to. Normaly a Handler
+ * writer doesn't need to interact/deal with this method.
+ *
+ * @param OptionList The map which contains the options to be set.
+ */
void setOptionList(const map<string, string>* OptionList) {m_pOption = OptionList;};
- /**
- * Gets and returns the type of the handler. The return value here is
- * always NORMAL_HANDLER.
- *
- * @return returns the type of the handler. The return value here is
- * always NORMAL_HANDLER.
- */
+ /**
+ * Gets and returns the type of the handler. The return value here is
+ * always NORMAL_HANDLER.
+ *
+ * @return returns the type of the handler. The return value here is
+ * always NORMAL_HANDLER.
+ */
int AXISCALL getType(){return NORMAL_HANDLER;};
protected:
- /**
- * Used to store the options which are configured in the WSDD.
- */
- const map<string, string>* m_pOption;
-
- /**
- * Represents an empty string.
- */
- string m_sEmpty;
+ /**
+ * Used to store the options which are configured in the WSDD.
+ */
+ const map<string, string>* m_pOption;
+
+ /**
+ * Represents an empty string.
+ */
+ string m_sEmpty;
};
AXIS_CPP_NAMESPACE_END
Modified: webservices/axis/trunk/c/include/axis/IAttribute.hpp
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/IAttribute.hpp?rev=395370&r1=395369&r2=395370&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/IAttribute.hpp (original)
+++ webservices/axis/trunk/c/include/axis/IAttribute.hpp Wed Apr 19 12:41:10 2006
@@ -62,30 +62,30 @@
*/
virtual const AxisChar* getLocalName() = 0;
- /**
- * try to set theattribute with given value
- * @param value to set
- * @return AXIS_SUCCESS if succeeded, AXIS_FAIL otherwise. NOTE: Passing NULL will result in a AXIS_SUCCESS
- */
+ /**
+ * try to set theattribute with given value
+ * @param value to set
+ * @return AXIS_SUCCESS if succeeded, AXIS_FAIL otherwise. NOTE: Passing NULL will result in a AXIS_SUCCESS
+ */
virtual int setValue(const AxisChar* value) = 0;
- /**
- * try to set the URI
- * @param uri to set
- * @return AXIS_SUCCESS if succeeded, AXIS_FAIL otherwise. NOTE: Passing NULL will result in a AXIS_SUCCESS
- */
+ /**
+ * try to set the URI
+ * @param uri to set
+ * @return AXIS_SUCCESS if succeeded, AXIS_FAIL otherwise. NOTE: Passing NULL will result in a AXIS_SUCCESS
+ */
virtual int setURI(const AxisChar* uri) = 0;
- /**
- * try to set the prefix with given value
- * @param prefix to set
- * @return AXIS_SUCCESS if succeeded, AXIS_FAIL otherwise. NOTE: Passing NULL will result in a AXIS_SUCCESS
- */
+ /**
+ * try to set the prefix with given value
+ * @param prefix to set
+ * @return AXIS_SUCCESS if succeeded, AXIS_FAIL otherwise. NOTE: Passing NULL will result in a AXIS_SUCCESS
+ */
virtual int setPrefix(const AxisChar* prefix) = 0;
- /**
- * try to set the attribute with given value
- * @param localname to be set
- * @return AXIS_SUCCESS if succeeded, AXIS_FAIL otherwise. NOTE: Passing NULL will result in a AXIS_SUCCESS
- */
+ /**
+ * try to set the attribute with given value
+ * @param localname to be set
+ * @return AXIS_SUCCESS if succeeded, AXIS_FAIL otherwise. NOTE: Passing NULL will result in a AXIS_SUCCESS
+ */
virtual int setLocalName(const AxisChar* localname) = 0;
/**
* Get the value of this attribute.
Modified: webservices/axis/trunk/c/include/axis/IHandlerSoapSerializer.hpp
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/IHandlerSoapSerializer.hpp?rev=395370&r1=395369&r2=395370&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/IHandlerSoapSerializer.hpp (original)
+++ webservices/axis/trunk/c/include/axis/IHandlerSoapSerializer.hpp Wed Apr 19 12:41:10 2006
@@ -31,7 +31,7 @@
/**
* @class IHandlerSoapSerializer
* @brief interface for the IHandlerSoapSerializer class. This interface is
- * exposed to a Handler Writer, to let him manipulate on the Serialzer object.
+ * exposed to a Handler Writer, to let him manipulate on the Serialzer object.
* Example usage is given below.
* <PRE>
* int ESHHandler::invoke(void *pvIMsg)
@@ -43,11 +43,11 @@
* //this is a response
*
* IHandlerSoapSerializer* pISZ;
- * pIMsg->getSoapSerializer(&pISZ);
+ * pIMsg->getSoapSerializer(&pISZ);
*
- * IHeaderBlock* pIHeaderBlock= pISZ->createHeaderBlock();
+ * IHeaderBlock* pIHeaderBlock= pISZ->createHeaderBlock();
*
- * pIHeaderBlock->setLocalName("echoMeStringResponse");
+ * pIHeaderBlock->setLocalName("echoMeStringResponse");
* }
* }
* </PRE>
@@ -60,66 +60,54 @@
public:
virtual ~IHandlerSoapSerializer() {};
- /**
- * Will create a Header Block and adds it to the Serializer.
- *
- * @return The created Header Block pointer will be returned, which the
- * user can manipulate on it.
- */
+ /**
+ * Will create a Header Block and adds it to the Serializer.
+ *
+ * @return The created Header Block pointer will be returned, which the
+ * user can manipulate on it.
+ */
virtual IHeaderBlock* createHeaderBlock()=0;
- /**
- * Will create a Header Block using the given local name and the namespace
- * uri, and adds it to the Serializer.
- *
- * @param pachLocalName The local name of the Header Block
- * @param pachUri The namespace uri of the Header Block.
- * @return The created Header Block pointer will be returned, which the
- * user can manipulate on it.
- */
+ /**
+ * Will create a Header Block using the given local name and the namespace
+ * uri, and adds it to the Serializer.
+ *
+ * @param pachLocalName The local name of the Header Block
+ * @param pachUri The namespace uri of the Header Block.
+ * @return The created Header Block pointer will be returned, which the
+ * user can manipulate on it.
+ */
virtual IHeaderBlock* createHeaderBlock(const AxisChar *pachLocalName,
- const AxisChar *pachUri)=0;
+ const AxisChar *pachUri)=0;
- /**
- * Adds the given Header Block to the Serialzer.
- *
- * @param pBlk The Header Block to be added.
- * @return AXIS_SUCCESS or AXIS_FAIL to indicate success or fail.
- */
+ /**
+ * Adds the given Header Block to the Serialzer.
+ *
+ * @param pBlk The Header Block to be added.
+ * @return AXIS_SUCCESS or AXIS_FAIL to indicate success or fail.
+ */
virtual int AXISCALL addHeaderBlock(IHeaderBlock* pBlk)=0;
- /**
- * Sets the SOAP Version.
- * @param eSOAP_VERSION The SOAP version to set.
- * @return AXIS_SUCCESS to indicate success.
- */
+ /**
+ * Sets the SOAP Version.
+ * @param eSOAP_VERSION The SOAP version to set.
+ * @return AXIS_SUCCESS to indicate success.
+ */
virtual int setSoapVersion(SOAP_VERSION eSOAP_VERSION)=0;
- /**
- * Gets the Header Block. After returning the Header Block pointer, it
- * will not be removed from the available Header Block list of the
- * Serializer.The caller of this method should not delete the returned
- * pointer object.
- */
- /*
- * TO DO: Have to remove this method from this api. Logged this msg on
- * 13Jan2005.
- virtual IHeaderBlock* getHeaderBlock() = 0;
- */
-
- /**
- * Gets and returns the Header Block of the given local name and
- * namespace uri.After returning the Header Block pointer, it will not be
- * removed from the available Header Block list of the Serializer.
- * The caller of this method should not delete the returned pointer
- * object.
+ /**
+ * Gets and returns the Header Block of the given local name and
+ * namespace uri.After returning the Header Block pointer, it will not be
+ * removed from the available Header Block list of the Serializer.
+ * The caller of this method should not delete the returned pointer
+ * object.
*
* @param pcName local name of the HeaderBlock
* @param pcNamespace namespace of the HeaderBlock
* @return HeaderBlock
- */
- virtual IHeaderBlock* getHeaderBlock(const AxisChar *pcName,
- const AxisChar *pcNamespace) = 0;
+ */
+ virtual IHeaderBlock* getHeaderBlock(const AxisChar *pcName,
+ const AxisChar *pcNamespace)=0;
/**
* Used with getNextHeaderBlock, it returns the first header block,
* or NULL if there are no headers.
@@ -136,11 +124,11 @@
*/
virtual IHeaderBlock* getNextHeaderBlock()=0;
- /**
+ /**
* Used with getFirstHeaderBlock, it returns the current header block,
* or NULL if:
- * - there are no headers,
- * - or if the getFirstHeaderBlock method is not called at least once.
+ * - there are no headers,
+ * - or if the getFirstHeaderBlock method is not called at least once.
* @return Current HeaderBlock
*/
virtual IHeaderBlock* getCurrentHeaderBlock()=0;
@@ -183,7 +171,8 @@
*
*/
- virtual int deleteHeaderBlock(const AxisChar* pName, const AxisChar* pNamespace)=0;
+ virtual int deleteHeaderBlock(const AxisChar* pName,
+ const AxisChar* pNamespace)=0;
/**
*Used to delete all the header block
*
@@ -194,8 +183,9 @@
* Adds the namespace declaration to the SOAP Envelope.
* @param pachNamespaceURI namespace URI to add to SOAP envelope
* @param pachPrefix prefix to be used for namespace URI
- */
- virtual void addNamespaceToEnvelope(AxisChar *pachNamespaceURI, AxisChar* pachPrefix)=0;
+ */
+ virtual void addNamespaceToEnvelope(AxisChar *pachNamespaceURI,
+ AxisChar* pachPrefix)=0;
};
AXIS_CPP_NAMESPACE_END
Modified: webservices/axis/trunk/c/include/axis/IHeaderBlock.hpp
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/IHeaderBlock.hpp?rev=395370&r1=395369&r2=395370&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/IHeaderBlock.hpp (original)
+++ webservices/axis/trunk/c/include/axis/IHeaderBlock.hpp Wed Apr 19 12:41:10 2006
@@ -87,17 +87,6 @@
class IHeaderBlock
{
public:
- /**
- * Sets the namespace declaration of the Header Block.
- *
- * @param pAttribute The Attribute pointer which points to a valid
- * namespace declartion Attribute.
- * @return AXIS_SUCCESS to indicate successfull operation.
- */
- /* TO DO: We need to remove this completely
- *
- virtual int addNamespaceDecl(INamespace *pAttribute)=0;
- */
/**
* Creates a Attribute and adds it to this Header Block as a namespace.
@@ -108,20 +97,20 @@
* @return A pointer to the created Attribute will be returned.
*/
virtual INamespace* createNamespaceDecl(const AxisChar *prefix,
- const AxisChar *uri)=0;
+ const AxisChar *uri)=0;
/**
* Retyrbs the first child element of this Header Block.
*
* @return A pointer to the first child element of this Header Block.
*/
- virtual BasicNode* getFirstChild() =0;
+ virtual BasicNode* getFirstChild()=0;
/**
* Returns the number of child elements of this HeaderBlock.
*
* @return The number of child elements of this HeaderBlock.
*/
- virtual int getNoOfChildren() =0;
+ virtual int getNoOfChildren()=0;
/**
* Creates a child node depending on the given node type. i.e:
@@ -151,33 +140,37 @@
* successfull. If the creation is unsccessfull it will return NULL.
*/
virtual BasicNode* createChild(NODE_TYPE eNODE_TYPE,
- AxisChar *pachLocalName, AxisChar *pachPrefix, AxisChar *pachUri,
- AxisChar* pachValue) = 0;
+ AxisChar *pachLocalName,
+ AxisChar *pachPrefix,
+ AxisChar *pachUri,
+ AxisChar* pachValue) = 0;
- /**
- * Creates a child node depending on the given type. If the type is
- * CHARACTER_NODE a CharacterElement is created. If the type is
- * ELEMENT_NODE a ComplexElement is created. After creating the child it
- * will be added as a immediate child to the header block.
- * It is important to note that if the type is CHARACTER_NODE only the
- * NODE_TYPE and value (pachValue) parameters will be usefull.If the type
- * is ELEMENT_NODE the parameters NODE_TYPE, pachLocalName, pachPrefix,
- * pachUri will be usefull.
- *
- * @param eNODE_TYPE The type of the child to be created, it should be either
- * CHARACTER_NODE for CharacterElements or ELEMENT_NODE for
- * ComplexElements.
- * @param pachLocalName The local name of the complex element to be created.
- * @param pachPrefix The prefix of the complex element to be created.
- * @param pachUri The namespace uri of the complex element to be created.
- * @param pachValue The value of the character element to be created.
- *
- * @return The child node created will be returned if the creation is
- * successfull. If the creation is unsccessfull it will return NULL.
- */
+ /**
+ * Creates a child node depending on the given type. If the type is
+ * CHARACTER_NODE a CharacterElement is created. If the type is
+ * ELEMENT_NODE a ComplexElement is created. After creating the child it
+ * will be added as a immediate child to the header block.
+ * It is important to note that if the type is CHARACTER_NODE only the
+ * NODE_TYPE and value (pachValue) parameters will be usefull.If the type
+ * is ELEMENT_NODE the parameters NODE_TYPE, pachLocalName, pachPrefix,
+ * pachUri will be usefull.
+ *
+ * @param eNODE_TYPE The type of the child to be created, it should be either
+ * CHARACTER_NODE for CharacterElements or ELEMENT_NODE for
+ * ComplexElements.
+ * @param pachLocalName The local name of the complex element to be created.
+ * @param pachPrefix The prefix of the complex element to be created.
+ * @param pachUri The namespace uri of the complex element to be created.
+ * @param pachValue The value of the character element to be created.
+ *
+ * @return The child node created will be returned if the creation is
+ * successfull. If the creation is unsccessfull it will return NULL.
+ */
virtual BasicNode* createImmediateChild(NODE_TYPE eNODE_TYPE,
- AxisChar *pachLocalName, AxisChar *pachPrefix, AxisChar *pachUri,
- AxisChar* pachValue) = 0;
+ AxisChar *pachLocalName,
+ AxisChar *pachPrefix,
+ AxisChar *pachUri,
+ AxisChar* pachValue) = 0;
/**
* A user can use this method to create a standard HeaderBlock attribute.
@@ -211,8 +204,8 @@
*
* @return A pointer to the created standard Attribute will be returned.
*/
- virtual IAttribute* createStdAttribute(HEADER_BLOCK_STD_ATTR_TYPE
- eStdAttrType, SOAP_VERSION eSOAP_VERSION) =0;
+ virtual IAttribute* createStdAttribute(HEADER_BLOCK_STD_ATTR_TYPE eStdAttrType,
+ SOAP_VERSION eSOAP_VERSION) =0;
/**
* Creates a Attribute and adds it to this Header Block.
@@ -228,8 +221,9 @@
* @return A pointer to the created Attribute will be returned.
*/
virtual IAttribute* createAttribute(const AxisChar* localname,
- const AxisChar* prefix,
- const AxisChar* uri, const AxisChar* value) = 0;
+ const AxisChar* prefix,
+ const AxisChar* uri,
+ const AxisChar* value) = 0;
/**
* Creates a Attribute and adds it to this Header Block.
@@ -244,7 +238,8 @@
* @return A pointer to the created Attribute will be returned.
*/
virtual IAttribute* createAttribute(const AxisChar *localname,
- const AxisChar *prefix, const AxisChar *value) = 0;
+ const AxisChar *prefix,
+ const AxisChar *value) = 0;
/**
* Gets an Attribute from the HeaderBlock.
*
@@ -254,7 +249,7 @@
* @return the value of the attribute is returned.
*/
virtual const AxisChar* getAttributeValue(const AxisChar* localname,
- const AxisChar* prefix) = 0;
+ const AxisChar* prefix) = 0;
/**
* Gets and Attribute URI from the Header Block.
@@ -265,7 +260,7 @@
* @return the uri of the attribute is returned.
*/
virtual const AxisChar* getAttributeUri( const AxisChar * localname,
- const AxisChar* prefix) = 0;
+ const AxisChar* prefix) = 0;
/**
* Creates a child node depending on the given type. If the type is
@@ -346,17 +341,8 @@
* @return AXIS_SUCCESS if successful AXIS_FAIL otherwise
*
*/
-
virtual int setURI(const AxisChar* uri)=0;
- /*
- * Commented by Susantha - 21/06/2004
- * The prefix should be decided by the Serializer at runtime
- *
- * Uncommented by Mark Whitlock - 24/8/04 after discussion
- * on the mailing list agreed to add back in this method.
- * Jira issue AXISCPP-135
- */
/**
* Sets the prefix of this Header Block.
*
Modified: webservices/axis/trunk/c/include/axis/IMessageData.hpp
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/IMessageData.hpp?rev=395370&r1=395369&r2=395370&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/IMessageData.hpp (original)
+++ webservices/axis/trunk/c/include/axis/IMessageData.hpp Wed Apr 19 12:41:10 2006
@@ -41,150 +41,154 @@
*/
class IMessageData
{
- /* Allow AxisAdminService access to the private methods */
public:
+ /**
+ * Destructor
+ */
virtual ~IMessageData(){};
-/**
- * This method provides access to the AdminUtils, providing a mechanism for
- * deploying and undeploying services.
- *
- * It is intended that only the AdminService will make use of this API.
- *
- * @param pIAdminUtils will be updated with an IAdminUtils object
- */
+ /**
+ * This method provides access to the AdminUtils, providing a mechanism for
+ * deploying and undeploying services.
+ *
+ * It is intended that only the AdminService will make use of this API.
+ *
+ * @param pIAdminUtils will be updated with an IAdminUtils object
+ */
virtual void getAdminUtils(IAdminUtils** pIAdminUtils)=0;
-/**
- * This method stores the given property value with the key, inside the
- * MessageData object.
- *
- * @param pachName is the key of the property.
- * @param pachValue is the value of the property.
- * @return AXIS_SUCCESS to indicate successful operation.
- */
- virtual int setProperty(const AxisChar* pachName, const AxisChar* pachValue)=0;
-
-/**
- * This method stores the given property value with the key, inside the
- * MessageData object.
- *
- * @param pachName is the key of the property.
- * @param pachValue is the value of the property.
- * @param len is the size of value (pachValue).
- * @return AXIS_SUCCESS to indicate successfull operation.
-*/
- virtual int setProperty(const AxisChar* pachName, const void* pachValue, int len)=0;
-
-/**
- * This method stores the given property value with the key, inside the
- * MessageData object. The value is a complex object.
- *
- * @param pachName is the key of the property.
- * @param pachValue is the value of the property.
- * @param iObjectSize is the size of value (pachValue).
- */
- virtual void setComplexProperty(const AxisChar* pachName, void* pachValue, int iObjectSize)=0;
-
-/**
- * This method returns the matching property value (to the given
- * corresponding key)
- *
- * @param sName is the key of the required property.
- * @return If it is found then matching property value is returned. If not found then it
- * will return an empty string.
- */
+ /**
+ * This method stores the given property value with the key, inside the
+ * MessageData object.
+ *
+ * @param pachName is the key of the property.
+ * @param pachValue is the value of the property.
+ * @return AXIS_SUCCESS to indicate successful operation.
+ */
+ virtual int setProperty(const AxisChar* pachName,
+ const AxisChar* pachValue)=0;
+
+ /**
+ * This method stores the given property value with the key, inside the
+ * MessageData object.
+ *
+ * @param pachName is the key of the property.
+ * @param pachValue is the value of the property.
+ * @param len is the size of value (pachValue).
+ * @return AXIS_SUCCESS to indicate successfull operation.
+ */
+ virtual int setProperty(const AxisChar* pachName,
+ const void* pachValue,
+ int len)=0;
+
+ /**
+ * This method stores the given property value with the key, inside the
+ * MessageData object. The value is a complex object.
+ *
+ * @param pachName is the key of the property.
+ * @param pachValue is the value of the property.
+ * @param iObjectSize is the size of value (pachValue).
+ */
+ virtual void setComplexProperty(const AxisChar* pachName,
+ void* pachValue,
+ int iObjectSize)=0;
+
+ /**
+ * This method returns the matching property value (to the given
+ * corresponding key)
+ *
+ * @param sName is the key of the required property.
+ * @return If it is found then matching property value is returned. If not found then it
+ * will return an empty string.
+ */
virtual const void* getProperty(const AxisChar* sName)=0;
-/**
- * This method returns the matching property value (to the given
- * corresponding key)
- *
- * @param pachName is the key of the required property.
- * @return If it is found then matching property value is returned.
- * If not found NULL is returned.
- */
+ /**
+ * This method returns the matching property value (to the given
+ * corresponding key)
+ *
+ * @param pachName is the key of the required property.
+ * @return If it is found then matching property value is returned.
+ * If not found NULL is returned.
+ */
virtual void* getComplexProperty(const AxisChar* pachName)=0;
-/**
- * Returns the current operation name.
- *
- * @return This method will return the OperationName.
- */
+ /**
+ * Returns the current operation name.
+ *
+ * @return This method will return the OperationName.
+ */
virtual const AxisChar* AXISCALL getOperationName()=0;
-/**
- * This method will assign the current instance of SoapSerializer
- * to the given IWrapperSoapSerializer pointer-to-pointer.By calling this
- * method a caller will have access to the SoapSerializer.
- *
- * @param pIWSS is a pointer to pointer used to get access to the
- * current instance of soapSerializer.
- */
+ /**
+ * This method will assign the current instance of SoapSerializer
+ * to the given IWrapperSoapSerializer pointer-to-pointer.By calling this
+ * method a caller will have access to the SoapSerializer.
+ *
+ * @param pIWSS is a pointer to pointer used to get access to the
+ * current instance of soapSerializer.
+ */
virtual void AXISCALL getSoapSerializer(IWrapperSoapSerializer** pIWSS)=0;
-/**
- * This method will assign the current instance of SoapDeSerializer
- * to the given IWrapperSoapDeSerializer pointer-to-pointer. By calling this
- * method a caller will have access to the SoapDeSerializer.
- *
- * @param pIWSDS is a pointer to pointer used to store the
- * current instance of SoapDeSerializer.
- */
- virtual void AXISCALL getSoapDeSerializer
- (IWrapperSoapDeSerializer** pIWSDS)=0;
-
-/**
- * This method will assign the current instance of SoapSerializer
- * to the given IHandlerSoapSerializer pointer-to-pointer. By calling this
- * method a caller will have access to the SoapSerializer.
- *
- * @param pIHandlerSoapSerializer is a pointer to pointer used to store the
- * current instance of soapSerializer.
- */
- virtual void getSoapSerializer
- (IHandlerSoapSerializer** pIHandlerSoapSerializer)=0;
-
-/**
- * This method will assign the current instance of SoapDeSerializer
- * to the given IHandlerSoapDeSerializer pointer-to-pointer. By calling this
- * method a caller will have access to the SoapDeSerializer.
- *
- * @param pIHandlerSoapDeSerializer is a pointer to pointer used to store the
- * current instance of soapDeSerializer.
- */
- virtual void getSoapDeSerializer
- (IHandlerSoapDeSerializer** pIHandlerSoapDeSerializer)=0;
-
-/**
- * This method will store the given username inside the MessageData object.
- *
- * @param m_sUserName is the value that is passed to be set.
- */
+ /**
+ * This method will assign the current instance of SoapDeSerializer
+ * to the given IWrapperSoapDeSerializer pointer-to-pointer. By calling this
+ * method a caller will have access to the SoapDeSerializer.
+ *
+ * @param pIWSDS is a pointer to pointer used to store the
+ * current instance of SoapDeSerializer.
+ */
+ virtual void AXISCALL getSoapDeSerializer(IWrapperSoapDeSerializer** pIWSDS)=0;
+
+ /**
+ * This method will assign the current instance of SoapSerializer
+ * to the given IHandlerSoapSerializer pointer-to-pointer. By calling this
+ * method a caller will have access to the SoapSerializer.
+ *
+ * @param pIHandlerSoapSerializer is a pointer to pointer used to store the
+ * current instance of soapSerializer.
+ */
+ virtual void getSoapSerializer(IHandlerSoapSerializer** pIHandlerSoapSerializer)=0;
+
+ /**
+ * This method will assign the current instance of SoapDeSerializer
+ * to the given IHandlerSoapDeSerializer pointer-to-pointer. By calling this
+ * method a caller will have access to the SoapDeSerializer.
+ *
+ * @param pIHandlerSoapDeSerializer is a pointer to pointer used to store the
+ * current instance of soapDeSerializer.
+ */
+ virtual void getSoapDeSerializer(IHandlerSoapDeSerializer** pIHandlerSoapDeSerializer)=0;
+
+ /**
+ * This method will store the given username inside the MessageData object.
+ *
+ * @param m_sUserName is the value that is passed to be set.
+ */
virtual void setUserName(string& m_sUserName)=0;
-/**
- * This method returns the user name.
- *
- * @return this method will return the UserName.
- */
+ /**
+ * This method returns the user name.
+ *
+ * @return this method will return the UserName.
+ */
virtual string& getUserName()=0;
-/**
- * This method will return a boolean value which will say whether at the time
- * of calling this method has already passed the pivot point.
- *
- * @return Returns true if the pivot point is past. Returns false if not.
-*/
+ /**
+ * This method will return a boolean value which will say whether at the time
+ * of calling this method has already passed the pivot point.
+ *
+ * @return Returns true if the pivot point is past. Returns false if not.
+ */
virtual bool isPastPivot()=0;
-/**
- * This method is used to set the pivot point status.
- *
- * @param bState is the value of the state that should be set. Set true if
- * pivot point is past. Set false if pivot point is not past yet.
- * @return will return AXIS_SUCCESS to indicate successful operation.
-*/
+ /**
+ * This method is used to set the pivot point status.
+ *
+ * @param bState is the value of the state that should be set. Set true if
+ * pivot point is past. Set false if pivot point is not past yet.
+ * @return will return AXIS_SUCCESS to indicate successful operation.
+ */
virtual int setPastPivotState(bool bState)=0;
};
Modified: webservices/axis/trunk/c/include/axis/INamespace.hpp
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/INamespace.hpp?rev=395370&r1=395369&r2=395370&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/INamespace.hpp (original)
+++ webservices/axis/trunk/c/include/axis/INamespace.hpp Wed Apr 19 12:41:10 2006
@@ -16,10 +16,8 @@
*/
/**
- * @file INamespace.hpp
- *
- *
- */
+ * @file INamespace.hpp
+ */
/**
* @class INamespace
@@ -46,14 +44,14 @@
*
* @return prefix of this namespace.
*/
- virtual const AxisChar* getPrefix()=0;
+ virtual const AxisChar* getPrefix()=0;
/**
* Gets the namespace uri of this Namespace.
*
* @return namespace uri of this Namespace
*/
- virtual const AxisChar* getURI()=0;
+ virtual const AxisChar* getURI()=0;
/**
* Sets the namespace uri of this Namespace.
@@ -62,15 +60,20 @@
* @return AXIS_SUCCESS if successful AXIS_FAIL otherwise. NOTE: Passing NULL will result in a AXIS_SUCCESS
*
*/
- virtual int setURI(const AxisChar* achURI)=0;
+ virtual int setURI(const AxisChar* achURI)=0;
+
/**
* Sets the prefix of this Namespace.
*
* @param achPrefix The prefix to set in.
* @return AXIS_SUCCESS if successful AXIS_FAIL otherwise. NOTE: Passing NULL will result in a AXIS_SUCCESS
*/
- virtual int setPrefix(const AxisChar* achPrefix)=0;
- virtual ~INamespace() {};
+ virtual int setPrefix(const AxisChar* achPrefix)=0;
+
+ /**
+ * Destructor.
+ */
+ virtual ~INamespace() {};
};
Modified: webservices/axis/trunk/c/include/axis/ISoapAttachment.hpp
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/ISoapAttachment.hpp?rev=395370&r1=395369&r2=395370&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/ISoapAttachment.hpp (original)
+++ webservices/axis/trunk/c/include/axis/ISoapAttachment.hpp Wed Apr 19 12:41:10 2006
@@ -21,10 +21,6 @@
*
*/
-// ISoapAttachment.h: interface for the ISoapAttachment class.
-//
-//////////////////////////////////////////////////////////////////////
-
/**
* @file ISoapAttachment.hpp
*/
@@ -57,10 +53,10 @@
AXIS_BINARY = 1
} AXIS_ATTACHMENT_ENCODING_TYPE;
-#define AXIS_CONTENT_ID "Content-Id"
-#define AXIS_CONTENT_TYPE "Content-Type"
-#define AXIS_CONTENT_TRANSFER_ENCODING "Content-Transfer-Encoding"
-#define AXIS_CONTENT_LOCATION "Content-Location"
+#define AXIS_CONTENT_ID "Content-Id"
+#define AXIS_CONTENT_TYPE "Content-Type"
+#define AXIS_CONTENT_TRANSFER_ENCODING "Content-Transfer-Encoding"
+#define AXIS_CONTENT_LOCATION "Content-Location"
/**
* @class ISoapAttachment
@@ -75,14 +71,14 @@
*
* @return Attachment ID.
*/
- virtual const char* getAttachmentId()=0;
+ virtual const char* getAttachmentId()=0;
/**
* Allows the user to add the Body to the current attachment.
*
* @param objBody Base64Binary encoded attachment body.
*/
- virtual void addBody(xsd__base64Binary* objBody)=0;
+ virtual void addBody(xsd__base64Binary* objBody)=0;
/**
* Allows the user to add headers to the current attachments.
@@ -90,14 +86,15 @@
* @param pchName header name.
* @param pchValue header value.
*/
- virtual void addHeader(const char* pchName, const char* pchValue)=0;
+ virtual void addHeader(const char* pchName,
+ const char* pchValue)=0;
/**
* Allows the user to get the Attachment Body
*
* @return Base64Binary encoded body.
*/
- virtual xsd__base64Binary* getBody()=0;
+ virtual xsd__base64Binary* getBody()=0;
/**
* Allows the user to get the required Attachment Header
@@ -105,12 +102,12 @@
* @param pchName The name of the required Attachment Header
* @return Value of the required attachment header.
*/
- virtual const char* getHeader(const char* pchName)=0;
+ virtual const char* getHeader(const char* pchName)=0;
/**
* Destructor
*/
- virtual ~ISoapAttachment() {};
+ virtual ~ISoapAttachment() {};
};
Modified: webservices/axis/trunk/c/include/axis/ISoapFault.hpp
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/c/include/axis/ISoapFault.hpp?rev=395370&r1=395369&r2=395370&view=diff
==============================================================================
--- webservices/axis/trunk/c/include/axis/ISoapFault.hpp (original)
+++ webservices/axis/trunk/c/include/axis/ISoapFault.hpp Wed Apr 19 12:41:10 2006
@@ -39,17 +39,14 @@
/**
* @class ISoapFault
* @brief Interface to represent SoapFault
- *
- *
- * @author damitha kumarage (damitha@jkcsworld.com, damitha@opensource.lk)
*/
-
-
class ISoapFault
{
public:
-
+ /**
+ * Destructor
+ */
virtual ~ISoapFault(){};
/**
@@ -72,8 +69,11 @@
* @param pName name
* @param pNamespace url
*/
- virtual void* getCmplxFaultObject(void* pDZFunct, void* pCreFunct, void* pDelFunct,
- const AxisChar* pName, const AxisChar* pNamespace) = 0;
+ virtual void* getCmplxFaultObject(void* pDZFunct,
+ void* pCreFunct,
+ void* pDelFunct,
+ const AxisChar* pName,
+ const AxisChar* pNamespace) = 0;
/**
* To retrieve a complex fault detail object