add extjs 6.0.1 sources

[extjs.git] / extjs / packages / soap / src / data / soap / Proxy.js

// @tag enterprise\r
/**\r
 * The SOAP Proxy class is an {@link Ext.data.proxy.Ajax Ajax Proxy} to access v1.1 SOAP\r
 * (Simple Object Access Protocol) services.  SOAP Proxy constructs a SOAP Envelope and \r
 * submits an AJAX request to load a SOAP response from the server.\r
 * \r
 * For help getting started please refer to the [Soap Guide](../../../enterprise/soap.html).\r
 *\r
 * **Note: **  _This functionality is only available with the purchase of\r
 * Sencha Complete.  For more information about using this class, please visit\r
 * our [Sencha Complete](https://www.sencha.com/products/complete/) product page._\r
 *\r
 * @class Ext.data.soap.Proxy\r
 */\r
Ext.define('Ext.data.soap.Proxy', {\r
    extend: 'Ext.data.proxy.Ajax',\r
    alias: 'proxy.soap',\r
\r
    requires: [\r
        'Ext.data.soap.Reader'\r
    ],\r
\r
    config: {\r
        /**\r
        * @cfg {Object} api\r
        * An object containing "create", "read", "update" and "destroy" properties that define\r
        * SOAP operations for each CRUD action method. These operations will be appended to\r
        * the {@link #url} as the {@link #operationParam} for each request type.\r
        * \r
        *     api: {\r
        *         create: undefined,\r
        *         read: undefined,\r
        *         update: undefined,\r
        *         destroy: undefined\r
        *     }\r
        *     \r
        * At least one operation is required, but additional operations do not need to be configured\r
        * if they will not be used.  For example, if this proxy is only used for read operations\r
        * the following configuration will be sufficient:\r
        * \r
        *     api: {\r
        *         read: 'Foo'\r
        *     }\r
        */\r
\r
        /**\r
        * @cfg {Object} soapAction\r
        * An object containing "create", "read", "update" and "destroy" properties that define\r
        * the [SOAPAction](http://www.w3.org/TR/2000/NOTE-SOAP-20000508/#_Toc478383528) header\r
        * for each CRUD action method. A soapAction must be specified for each operation\r
        * configured in {@link #api}  Defaults to:\r
        * \r
        *     soapAction: {\r
        *         create: undefined,\r
        *         read: undefined,\r
        *         update: undefined,\r
        *         destroy: undefined\r
        *     }\r
        */\r
       soapAction: {},\r
\r
        /**\r
        * @cfg {String} [operationParam='op']\r
        * The name of the operation parameter to be appened to the SOAP endpoint url\r
        */\r
        operationParam: 'op',\r
\r
        /**\r
        * @cfg {Object/String/Ext.data.soap.Reader} [reader='soap']\r
        * The {@link Ext.data.soap.Reader} to use to decode the server's response. This can\r
        * either be a SOAP Reader instance, a SOAP Reader config object or 'soap'.\r
        */\r
        reader: 'soap',\r
\r
        /**\r
        * @cfg {String} url\r
        * The SOAP endpoint url that this proxy will use to request the SOAP data. This can\r
        * be a proxied url to work around same-origin policy if the SOAP endpoint url is on\r
        * a different domain from your application.\r
        */\r
       url: '',\r
\r
        /**\r
        * @cfg [envelopeTpl=undefined]\r
        * The template used to create the SOAP envelope.  Defaults to:\r
        * \r
        *     [\r
        *         '<?xml version="1.0" encoding="utf-8" ?>',\r
        *         '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">',\r
        *             '{[values.bodyTpl.apply(values)]}',\r
        *         '</soap:Envelope>'\r
        *     ]\r
        */\r
        envelopeTpl: [\r
            '<?xml version="1.0" encoding="utf-8" ?>',\r
            '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">',\r
                '{[values.bodyTpl.apply(values)]}',\r
            '</soap:Envelope>'\r
        ],\r
\r
        /**\r
        * @cfg {Ext.XTemplate/Array} createBodyTpl\r
        * The template used to create the SOAP body for the "create" action. If not specified\r
        * {@link #writeBodyTpl} will be used for the "create" action.\r
        */\r
       createBodyTpl: null,\r
\r
        /**\r
        * @cfg {Ext.XTemplate/Array} [readBodyTpl=undefined]\r
        * The template used to create the SOAP body for the "read" action.  Defaults to: \r
        * \r
        *     [\r
        *         '<soap:Body>',\r
        *             '<{operation} xmlns="{targetNamespace}">',\r
        *                 '<tpl foreach="params">',\r
        *                     '<{$}>{.}</{$}>',\r
        *                 '</tpl>',\r
        *             '</{operation}>',\r
        *         '</soap:Body>'\r
        *     ]\r
        */\r
        readBodyTpl: [\r
            '<soap:Body>',\r
                '<{operation} xmlns="{targetNamespace}">',\r
                    '<tpl foreach="params">',\r
                        '<{$}>{.}</{$}>',\r
                    '</tpl>',\r
                '</{operation}>',\r
            '</soap:Body>'\r
        ],\r
\r
        /**\r
        * @cfg {Ext.XTemplate/Array} updateBodyTpl\r
        * The template used to create the SOAP body for the "update" action. If not specified\r
        * {@link #writeBodyTpl} will be used for the "update" action.\r
        */\r
       updateBodyTpl: null,\r
\r
        /**\r
        * @cfg {Ext.XTemplate/Array} destroyBodyTpl\r
        * The template used to create the SOAP body for the "destroy" action. If not specified\r
        * {@link #writeBodyTpl} will be used for the "destroy" action.\r
        */\r
       destroyBodyTpl: null,\r
\r
        /**\r
        * @cfg {Ext.XTemplate/Array} [writeBodyTpl=undefined]\r
        * The default template used to create the SOAP body for write actions (create, update,\r
        * and destroy). The individual body templates for each write action can be configured\r
        * using {@link #createBodyTpl}, {@link #updateBodyTpl}, and {@link #destroyBodyTpl}.\r
        * Defaults to:\r
        * \r
        *     [\r
        *          '<soap:Body>',\r
        *              '<{operation} xmlns="{targetNamespace}">',\r
        *                  '<tpl for="records">',\r
        *                      '{% var recordName=values.modelName.split(".").pop(); %}',\r
        *                      '<{[recordName]}>',\r
        *                          '<tpl for="fields">',\r
        *                              '<{name}>{[parent.get(values.name)]}</{name}>',\r
        *                          '</tpl>',\r
        *                      '</{[recordName]}>',\r
        *                  '</tpl>',\r
        *              '</{operation}>',\r
        *          '</soap:Body>'\r
        *      ]\r
        */\r
        writeBodyTpl: [\r
            '<soap:Body>',\r
                '<{operation} xmlns="{targetNamespace}">',\r
                    '<tpl for="records">',\r
                        '{% var recordName=values.modelName.split(".").pop(); %}',\r
                        '<{[recordName]}>',\r
                            '<tpl for="fields">',\r
                                '<{name}>{[parent.get(values.name)]}</{name}>',\r
                            '</tpl>',\r
                        '</{[recordName]}>',\r
                    '</tpl>',\r
                '</{operation}>',\r
            '</soap:Body>'\r
        ],\r
\r
        /**\r
        * @cfg {String} targetNamespace\r
        * namespace URI used by {@link #createBodyTpl}, {@link #readBodyTpl}, {@link #updateBodyTpl},\r
        * and {@link #destroyBodyTpl} as the "xmlns" attribute for the operation element.\r
        */\r
       targetNamespace: ''\r
    },\r
    \r
    applyEnvelopeTpl: function(tpl) {\r
        return this.createTpl(tpl);\r
    },\r
    \r
    applyCreateBodyTpl: function(tpl) {\r
        return this.createTpl(tpl);\r
    },\r
    \r
    applyReadBodyTpl: function(tpl) {\r
        return this.createTpl(tpl);\r
    },\r
    \r
    applyUpdateBodyTpl: function(tpl) {\r
        return this.createTpl(tpl);\r
    },\r
    \r
    applyDestroyBodyTpl: function(tpl) {\r
        return this.createTpl(tpl);\r
    },\r
    \r
    applyWriteBodyTpl: function(tpl) {\r
        return this.createTpl(tpl);\r
    },\r
    \r
    createTpl: function(tpl) {\r
        if (tpl && !tpl.isTpl) {\r
            tpl = new Ext.XTemplate(tpl);\r
        }\r
        return tpl;\r
    },\r
    \r
    /**\r
     * @property {Object} actionMethods\r
     * @readonly\r
     * Mapping of action name to HTTP request method.  All SOAP actions are mapped to 'POST'\r
     */\r
\r
    doRequest: function(operation) {\r
        var me = this,\r
            action = operation.getAction(),\r
            soapOperation = me.getApi()[action],\r
            params = Ext.applyIf(operation.getParams() || {}, me.getExtraParams() || {}),\r
            xmlData = me.getEnvelopeTpl().apply({\r
                operation: soapOperation,\r
                targetNamespace: me.getTargetNamespace(),\r
                params: params,\r
                records: operation.getRecords(),\r
                bodyTpl: me.getBodyTpl(action)\r
            }),\r
            request = new Ext.data.Request({\r
                url: me.getUrl() + '?' + me.getOperationParam() + '=' + soapOperation,\r
                method: 'POST',\r
                action: action,\r
                operation: operation,\r
                xmlData: xmlData,\r
                headers: Ext.apply({\r
                    SOAPAction: me.getSoapAction()[action]\r
                }, me.getHeaders()),\r
                timeout: me.getTimeout(),\r
                scope: me,\r
                disableCaching: false // explicitly set it to false, ServerProxy handles caching\r
            });\r
\r
        request.setCallback(me.createRequestCallback(request, operation));\r
        return me.sendRequest(request);\r
    },\r
    \r
    getBodyTpl: function(action) {\r
        action = Ext.String.capitalize(action);\r
        var tpl = this['get' + action + 'BodyTpl']();\r
        return tpl || this.getWriteBodyTpl();\r
    }\r
});\r