Changes between Version 26 and Version 27 of NewTestbedAPISpec

Timestamp:

Jul 8, 2014 2:32:58 PM (10 years ago)

Author:

faber

Comment:

--

NewTestbedAPISpec

@@ -3 +3 @@
 = DETER Testbed API =
 
-The DETER testbed API is broken up into 5 services, each covering one of the major abstractions that the testbed exports.  The services are:
-
+The DETER testbed API is broken up into services, each covering one of the major abstractions that the testbed exports.  The services are:
+
+ * Admin
  * ApiInfo
  * Users
  * Projects
- * Resrources
+ * Resources
  * Experiments
+ * Libraries
 
 We discuss each in detail and provide links to the detailed javadoc of the implementation, where applicable and available.
@@ -30 +32 @@
    * internal - internal server error
    * password - user has an expired password that must be changed
+   * login - user is not logged in for a call that requires a valid login.
  * ErrorString - a string describing the broad error
  * DetailString - a string describing the details that caused the error
@@ -36 +39 @@
 
 [http://www.isi.edu/~faber/tmp/DeterAPI/doc/net/deterlab/testbed/api/DeterFault.html javadoc for DeterFault]
+
 
 == ApiInfo ==
@@ -1157 +1161 @@
 After {{{releaseExperiment}}} succeeds, experiment state remains in the testbed, but containers are stopped and resources are returned to the testbed.
 
+== Admin ==
+
+The Admin service allows testbed administrators to manipulate the implementation internals and to initialize the testbed.  Most users will use this interface.  This section is provided out of order for completeness.
+
+[http://www.isi.edu/~faber/tmp/DeterAPI/doc/net/deterlab/testbed/api/Admin.html javadocs for Admin]
+
+The various permissions described in this document are also installed in the implementation's database.  It is possible to add new permissions while the system is running using the addPermission call.  The name of a permission is a string (scoped by the object).  Objects include circle, library, experiment, and project.
+
+ * '''Service:''' Admin
+ * '''Operation:''' addPermission
+ * '''Input Parameters:'''
+   * name - the name of the permission to add (string)
+   * object - the object type for which it is valid (string)
+ * '''Return Values:'''
+   * a boolean, true if successful
+
+
+The bootstrap call initializes an empty system and adds a user with full administrative power.  This only works if no admin project exists and no '''deterboss''' user exists.  It also creates a regression project for testing.  It returns the userid and password of the new admin user (always deterboss).
+
+ * '''Service:''' Admin
+ * '''Operation:''' bootstrap
+ * '''Input Parameters:'''
+   * none
+ * '''Return Values:'''
+   * bootstrap user (string)
+   * bootstrap password (string)
+
+The clearCredentialCache() call removes any cached credentials from the system.
+
+ * '''Service:''' Admin
+ * '''Operation:''' clearCredentialCache
+ * '''Input Parameters:'''
+   * none
+ * '''Return Values:'''
+   * true on success
+
+There are simple timers inserted in the code at times.  One can access their values and reset them using:
+
+ * '''Service:''' Admin
+ * '''Operation:''' getTimerValues
+ * '''Input Parameters:'''
+   * a list of timer names (may be empty)
+ * '''Return Values:'''
+   * A list of pairs of
+    * timer name (string)
+    * timer total (64-bit integer) elapsed time since started
+
+ * '''Service:''' Admin
+ * '''Operation:''' removeTimers
+ * '''Input Parameters:'''
+   * a list of timer names (may be empty)
+ * '''Return Values:'''
+   * true on success
+
+If the policy databases have changed, administrators can reset the underlying policy and credential database using
+
+ * '''Service:''' Admin
+ * '''Operation:''' resetAccessControl
+ * '''Input Parameters:'''
+   * none
+ * '''Return Values:'''
+   * true on success
+
+This can be a time-consuming operation.
+
+
 == Resources ==