votorola.s.wap

Class DiffFeedWAP

java.lang.Object

Call

DiffFeedWAP

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

A web API for the harvested messages. An example request is:

 http://reluk.ca:8080/v/wap?wCall=hHarvest&hPoll=Sys/p/sandbox&hUser=Jill-ProviderNet&hStartDate=1330969452&wPretty
 

Query parameters

These are the specific parameters for the cache engine API. See also the general parameters for the web API. The examples shown below assume a call prefix of 'h', but the actual prefix depends on the wCall request parameter. Newest are first in the returned JSON Array.

Key	Value	Default
hPoll	Names the poll.	Empty, optional item.
hUser	Specify 'hUser=Jim-MailCom' to request messages from a specific user(s).	Empty, optional item.
hId	Specify 'hId=1234' to only request messages newer than this serial. This allows you to update a list by only fetching newer slices.	Empty, optional item.

Response

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

 {
    "bite": [ 
        // bites in order of sent date, newest first
        { // diff messages
            "difference": { 
                "key": KEY
            },
            "message": {
                "content": "SUMMARY",
                "location": "WEB-URL",
                "sentDate": "SENT-DATE";
            }
            "poll": "POLLNAME"
            "persons": [
                { 
                    ...
                    "username": "VOTERMAILISHUSERNAME",
                    ...
                },
                {
                    ...
                    "username": "CANDIDATEMAILISHUSERNAME",
                    ...
                }
            ],
        },
        // and so on, up to maximum server side provided messages or hSize
    ]
 }
 

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DiffFeedWAP(String _prefix, Requesting _req, ResponseConfiguration _resConfig) Constructs a DiffFeedWAP (former HarvestWAP).

Method Summary

Methods

Modifier and Type	Method and Description
void	respond(Responding res) Method implementing the servlet response.

Methods inherited from class Call

init, 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 * * "DiffFeed" . For example: wCall=hHarvest.

See Also:

Constant Field Values

Constructor Detail

DiffFeedWAP

public DiffFeedWAP(String _prefix,
           Requesting _req,
           ResponseConfiguration _resConfig)
            throws HTTPRequestException

Constructs a DiffFeedWAP (former HarvestWAP).

Parameters:

_prefix -

_req -

_resConfig -

Throws:

HTTPRequestException

Method Detail

respond

public void respond(Responding res)
             throws IOException

Method implementing the servlet response.

Specified by:

respond in class Call

Throws:

IOException