WebserviceStore

WebserviceStore : public : public

Description

Sample Code

NPL.load("(gl)script/kids/3DMapSystemApp/localserver/WebserviceStore.lua");

Member Functions

WebserviceStore:CallRestEx

------------------------------------------
 WebserviceStore : public <localserver>
------------------------------------------
local WebserviceStore = commonlib.inherit(Map3DSystem.localserver.ResourceStore, {
   -- type of WebCacheDB.ServerType
   server_type_ = WebCacheDB.ServerType.WEBSERVICE_STORE,
   -- default policy
   Cache_policy = Map3DSystem.localserver.CachePolicy:new("access plus 1 hour"),
   Cache_policy_REST = Map3DSystem.localserver.CachePolicy:new("access plus 1 week"),
}

commonlib.setfield("Map3DSystem.localserver.WebserviceStore", WebserviceStore);

• param Cache :_policy: nil or default Cache_policy_REST. (one week time)
• param url : url of the HTML page
• param callbackFunc : the call back function(entry, callbackContext or url) end, entry.payload.cached_filepath is name of the file that contains the text returned via HTTP, usually it is xml, html, mcml, etc. so caller can construct an xml tree from it. Note that the callbackFunc may be called before this function returns since the request may be served locally.
• param callbackContext : this is an optional parameter that is passed to callbackFunc
• return return : true if it is fetching data or data is already available. it return nil or paraworld.errorcode, if web service can not be called at this time, due to error or too many concurrent calls.

syntax

function WebserviceStore:CallRestEx(Cache_policy, url, callbackFunc, callbackContext)

parameters

WebserviceStore:CallXML

Same as CallRestEx? . the only difference is that callbackFunc(xmlRootNode, entry, callbackContext) contains the xml table, instead of entry object.

syntax

function WebserviceStore:CallXML(Cache_policy, url, callbackFunc, callbackContext)

parameters

WebserviceStore:CallWebserviceEx

call a web service from the local server, using a local_cache_policy If there is already a completed response before, we will return the response immediately. And then still proceed to do the update check if expired.

• param Cache :_policy: nil or Map3DSystem? .localserver.CachePolicy
• param url : url of the web service
• param msg : an NPL table to be sent.
• param REST :_policy: an array of variable names in the msg from which the web service request is converted to a REST style url. a REST style url encodes both the web services url and msg data. see UrlHelper for details.
• param callbackFunc : the call back function(msg, callbackContext or url) end, Note that the callbackFunc may be called before this function returns since the request may be served locally.
• param callbackContext : this is an optional parameter that is passed to callbackFunc
• return return : true if it is fetching data or data is already available.

syntax

function WebserviceStore:CallWebserviceEx(Cache_policy, url, msg, REST_policy, callbackFunc, callbackContext) 

parameters

creating instances of local servers

Description

Sample Code

NPL.load("(gl)script/kids/3DMapSystemApp/localserver/factory.lua");
local store = Map3DSystem.localserver.CreateStore("WebserviceStore_sample", 2)
local store = Map3DSystem.localserver.CreateStore("ResourceStore_sample", 1)
local store = Map3DSystem.localserver.CreateStore("ManagedResourceStore_sample", 0)

Member Functions

Map3DSystem.localserver.GetStore

get the loaded store. if the store is not loaded,it will return nil. To CreateGet? a store, use CreateStore? () instead.

syntax

function Map3DSystem.localserver.GetStore(name)

parameters

cache policy

Description

NPL local server caching policy

• find the entry in the local server. If a completed entry is found, it is always returned immediately, regardless of whether it has expired or not.
• if no entry is found or the entry expired, a new entry will be fetched via remote server and updated in the local server.
• When a entry is updated in the store, it will be returned to all callback functions registered to it.

To increase efficiency, one can create several different cache policy objects and share them for all local stores and related function calls.

Sample Code

NPL.load("(gl)script/kids/3DMapSystemApp/localserver/cache_policy.lua");
local cache_policy = Map3DSystem.localserver.CachePolicy:new("access plus 1 month");
cache_policy:IsExpired(ParaGlobal.GetSysDateTime()-80000);

-- there are some premade policies, which can be retrieve from Map3DSystem.localserver.CachePolicies, see below
local cp = Map3DSystem.localserver.CachePolicies["never"];
local cp = Map3DSystem.localserver.CachePolicies["always"];
local cp = Map3DSystem.localserver.CachePolicies["1 hour"];
local cp = Map3DSystem.localserver.CachePolicies["1 day"];

Member Functions

CachePolicy:new

--------------------------
 CachePolicy class
--------------------------

local CachePolicy = {
   -- The base time is either the last modification time of the file, or the time of the client's access to the document.
   -- 0 means that the file's last modification time should be used as the base time, 
   -- 1 means the client's access time should be used.
   -- nil Expiration is not enabled. 
   BaseTime = 1,
   -- Time in seconds to expire relative to BaseTime. e.g. 2592000 is a month, which is good for asset and images.  604800 is a week which is good for profile and content pages. 
   ExpireTime = 604800,
}

commonlib.setfield("Map3DSystem.localserver.CachePolicy", CachePolicy);

create the object and init from initCode. format of initCode, please see Init() function.

syntax

function CachePolicy:new(initCode)

parameters

CachePolicy:Init

[[ Extacts the policy base time type expire time from an input string.

• param initCode : string: it has the following syntax

function CachePolicy:Init(initCode)

function CachePolicy:IsExpired(Basetime)

function CachePolicy:IsCacheEnabled()

function CachePolicy:IsCacheAlwaysUsed()