votorola.s.wap

Class HarvestWAP

java.lang.Object

Call

HarvestWAP

@ThreadRestricted(value="constructor")
public final class HarvestWAP
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 harvest cache 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:

 {
    "h": [
     {
        "id": 16,
        "sender": "Mike-ZeleaCom",
        "message": {
           "content": "At the bottom: (That's our new hack/prototype of a difference bridge. It's ugly as sin. It works poorly on these drafts too, because of the long wrapped ",
           "location": "http://mail.zelea.com/list/votorola/2010-May/000369.html"
        },
        "difference": {
           "key": "2891.2893",
           "selectand": "a"
        }
     },
 }
 

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	respond(Responding res) Servlet response, streaming out JSON from the DiffMessageTable.

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

See Also:

Constant Field Values

Constructor Detail

HarvestWAP

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

Constructs a HarvestWAP. This service is used by TalkTrack

Parameters:

_prefix -

_req -

_resConfig -

Throws:

HTTPRequestException

Method Detail

respond

public void respond(Responding res)
             throws IOException

Servlet response, streaming out JSON from the DiffMessageTable.

Specified by:

respond in class Call

Throws:

IOException