OpenLayers. Protocol.HTTP

A basic HTTP protocol for vector layers.  Create a new instance with the OpenLayers.Protocol.HTTP constructor.

Inherits from

Summary
OpenLayers. Protocol.HTTPA basic HTTP protocol for vector layers.
Constructor
OpenLayers. Protocol.HTTPA class for giving layers generic HTTP protocol.
Functions
destroyClean up the protocol.
readConstruct a request for reading new features.
createConstruct a request for writing newly created features.
updateConstruct a request updating modified feature.
deleteConstruct a request deleting a removed feature.
commitIterate over each feature and take action based on the feature state.
abortAbort an ongoing request, the response object passed to this method must come from this HTTP protocol (as a result of a create, read, update, delete or commit operation).

Constructor

OpenLayers. Protocol.HTTP

A class for giving layers generic HTTP protocol.

Parameters

options{Object} Optional object whose properties will be set on the instance.

Valid options include

url{String}
headers{Object}
params{Object}
format{OpenLayers.Format}
callback{Function}
scope{Object}

Functions

destroy

destroy: function()

Clean up the protocol.

read

read: function(options)

Construct a request for reading new features.

Parameters

options{Object} Optional object for configuring the request.  This object is modified and should not be reused.

Valid options

url{String} Url for the request.
params{Object} Parameters to get serialized as a query string.
headers{Object} Headers to be set on the request.
filter{<OpenLayers.Filter.BBOX>} If a bbox filter is sent, it will be serialized according to the OpenSearch Geo extension (bbox=minx,miny,maxx,maxy).  Note that a BBOX filter as the child of a logical filter will not be serialized.
readWithPOST{Boolean} If the request should be done with POST.

Returns

{OpenLayers.Protocol.Response} A response object, whose “priv” property references the HTTP request, this object is also passed to the callback function when the request completes, its “features” property is then populated with the the features received from the server.

create

create: function(features,
options)

Construct a request for writing newly created features.

Parameters

features{Array({OpenLayers.Feature.Vector})} or {OpenLayers.Feature.Vector}
options{Object} Optional object for configuring the request.  This object is modified and should not be reused.

Returns

{OpenLayers.Protocol.Response} An OpenLayers.Protocol.Response object, whose “priv” property references the HTTP request, this object is also passed to the callback function when the request completes, its “features” property is then populated with the the features received from the server.

update

update: function(feature,
options)

Construct a request updating modified feature.

Parameters

feature{OpenLayers.Feature.Vector}
options{Object} Optional object for configuring the request.  This object is modified and should not be reused.

Returns

{OpenLayers.Protocol.Response} An OpenLayers.Protocol.Response object, whose “priv” property references the HTTP request, this object is also passed to the callback function when the request completes, its “features” property is then populated with the the feature received from the server.

delete

"delete": function(feature,
options)

Construct a request deleting a removed feature.

Parameters

feature{OpenLayers.Feature.Vector}
options{Object} Optional object for configuring the request.  This object is modified and should not be reused.

Returns

{OpenLayers.Protocol.Response} An OpenLayers.Protocol.Response object, whose “priv” property references the HTTP request, this object is also passed to the callback function when the request completes.

commit

commit: function(features,
options)

Iterate over each feature and take action based on the feature state.  Possible actions are create, update and delete.

Parameters

features{Array({OpenLayers.Feature.Vector})}
options{Object} Optional object for setting up intermediate commit callbacks.

Valid options

create{Object} Optional object to be passed to the create method.
update{Object} Optional object to be passed to the update method.
delete{Object} Optional object to be passed to the delete method.
callback{Function} Optional function to be called when the commit is complete.
scope{Object} Optional object to be set as the scope of the callback.

Returns

{Array(OpenLayers.Protocol.Response)} An array of response objects, one per request made to the server, each object’s “priv” property references the corresponding HTTP request.

abort

abort: function(response)

Abort an ongoing request, the response object passed to this method must come from this HTTP protocol (as a result of a create, read, update, delete or commit operation).

Parameters

response{OpenLayers.Protocol.Response}
destroy: function()
Clean up the protocol.
read: function(options)
Construct a request for reading new features.
create: function(features,
options)
Construct a request for writing newly created features.
update: function(feature,
options)
Construct a request updating modified feature.
"delete": function(feature,
options)
Construct a request deleting a removed feature.
commit: function(features,
options)
Iterate over each feature and take action based on the feature state.
abort: function(response)
Abort an ongoing request, the response object passed to this method must come from this HTTP protocol (as a result of a create, read, update, delete or commit operation).
A class for giving layers generic HTTP protocol.
Abstract vector layer protocol class.
Base class for format reading/writing a variety of formats.
Protocols return Response objects to their users.
Vector features use the OpenLayers.Geometry classes as geometry description.
Close