ACE Ims Webservice: Difference between revisions
From Adapt
No edit summary |
No edit summary |
||
| Line 89: | Line 89: | ||
|'''Name'''||'''Type'''||'''Description''' | |'''Name'''||'''Type'''||'''Description''' | ||
|- | |- | ||
|message|String | |message||String | ||
|serverFault|boolean| | |- | ||
|statusCode|int|Status code indicating type of failure - See [[ | |serverFault||boolean | ||
|- | |||
|statusCode||int||Status code indicating type of failure - See [[Ace IMS Status Codes][Status Code Documentation]] for details | |||
|} | |} | ||
| Line 100: | Line 102: | ||
|'''Name'''||'''Type'''||'''Description''' | |'''Name'''||'''Type'''||'''Description''' | ||
|- | |- | ||
|previousHash|String| | |previousHash||String | ||
|rootHash|String| | |- | ||
|roundId|long| | |rootHash||String | ||
|timestamp|dateTime| | |- | ||
|tokenClassName|String | |roundId||long | ||
|- | |||
|timestamp||dateTime | |||
|- | |||
|tokenClassName||String | |||
|} | |} | ||
| Line 121: | Line 127: | ||
|'''Name'''||'''Type'''||'''Description''' | |'''Name'''||'''Type'''||'''Description''' | ||
|- | |- | ||
|hashValue|String| | |hashValue||String | ||
|name|String | |- | ||
|name||String | |||
|} | |} | ||
| Line 128: | Line 135: | ||
===TokenResponse=== | ===TokenResponse=== | ||
{| | |||
|'''Name'''||'''Type'''||'''Description''' | |'''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)| | |digestProvider||String|Name of the java provider for the digest service | ||
|name|String|Name supplied by client for this token| | |- | ||
|proofElements|List of [[#ProofElement][ProofElements]]| | |digestService||String||Java name for the type of digest (ie, SHA-256) | ||
|roundId|long|current round id this token was processed in| | |- | ||
|statusCode|int|status code indicating type of response - See [[ | |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 [[Ace IMS Status Codes|Status Code Documentation]] for details | |||
|- | |||
|timeStamp|dateTime|Time the round was processed| | |timeStamp|dateTime|Time the round was processed| | ||
|tokenClassName|String|Name of token class on IMS that was used| | |||
|tokenClassName|String|Name of token class on IMS that was used | |||
|} | |||
#ProofElement | #ProofElement | ||
===TokenResponse=== | ===TokenResponse=== | ||
{| | |||
|'''Name'''||'''Type'''||'''Description''' | |'''Name'''||'''Type'''||'''Description''' | ||
|hashes|List of String| | |- | ||
|index|int| | |hashes||List of String | ||
|- | |||
|index||int | |||
|} | |||
Revision as of 20:08, 9 September 2008
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
requestTokensAsync
Add tokens to the currently active round. Clients will need to call 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 of TokenRequest |
Return Type
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 of TokenRequest| |
Return Type
List of TokenResponse
getRoundSummaries
Return the requested round summaries
Parameters
| Name | Type | Description |
Return Type
retrieveTokens
Parameters
| Name | Type | Description |
Return Type
Data Types
- ImsFault
IMSFault
| Name | Type | Description |
| message | String | |
| serverFault | boolean | |
| statusCode | int | Status code indicating type of failure - See [[Ace IMS Status Codes][Status Code Documentation]] for details |
- LinkResponse
LinkResponse
| Name | Type | Description |
| previousHash | String | |
| rootHash | String | |
| roundId | long | |
| timestamp | dateTime | |
| tokenClassName | String |
- TokenReceipt
TokenReceipt
| Name | Type | Description |
- TokenRequest
TokenRequest
| Name | Type | Description |
| hashValue | String | |
| name | String |
- TokenResponse
TokenResponse
| Name | Type | Description |
| digestProvider | 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 Status Code Documentation for details |
| dateTime|Time the round was processed| | String|Name of token class on IMS that was used |
- ProofElement
TokenResponse
| Name | Type | Description |
| hashes | List of String | |
| index | int |
