votorola.s.wap.store

Class StoreWAP

java.lang.Object

Call

StoreWAP

@ThreadRestricted(value="constructor")
public final class StoreWAP
extends Call

A web API for the ephemeral storage of unimportant data. Exclusive stores are assigned to clients based on HTTP signature, but exclusivity is not guaranteed. Two clients may happen to have the same signature and thus be assigned the same store. Nor is the duration of storage guaranteed. This facility is intended for short-lived data of low importance and especially for sharing data across domains, as for instance between a referrer and its target document. It therefore supplements cookies and Web Storage which cannot be shared across domains. An example request is:

http://reluk.ca:8080/v/wap?wCall=sStore&sPut=mykey'myvalue&wPretty

Query parameters

These parameters are specific to the store API. See also the general WAP parameters. Calls are conventionally prefixed by 's' (wCall=sStore). If you choose a different prefix, then adjust the parameter names below accordingly.

Key	Value	Action
sGet	A storage key, optionally followed by a guard comprising an apostrophe (') and a value as in "sGet=address'23+Main+Street". The key may not include an apostrophe, but the guard value may. The guard value may also be empty.	If no guard is specified, then it returns the currently stored value, which may be null. If a guard is specified, then the action depends on whether the guard value matches the stored value. If it matches, then the stored value is returned as usual and is also deleted from the store; otherwise null is returned and the stored value is not deleted. This is currently the only method of deleting individual values.
sPut	A single key/value pair separated by an apostrophe ('), as in "sPut=address'23+Main+Street". If multiple apostrophes are present, then the first is taken as the separator. The key may not include an apostrophe, but the value may. The value may also be empty.	Stores the value under the key and returns the same value.

Any of the above parameters may be specified multiple times to multiple effect. A request specifying "sGet=name&sGet=address", for example, will yield the values of both "name" and "address".

Response

The response includes the following components. These are shown in JSON format with explanatory comments:

 {
    "s": { // or other prefix, per wCall query parameter
       "value": { // keyed values:
          "KEY": "VALUE", // the typical value is a string
          "KEY": "",      // the string may be empty
          "KEY": null     // it may also be null, meaning nothing at all is stored
          // and so on
       }
    }
 }

The response headers are set to forbid client caching and the use of stale responses. However these headers are not necessarily obeyed by all clients. Consider therefore adding a nonce to all requests as a fallback.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CALL_TYPE The name to use in the wCall query parameter, which is "Store".

Constructor Summary

Constructors

Constructor and Description
StoreWAP(String prefix, Requesting req, ResponseConfiguration resConfig) Constructs a StoreWAP.

Method Summary

Methods

Modifier and Type	Method and Description
static String	clientSignature(HttpServletRequest reqHS) Returns the signature of the requesting client.
static void	init(WAP wap)
void	respond(Responding res) Responds to the call.

Methods inherited from class Call

prefix, req

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CALL_TYPE

public static final String CALL_TYPE

The name to use in the wCall query parameter, which is "Store". For example: wCall=sStore.

See Also:

Constant Field Values

Constructor Detail

StoreWAP

public StoreWAP(String prefix,
        Requesting req,
        ResponseConfiguration resConfig)
         throws HTTPRequestException

Constructs a StoreWAP.

Throws:

HTTPRequestException

See Also:

Call.prefix(), Call.req()

Method Detail

init

@ThreadSafe
public static void init(WAP wap)
                 throws ServletException

Throws:

ServletException

clientSignature

public static String clientSignature(HttpServletRequest reqHS)

Returns the signature of the requesting client.

respond

public void respond(Responding res)
             throws IOException

Description copied from class: Call

Responds to the call.

Specified by:

respond in class Call

Throws:

IOException