ACE Ims Webservice: Difference between revisions
From Adapt
No edit summary |
No edit summary |
||
| Line 7: | Line 7: | ||
===requestLink=== | ===requestLink=== | ||
'''Parameters''' | |||
{| | |||
|*Name*|*Type*|*Description*| | |*Name*|*Type*|*Description*| | ||
|tokenClassName|String|Name of token class to link this hash into| | |tokenClassName|String|Name of token class to link this hash into| | ||
|hashValue|String|Value to link| | |hashValue|String|Value to link| | ||
|} | |||
'''Return Type''' | |||
[[#LinkResponse][LinkResponse]] | [[#LinkResponse][LinkResponse]] | ||
| Line 21: | Line 23: | ||
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. | 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*| | |*Name*|*Type*|*Description*| | ||
| Line 27: | Line 29: | ||
|requests|List[[#TokenRequest][TokenRequest]]| | |requests|List[[#TokenRequest][TokenRequest]]| | ||
'''Return Type''' | |||
[[#TokenReceipt][TokenReceipt]] receipt to be used to retrieve token responses | [[#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. | 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*| | |*Name*|*Type*|*Description*| | ||
| Line 41: | Line 43: | ||
|requests|List[[#TokenRequest][TokenRequest]]| | |requests|List[[#TokenRequest][TokenRequest]]| | ||
'''Return Type''' | |||
List[[#TokenResponse][TokenResponse]] | List[[#TokenResponse][TokenResponse]] | ||
===getRoundSummaries=== | |||
Return the requested round summaries | Return the requested round summaries | ||
'''Parameters''' | |||
|*Name*|*Type*|*Description*| | |*Name*|*Type*|*Description*| | ||
'''Return Type''' | |||
===retrieveTokens=== | |||
'''Parameters''' | |||
|*Name*|*Type*|*Description*| | |*Name*|*Type*|*Description*| | ||
'''Return Type''' | |||
==Data Types== | ==Data Types== | ||
#ImsFault | #ImsFault | ||
===IMSFault=== | |||
|*Name*|*Type*|*Description*| | |*Name*|*Type*|*Description*| | ||
| Line 75: | Line 77: | ||
#LinkResponse | #LinkResponse | ||
===LinkResponse=== | |||
|*Name*|*Type*|*Description*| | |*Name*|*Type*|*Description*| | ||
| Line 86: | Line 88: | ||
#TokenReceipt | #TokenReceipt | ||
===TokenReceipt=== | |||
|*Name*|*Type*|*Description*| | |*Name*|*Type*|*Description*| | ||
#TokenRequest | #TokenRequest | ||
===TokenRequest=== | |||
|*Name*|*Type*|*Description*| | |*Name*|*Type*|*Description*| | ||
| Line 98: | Line 100: | ||
#TokenResponse | #TokenResponse | ||
===TokenResponse=== | |||
|*Name*|*Type*|*Description*| | |*Name*|*Type*|*Description*| | ||
| Line 112: | Line 114: | ||
#ProofElement | #ProofElement | ||
===TokenResponse=== | |||
|*Name*|*Type*|*Description*| | |*Name*|*Type*|*Description*| | ||
|hashes|List of String| | |hashes|List of String| | ||
|index|int| | |index|int| | ||
Revision as of 19:50, 9 September 2008
Overview
The IMS wsdl document is available here http://ims.umiacs.umd.edu:8080/ace-ims/IMSWebService?wsdl
Methods
requestLink
Parameters
| *Type*|*Description*| | String|Name of token class to link this hash into| | 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
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 [[AceV3StatusCodes][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|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|
- ProofElement
TokenResponse
|*Name*|*Type*|*Description*| |hashes|List of String| |index|int|
