Changes between Version 61 and Version 62 of UniformClearinghouseAPI

Timestamp:

09/17/13 12:44:42 (11 years ago)

Author:

mbrinn@bbn.com

Comment:

--

UniformClearinghouseAPI

@@ -655 +655 @@
 It is expected that the register_aggregate and remove_aggregate calls will be restricted to aggregates (in which case no speaks-for credential is required). That said, SAs may implement authorization policies of their choosing on these calls.
 
-/*
-
-Associate an aggregate as having sliver information in a given slice
-Expected to be called by an aggregate as an asynchronous (not critical-path) part of the resource allocation process.
-
-*/
-
-'''Arguments:'''
-
-slice_urn: URN of slice for which to associate aggregate
-
-aggregate_url : URL of aggregate for which slivers may exist for the given slice
-
-'''Return:'''
-
-None
-
-function '''register_aggregate'''(slice_urn, aggregate_url, credentials, options)
-
-/*
-
-Dis-associate an aggregate as having sliver information in a given slice
-
-Expected to be called by an aggregate as an asynchronous (not critical-path) part of the resource de-allocation process.
-
-*/
-
-'''Arguments:'''
-
-slice_urn: URN of slice for which to associate aggregate
-
-aggregate_url : URL of aggregate for which slivers may exist for the given slice
-
-'''Return:'''
-
-None
-
-function '''remove_aggregate'''(slice_urn, aggregate_url, credentials, options)
-
-/*
-
-Provide a list of URLs of all aggregates that have been registered as having resources allocated with a given slice.
-
-NB: This list is not definitive in that the aggregate may not have called the register_aggregate call, and that the slivers may no longer be at the aggregate. But it is provided as a convenience for tools to know where to go for sliver information (rather than querying every aggregate in the Registry).
-
-'''Arguments:'''
-
-slice_urn: URN of slice for which to return associated aggregates
-
-'''Return:'''
-
-List of URL’s of aggregates for which slivers may exist for given slice.
-
-*/
-
-function '''get_slice_aggregates'''(slice_urn, credentials, options)
+The following table contains the required fields for sliver info objects and whether they are allowed in lookup 'match' criteria, required at creation or allowed at update:
+
+|| '''Name''' || '''Type''' || '''Description''' || '''Match''' || '''Creation''' || '''Update''' ||
+|| SLIVER_INFO_SLICE_URN || URN || URN of slice for registered sliver || Yes || Required || No ||
+|| SLIVER_INFO_URN || URN || URN of registered sliver || Yes || Required || No ||
+|| SLIVER_INFO_AGGREGATE_URN || URN || URN of aggregate of registered sliver || Yes || Required || No ||
+|| SLIVER_INFO_CREATOR_URN || URN || URN of member/tool that created the registered sliver || Yes || Required || No ||
+|| SLIVER_INFO_EXPIRATION || DATETIME || Time of sliver expiration || No || Allowed || Yes ||
+|| SLIVER_INFO_CREATION || DATETIME || Time of sliver creation || No || Allowed || No ||
+
+/*
+
+Create a record of a sliver creation
+
+'''Arguments:'''
+
+options: 'fields' containing the fields for the sliver info  being registered at SA
+
+'''Return:'''
+
+Dictionary of name/value pairs for created sliver_info record
+
+*/
+
+function '''create_sliver_info'''(credentials, options)
+
+/*
+
+Delete a sliver_info record
+
+'''Arguments:'''
+
+sliver_urn: urn of sliver whose record is to be deleted
+
+'''Return:'''
+
+True if succeeded
+
+Should return ARGUMENT_ERROR if no such sliver urn is registered
+
+*/
+
+function '''delete_sliver_info'''(sliver_urn, credentials, options)
+
+/*
+
+Update the details of a sliver_info record
+
+'''Arguments:'''
+
+sliver_urn: urn of sliver for which to update
+
+options: 'fields' containing fields for sliver_infos that are permitted for update
+
+'''Return:'''
+
+True if succeeded
+
+Should return ARGUMENT_ERROR if no such sliver_urn is found
+
+*/
+
+function '''update_sliver_info'''(sliver_urn, credentials, options)
+
+/*
+
+Lookup sliver_info for given match criteria return fields in given filter criteria
+
+'''Arguments:'''
+
+options: 'match' for query match criteria, 'filter' for fields to be returned
+
+'''Return:'''
+
+Dictionary (indexed by sliver_urn) of dictionaries containing name/value pairs for all sliver_infos registered at this SA matching given criteria.
+
+*/
+
+function '''lookup_sliver_info'''(credentials, options)
+
 
 == Project Service Methods ==