ACE Ims Webservice: Difference between revisions
From Adapt
No edit summary |
No edit summary |
||
| (10 intermediate revisions by the same user not shown) | |||
| Line 9: | Line 9: | ||
'''Parameters''' | '''Parameters''' | ||
{| | {| width="75%" | ||
|'''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 | ||
| Line 19: | Line 19: | ||
'''Return Type''' | '''Return Type''' | ||
[[#LinkResponse | [[#LinkResponse|LinkResponse]] | ||
===requestTokensAsync=== | ===requestTokensAsync=== | ||
Add tokens to the currently active round. Clients will need to call [[# | 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''' | '''Parameters''' | ||
| | {| width="75%" | ||
|tokenClassString|String| | |'''Name'''||'''Type'''||'''Description''' | ||
|requests|List[[#TokenRequest | |- | ||
|tokenClassString||String | |||
|- | |||
|requests||List of [[#TokenRequest|TokenRequest]] | |||
|} | |||
'''Return Type''' | '''Return Type''' | ||
[[#TokenReceipt | [[#TokenReceipt|TokenReceipt]] receipt to be used to retrieve token responses | ||
===requestTokensImmediate=== | ===requestTokensImmediate=== | ||
| Line 41: | Line 45: | ||
'''Parameters''' | '''Parameters''' | ||
| | {| width="75%" | ||
|tokenClassString|String| | |'''Name'''||'''Type'''||'''Description''' | ||
|requests|List[[#TokenRequest | |- | ||
|tokenClassString||String | |||
|- | |||
|requests||List of [[#TokenRequest|TokenRequest]]| | |||
|} | |||
'''Return Type''' | '''Return Type''' | ||
List[[#TokenResponse | List of [[#TokenResponse|TokenResponse]] | ||
| Line 56: | Line 64: | ||
'''Parameters''' | '''Parameters''' | ||
| | {| width="75%" | ||
|'''Name'''||'''Type'''||'''Description''' | |||
|} | |||
'''Return Type''' | '''Return Type''' | ||
| Line 64: | Line 75: | ||
'''Parameters''' | '''Parameters''' | ||
| | {| width="75%" | ||
|'''Name'''||'''Type'''||'''Description''' | |||
|} | |||
'''Return Type''' | '''Return Type''' | ||
| Line 70: | Line 83: | ||
==Data Types== | ==Data Types== | ||
===IMSFault=== | ===IMSFault=== | ||
| | {| width="75%" | ||
|message|String | |'''Name'''||'''Type'''||'''Description''' | ||
|serverFault|boolean| | |- | ||
|statusCode|int|Status code indicating type of failure - See [[ | |message||String | ||
|- | |||
|serverFault||boolean | |||
|- | |||
|statusCode||int||Status code indicating type of failure - See [[Ace IMS Status Codes|Status Code Documentation]] for details | |||
|} | |||
===LinkResponse=== | ===LinkResponse=== | ||
| | {| width="75%" | ||
|previousHash|String| | |'''Name'''||'''Type'''||'''Description''' | ||
|rootHash|String| | |- | ||
|roundId|long| | |previousHash||String | ||
|timestamp|dateTime| | |- | ||
|tokenClassName|String| | |rootHash||String | ||
|- | |||
|roundId||long | |||
|- | |||
|timestamp||dateTime | |||
|- | |||
|tokenClassName||String | |||
|} | |||
===TokenReceipt=== | ===TokenReceipt=== | ||
| | {| width="75%" | ||
|'''Name'''||'''Type'''||'''Description''' | |||
|} | |||
===TokenRequest=== | ===TokenRequest=== | ||
| | {| width="75%" | ||
|hashValue|String| | |'''Name'''||'''Type'''||'''Description''' | ||
|name|String| | |- | ||
|hashValue||String | |||
|- | |||
|name||String | |||
|} | |||
===TokenResponse=== | ===TokenResponse=== | ||
| | {| | ||
|digestProvider|String|Name of the java provider for the digest service| | |'''Name'''||'''Type'''||'''Description''' | ||
|digestService|String|Java name for the type of digest (ie, SHA-256)| | |- | ||
|name|String|Name supplied by client for this token| | |digestProvider||String|Name of the java provider for the digest service | ||
|proofElements|List of [[#ProofElement | |- | ||
|roundId|long|current round id this token was processed in| | |digestService||String||Java name for the type of digest (ie, SHA-256) | ||
|statusCode|int|status code indicating type of response - See [[ | |- | ||
|timeStamp|dateTime|Time the round was processed| | |name||String||Name supplied by client for this token | ||
|tokenClassName|String|Name of token class on IMS that was used| | |- | ||
|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 | |||
|- | |||
|tokenClassName||String||Name of token class on IMS that was used | |||
|} | |||
===TokenResponse=== | ===TokenResponse=== | ||
| | {| | ||
|hashes|List of String| | |'''Name'''||'''Type'''||'''Description''' | ||
|index|int| | |- | ||
|hashes||List of String | |||
|- | |||
|index||int | |||
|} | |||
Latest revision as of 20:09, 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
| Name | Type | Description |
| message | String | |
| serverFault | boolean | |
| statusCode | int | Status code indicating type of failure - See Status Code Documentation for details |
LinkResponse
| Name | Type | Description |
| previousHash | String | |
| rootHash | String | |
| roundId | long | |
| timestamp | dateTime | |
| tokenClassName | String |
TokenReceipt
| Name | Type | Description |
TokenRequest
| Name | Type | Description |
| hashValue | String | |
| name | String |
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 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 |
| timeStamp | dateTime | Time the round was processed |
| tokenClassName | String | Name of token class on IMS that was used |
TokenResponse
| Name | Type | Description |
| hashes | List of String | |
| index | int |
