it_bus_config/mq_wsdl_port.h

#ifndef _IT_BUS_CONFIG_MQ_WSDL_PORT_H_
#define _IT_BUS_CONFIG_MQ_WSDL_PORT_H_

// @Copyright 2004 IONA Technologies, Plc. All Rights Reserved.
//

#ifndef IT_MINIMISE_INCLUDES
#include <it_bus_pdk/xml_helper.h>
#include <it_bus_pdk/messaging_transport.h>
#endif
#include <stdio.h>
#include <it_bus/exception.h>
#include <it_bus/binary_buffer.h>
#include <it_bus/sequence_complex_type.h>
#include <it_bus_config/endpoint_address.h>
#include <it_bus_config/mq_wsdl_extension_element.h>

namespace IT_Bus
{
    class XMLHelper;
}
namespace IT_MQ
{
    const IT_Bus::QName MQ_CONNECTION_CONTEXT_TYPE("","MQConnectionAttributesType","http://schemas.iona.com/transports/mq");
    const IT_Bus::QName MQ_MESSAGE_CONTEXT_TYPE("","MQMessageAttributesType","http://schemas.iona.com/transports/mq");

    class IT_MQ_API MQConfiguration :
        public MQWSDLExtensionElement,
        public IT_Bus::EndpointAddress,
        public IT_Bus::SequenceComplexType
    {
    public:

        MQConfiguration();

        MQConfiguration(
            const IT_Bus::QName& element_name
        );

        MQConfiguration(
            IT_WSDL::WSDLExtensibleNode* parent
        );

        MQConfiguration(
            const MQConfiguration& copyThis
        );

        virtual
        ~MQConfiguration();

        const MQConfiguration&
        operator = (
            const MQConfiguration& assignThis
        );

        //
        // AnyType (base of WSDLExtensionElement) methods.
        //

        virtual const IT_Bus::QName&
        get_type() const;

        virtual void
        read(
            const IT_Bus::QName& element_name,
            IT_Bus::ComplexTypeReader& reader
        ) throw((IT_Bus::DeserializationException));

        virtual void
        write(
            const IT_Bus::QName& element_name,
            IT_Bus::ComplexTypeWriter& writer
        ) const throw((IT_Bus::SerializationException));

        virtual IT_Bus::AnyType&
        copy(
            const IT_Bus::AnyType& rhs
        );

        //
        // WSDLNode (base of WSDLExtensionElement) methods.
        //

        virtual void
        write(
            IT_Bus::XMLOutputStream& stream
        ) const throw((IT_Bus::IOException));

        //
        // WSDLExtenionsElement methods.
        //

        virtual bool
        parse(
            const IT_Bus::XMLIterator& element_iterator,
            const IT_Bus::XMLNode& element,
            IT_WSDL::WSDLErrorHandler& error_handler
        );

        virtual
        IT_WSDL::WSDLExtensionElement*
        clone() const;

        virtual
        IT_WSDL::WSDLExtensionElement*
        clone_unique(
            const IT_Bus::QName& name
        ) const;

        virtual bool
        export_to_client() const;

        //
        // XMLNode methods.
        //

        virtual void
        write_attributes(
            IT_Bus::XMLOutputStream& stream
        ) const throw((IT_Bus::IOException));

        //
        // EndpointAddress methods.
        //

        const IT_Bus::String&
        get_location() const;

        void
        set_location(
            const IT_Bus::String& location
        );

        //
        // SequenceComplexType methods.
        //

        virtual void
        read_contents(
            IT_Bus::ComplexTypeReader& os
        ) throw((IT_Bus::DeserializationException));

        virtual void
        write_contents(
            IT_Bus::ComplexTypeWriter& os
        ) const throw((IT_Bus::SerializationException));

        virtual void
        write_attributes(
            IT_Bus::ComplexTypeWriter& writer
        ) const throw((IT_Bus::SerializationException));

        virtual void
        read_attributes(
            IT_Bus::ComplexTypeReader& reader
        ) throw((IT_Bus::DeserializationException));

        //
        // MQConfiguration methods.
        //

        void initialize(
            const IT_Bus::XMLIterator& Configuration
        );

        void initialize(
            IT_Bus::XMLHelper& Configuration
        );

        void
        initialize_from_url(
            const IT_Bus::String& strURL
        );

        void
        initialize_from_file(
            const IT_Bus::String& strFile
        );

        virtual
        void set_soap_action(
            const IT_Bus::String & action
        );
        IT_Bus::String       m_ConnectionName;
        IT_Bus::String       m_QueueManagerName;
        IT_Bus::String       m_IsQueueManagerRemote;
        IT_Bus::String       m_QueueName;
        IT_Bus::String       m_ReplyQueueManagerName;
        IT_Bus::String       m_IsReplyQueueManagerRemote;
        IT_Bus::String       m_ReplyQueueName;
        IT_Bus::String       m_AliasQueueName;

        IT_Bus::String       m_ApplicationIdData;
        IT_Bus::String       m_ApplicationOriginData;
        IT_Bus::String       m_UserIdentifier;

        IT_Bus::BinaryBuffer m_MessageId;
        IT_Bus::BinaryBuffer m_CorrelationId;

        IT_Bus::String       m_ModelQueueName;
        IT_Bus::String       m_Timeout;
        IT_Bus::String       m_MessageExpiry;
        IT_Bus::String       m_MessagePriority;
        IT_Bus::String       m_AccessMode;
        IT_Bus::String       m_UsageStyle;
        IT_Bus::String       m_KeepReplyQueue;
        IT_Bus::String       m_CorrelationStyle;
        IT_Bus::String       m_ConnectionFastPath;
        IT_Bus::String       m_ConnectionReusable;
        IT_Bus::String       m_DeliveryMode;
        IT_Bus::String       m_TransactionalParticipation;
        IT_Bus::String       m_ReportOption;
        IT_Bus::String       m_FormatOption;
        IT_Bus::String       m_Convert;
        IT_Bus::String       m_AccountingToken;
        IT_Bus::String       m_ServerClient;
        bool                 m_IsServerTransport;
        bool                 m_PropogateTransactions;

      private:
        IT_Bus::String       m_location;

        void
        initialize_location();
    };

    typedef enum
    {
        usagePeer = 0,
        usageRequester = 1,
        usageResponder = 2
    } UsageStyle;

    typedef enum
    {
        correlationNone = 0,
        correlationMessageId = 1,
        correlationId = 2,
        correlationNewGUID = 3,
        correlationMessageIdCopy = 4
    } CorrelationStyle;

    typedef enum
    {
        mqOpen = 0,
        mqClose = 1,
        mqRecv = 2,
        mqPeek = 3,
        mqSend = 4,
        mqBegin = 5,
        mqCommit = 6,
        mqAbort = 7,
        mqConnect = 8,
        mqDisconnect = 9,
        mqShutdown = 10
    } MQAction;

    typedef enum
    {
        resultSuccess = 0,
        resultError = 1,
        resultShutdown = 2,
        resultFatal = 3,
        resultPending = 4
    } MQThreadResult;

    typedef enum
    {
        mqtxnNo = 0,
        mqtxnYes = 1,
        mqtxnXATM = 2
    } MQTransactionalParticipation;

    const IT_Long MQ_ERROR_PENDING = -1;
    const IT_Long INFINITE_WAIT = -1;
}

//(SYSTEM.DEFAULT.MODEL.QUEUE) default model queue

// queue path name
#define ATTRIBUTE_QUEUE_NAME                    "QueueName"
// queue path name
#define ATTRIBUTE_QUEUE_MANAGER                 "QueueManager"
#define ATTRIBUTE_IS_QUEUE_MANAGER_REMOTE       "IsQueueManagerRemote"
// reply queue path name
#define ATTRIBUTE_REPLY_QUEUE_NAME              "ReplyQueueName"
// alias queue path name
#define ATTRIBUTE_ALIAS_QUEUE_NAME              "AliasQueueName"
// reply queue path name
#define ATTRIBUTE_REPLY_QUEUE_MANAGER           "ReplyQueueManager"
#define ATTRIBUTE_IS_REPLY_QUEUE_MANAGER_REMOTE "IsReplyQueueManagerRemote"
// queue path name
#define ATTRIBUTE_MODEL_QUEUE_NAME              "ModelQueueName"

// connection name (connection ID)
#define ATTRIBUTE_CONNECTION_NAME               "ConnectionName"
// queue access mode
#define ATTRIBUTE_ACCESS_MODE                   "AccessMode"
// enable notification timeout
#define ATTRIBUTE_TIMEOUT                       "Timeout"
// message ID
#define ATTRIBUTE_MSG_ID                        "MessageID"
// correlation ID
#define ATTRIBUTE_COR_ID                        "CorrelationID"

// application ID data
#define ATTRIBUTE_APPLICATION_ID_DATA           "ApplicationIdData"

// application origin dara
#define ATTRIBUTE_APPLICATION_ORIGIN_DATA       "ApplicationOriginData"

// user identifier
#define ATTRIBUTE_USER_IDENTIFIER               "UserIdentifier"

#define ATTRIBUTE_MESSAGE_EXPIRY                "MessageExpiry"
#define ATTRIBUTE_MESSAGE_PRIORITY              "MessagePriority"
#define ATTRIBUTE_CONVERT                       "Convert"
#define ATTRIBUTE_ACCOUNTING_TOKEN              "AccountingToken"
#define ATTRIBUTE_REPLYQUEUE_KEEP               "ReplyQueueKeep"
#define ATTRIBUTE_SERVER_CLIENT                 "Server_Client"

#define OUTBOUND_METADATA_NAMESPACE             "OutboundMetaData"

// Access mode values

#define ACC_PEEK_MODE                           "peek"
#define ACC_SEND_MODE                           "send"
#define ACC_RECEIVE_MODE                        "receive"
#define ACC_RECEIVE_MODE_EXCLUSIVE              "receive exclusive"
#define ACC_RECEIVE_MODE_SHARED                 "receive shared"


// Default timeout value

#define DEFAULT_TIMEOUT         (-1)

// Usage Model
#define ATTRIBUTE_USAGE_STYLE           "UsageStyle"
#define USAGE_PEER                      "PEER"
#define USAGE_REQUESTER                 "REQUESTER"
#define USAGE_RESPONDER                 "RESPONDER"

// Correlation Strategy
#define ATTRIBUTE_CORRELATION_STYLE     "CorrelationStyle"
#define CORRELATION_NONE                "none"
#define CORRELATION_MESSAGEID           "messageId"
#define CORRELATION_ID                  "correlationId"
#define CORRELATION_NEW_GUID            "new guid"
#define CORRELATION_MESSAGEID_COPY      "messageId copy"

//Connection Style
#define ATTRIBUTE_CONNECTION_REUSABLE   "ConnectionReusable"
#define ATTRIBUTE_CONNECTION_FASTPATH   "ConnectionFastPath"

//delivery
#define ATTRIBUTE_DELIVERY              "Delivery"
#define DELIVERY_EXPRESS                "not persistent"
#define DELIVERY_RECOVERABLE            "persistent"

//transactional participation
#define ATTRIBUTE_TRANSACTIONAL         "Transactional"
#define TRANSACTIONAL_NO                "none"
#define TRANSACTIONAL_YES               "internal"
#define TRANSACTIONAL_MANAGER           "xa"
#define PROPOGATE_TRANSACTIONS          "PropogateTransactions"

//Administrative Acknowledgements
#define ATTRIBUTE_REPORT_OPTION         "ReportOption"
#define REPORT_NONE                     "none"
#define REPORT_COA                      "coa"
#define REPORT_COD                      "cod"
#define REPORT_EXCEPTION                "exception"
#define REPORT_EXPIRATION               "expiration"
#define REPORT_DISCARD                  "discard"

// Format options
// formatting options for message presently STRING or NONE
#define ATTRIBUTE_FORMAT_OPTION         "Format"
#define FMT_FORMAT_NONE                 "none"
#define FMT_FORMAT_STRING               "string"
#define FMT_FORMAT_EVENT                "event"
#define FMT_FORMAT_PROGRAMMABLE_COMMAND "programmable command"
#define FMT_FORMAT_UNICODE              "unicode"
#define FMT_FORMAT_IMS                  "ims"
#define FMT_FORMAT_IMS_VAR_STRING       "ims_var_string"

// used for sending SwA messages over MQ.
// Only supported by Artix.
//
#define FMT_FORMAT_SWA                  "IONASWA1"

#endif  

---