ACE Ims Webservice

---+IMS Webservice Documentation

---++Overview

The IMS wsdl document is available here http://ims.umiacs.umd.edu:8080/ace-ims/IMSWebService?wsdl

---++Methods

---+++requestLink

• Parameters*

|*Name*|*Type*|*Description*| |tokenClassName|String|Name of token class to link this hash into| |hashValue|String|Value to link|

• Return Type*

[[#LinkResponse][LinkResponse]]

---+++requestTokensAsync

Add tokens to the currently active round. Clients will need to call [[#RetrieveTokens][retrieveTokens]] to request created tokens after the round has finished. This call is to allow for non-blocking operation.

• Parameters*

|*Name*|*Type*|*Description*| |tokenClassString|String| |requests|List[[#TokenRequest][TokenRequest]]|

• Return Type*

[[#TokenReceipt][TokenReceipt]] receipt to be used to retrieve token responses

---+++requestTokensImmediate

Force a round to process, designed to be a blocking call. Any tokens supplied in this call plus any async tokens supplied since last round will be included in this current round. Resulting tokens for requests will be returned to client.

• Parameters*

|*Name*|*Type*|*Description*| |tokenClassString|String| |requests|List[[#TokenRequest][TokenRequest]]|

• Return Type*

List[[#TokenResponse][TokenResponse]]

---+++getRoundSummaries

Return the requested round summaries

• Parameters*

|*Name*|*Type*|*Description*|

• Return Type*

---+++<nop>retrieveTokens

• Parameters*

|*Name*|*Type*|*Description*|

• Return Type*

---++<nop>Data Types

1. ImsFault

---+++<nop>IMSFault

|*Name*|*Type*|*Description*| |message|String |serverFault|boolean| |statusCode|int|Status code indicating type of failure - See [[AceV3StatusCodes][Status Code Documentation]] for details |

1. LinkResponse

---+++<nop>LinkResponse

|*Name*|*Type*|*Description*| |previousHash|String| |rootHash|String| |roundId|long| |timestamp|dateTime| |tokenClassName|String|

1. TokenReceipt

---+++<nop>TokenReceipt

|*Name*|*Type*|*Description*|

1. TokenRequest

---+++<nop>TokenRequest

|*Name*|*Type*|*Description*| |hashValue|String| |name|String|

1. TokenResponse

---+++<nop>TokenResponse

|*Name*|*Type*|*Description*| |digestProvider|String|Name of the java provider for the digest service| |digestService|String|Java name for the type of digest (ie, SHA-256)| |name|String|Name supplied by client for this token| |proofElements|List of [[#ProofElement][ProofElements]]| |roundId|long|current round id this token was processed in| |statusCode|int|status code indicating type of response - See [[AceV3StatusCodes][Status Code Documentation]] for details| |timeStamp|dateTime|Time the round was processed| |tokenClassName|String|Name of token class on IMS that was used|

1. ProofElement

---+++<nop>TokenResponse |*Name*|*Type*|*Description*| |hashes|List of String| |index|int|

-- Main.MikeSmorul - 17 Jul 2008