SOAP Services
Many classes have shortcut names used when creating (instantiating) a class with a
configuration object. The shortcut name is referred to as an alias (or xtype if the
class extends Ext.Component). The alias/xtype is listed next to the class name of
applicable classes for quick reference.
Framework classes or their members may be specified as private or protected. Else,
the class / member is public. Public, protected, and private are access
descriptors used to convey how and when the class or class member should be used.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
static label next to the
method name. *See Static below.Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).
Let's look at each part of the member row:
lookupComponent in this example)( item ) in this example)Ext.Component in this case). This may be omitted for methods that do not
return anything other than undefined or may display as multiple possible values
separated by a forward slash / signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false if unsuccessful which would be displayed as
Ext.Component/Boolean).PROTECTED in
this example - see the Flags section below)Ext.container.Container in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source in the example)item : Object in the example).undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)Available since 3.4.0 - not pictured in
the example) just after the member descriptionDefaults to: false)The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.
classInstance.method1().method2().etc();false is returned from
an event handler- Indicates a framework class
- A singleton framework class. *See the singleton flag for more information
- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)
- Indicates that the class, member, or guide is new in the currently viewed version
- Indicates a class member of type config
- Indicates a class member of type property
- Indicates a class member of type
method
- Indicates a class member of type event
- Indicates a class member of type
theme variable
- Indicates a class member of type
theme mixin
- Indicates that the class, member, or guide is new in the currently viewed version
Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.
Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.
Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.
Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.
If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.
Both API docs and guides can be searched for using the search field at the top of the page.
On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.
The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.
Clicking on an empty search field will show your last 10 searches for quick navigation.
Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.
Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.
Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:
The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.
SOAP (Simple Object Access Protocol) is a Web Services standard built on HTTP and XML. The SOAP Ext.data.soap.Proxy and Ext.data.soap.Reader provide a convenient way to create a SOAP request, and load the SOAP response into Ext.data.Store. This guide will show you how to use the SOAP Proxy and Reader to load data from and save data to a fictional SOAP service that provides information about blenders. This guide assumes a basic knowledge of the Ext JS Data Package. This guide assumes you are already somewhat familiar with the Ext JS Data package.
For starters, let's take a look at the simplest configuration required to get a Ext.data.Store up and running with SOAP data.
First create a [[ext:]].
Ext.define('Blender', {
extend: 'Ext.data.Model',
fields: [
{ name: 'id', type: 'int' },
{ name: 'name', type: 'string' },
{ name: 'price', type: 'float' }
]
});
Next create the store, proxy and reader.
var store = Ext.create('Ext.data.Store', {
model: 'Blender',
proxy: {
type: 'soap',
url: 'BlenderService/',
api: {
create: 'CreateBlender',
read: 'GetBlenders',
update: 'UpdateBlender',
destroy: 'DeleteBlender'
},
soapAction: {
create: 'http://example.com/BlenderService/CreateBlender',
read: 'http://example.com/BlenderService/GetBlenders',
update: 'http://example.com/BlenderService/UpdateBlender',
destroy: 'http://example.com/BlenderService/DeleteBlender'
},
operationParam: 'operation',
targetNamespace: 'http://example.com/',
reader: {
type: 'soap',
record: 'm|Blender',
namespace: 'm'
}
}
});
Let's go over the configuration options we just specified. We created a Store that will contain "Blender" model instances. We configured the Store with a SOAP proxy. Lets review the proxy's options in a bit more detail:
Ext.data.soap.Proxy#cfg-operationParam - the name of the url parameter that contains the operation name. For example, an operationParam of 'operation' would result in a read request url that looks something like this:
http://example.com/BlenderService/?operation=GetBlenders
Ext.data.soap.Proxy#cfg-targetNamespace - the target namespace of the SOAP service. This is needed to construct the SOAP envelope.
Now that we have everything configured, loading data into the store is as easy as calling
the store's load method. Behind the scenes this will create a SOAP request to the
operation
specified by the read property in the proxy's api configuration property, which is
"GetBlenders" in our example. Let's assume that the GetBlenders SOAP operation requires
a "brand" parameter. We can pass the parameter directly to the store's load method, or
if the parameter value is the same for every request we could configure it directly on the
proxy using the Ext.data.soap.Proxy#cfg-extraParams config. For this example
let's just pass it to the store's load method:
store.load({
params: {
brand: 'Blendtec'
}
});
The above call should trigger a post to:
http://example.com/BlenderService/?operation=GetBlenders
Assume that the response to the above request looks like this:
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<m:GetBlendersResponse xmlns:m="http://example.com/">
<m:Blender>
<m:id>1</m:id>
<m:name>Total Blender Classic WildSide</m:name>
<m:price>454.95</m:price>
</m:Blender>
<m:Blender>
<m:id>2</m:id>
<m:name>The Kitchen Mill</m:name>
<m:price>179.95</m:price>
</m:Blender>
</m:GetBlendersResponse>
</soap:Body>
</soap:Envelope>
Let's pass a callback function to the load call so we can see what the store's records look like after it is loaded:
store.load({
params: {
brand: 'Blendtec'
},
callback: function() {
console.log(store.getCount()); // 2 records were loaded.
console.log(store.getAt(0).get('name')); // get the name field of the first record.
}
});
Now, using the developer tools in your browser of choice, examine the outgoing XHR requests. You should see a HTTP POST to:
http://example.com/BlenderService/?operation=GetBlenders
Now examine the post body of this request. You should see a SOAP envelope that looks something like this (formatted for readability):
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetBlenders xmlns="http://example.com/">
<brand>Blendtec</brand>
</GetBlenders>
</soap:Body>
</soap:Envelope>
This SOAP envelope was constructed using the Ext.data.soap.Proxy#cfg-envelopeTpl template and the SOAP body was constructed using the Ext.data.soap.Proxy#cfg-readBodyTpl template. You may need to modify the body template if the SOAP service requires a different format. You won't typically need to modify the envelope template, but it is cusomizable as well. These configurable templates can each be either an Ext.XTemplate instance or an array of strings to form an XTemplate. The following illustrates using custom templates to change the "soap" envelope namespace prefix to "s":
proxy: {
...
envelopeTpl: [
'<?xml version="1.0" encoding="utf-8" ?>',
'<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">',
'{[values.bodyTpl.apply(values)]}',
'</s:Envelope>'
],
readBodyTpl: [
'<s:Body>',
'<{operation} xmlns="{targetNamespace}">',
'<tpl foreach="params">',
'<{$}>{.}</{$}>',
'</tpl>',
'</{operation}>',
'</s:Body>'
]
}
Call store.load() again and you should see the post body being generated from the new templates:
<?xml version="1.0" encoding="utf-8" ?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<GetBlenders xmlns="http://example.com/">
<brand>Blendtec</brand>
</GetBlenders>
</s:Body>
</s:Envelope>
Create, update, and destroy requests work almost the same as read requests with the exception of how the SOAP body is constructed. The simple difference is this - read requests construct the SOAP body using a set of parameters, while create, update, and destroy requests construct the SOAP body using a set of records. By default the templates used to create the SOAP body for create, update, and destroy requests are all the same:
[
'<soap:Body>',
'<{operation} xmlns="{targetNamespace}">',
'<tpl for="records">',
'{% var recordName=values.modelName.split(".").pop(); %}',
'<{[recordName]}>',
'<tpl for="fields">',
'<{name}>{[parent.get(values.name)]}</{name}>',
'</tpl>',
'</{[recordName]}>',
'</tpl>',
'</{operation}>',
'</soap:Body>'
]
These templates can be customized using the Ext.data.soap.Proxy#cfg-createBodyTpl, Ext.data.soap.Proxy#cfg-updateBodyTpl, and Ext.data.soap.Proxy#cfg-destroyBodyTpl configuration options as described in the above section on customizing the SOAP envelope and body, or the Ext.data.soap.Proxy#cfg-writeBodyTpl configuration option can be used to apply the same template to all three actions.
To issue a create request first we have to create a new record:
var blender = Ext.create('Blender', {
name: 'WildSide Jar',
price: 99
});
Then add the record to the store and call its sync method:
store.add(blender);
store.sync();
This will result in an HTTP POST being issued to the endpoint url with the create operation parameter:
`http://example.com/BlenderService/?operation=CreateBlender`
If you examine the post body of this request you will see that the newly created record has been encoded into the SOAP body:
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CreateBlender xmlns="http://example.com/">
<Blender>
<id>0</id>
<name>WildSide Jar</name>
<price>99</price>
</Blender>
</CreateBlender>
</soap:Body>
</soap:Envelope>
The response to a create request should include the record as created by the server, so that the record's id can be updated on the client side. For example:
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<m:GetBlendersResponse xmlns:m="http://example.com/">
<m:Blender>
<m:id>3</m:id>
<m:name>WildSide Jar</m:name>
<m:price>99</m:price>
</m:Blender>
</m:GetBlendersResponse>
</soap:Body>
</soap:Envelope>
We can verify that the record has the correct id by checking its id property after the store has been successfully synchronized:
store.sync({
success: function() {
console.log(blender.getId()); // 3
}
});
To update a record just modify one of it's fields, and then synchronize the store:
store.getAt(0).set('price', 200);
store.sync();
To destroy a record, remove it from the store and then synchronize:
store.removeAt(1);
store.sync();
Just like create actions, if the server response to an update or destroy action includes the record(s) the client side record will be updated with the data in the response.
And that's all you need to know to get up and running with SOAP and Ext JS. For more details please refer to the API docs for the SOAP Ext.data.soap.Proxy and Ext.data.soap.Reader.
For a working example and full source code see SOAP Grid Example
Ext JS | Terms of Use