Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

InteractiveSBProxy

InteractiveSBProxy

 

Interactive ServiceBroker Interface

...

unmigrated-wiki-markup.

The following operations are supported. For a formal definition, please review the \[Service Description\|http://dexter.mit.edu/iLab_WSDL/I_ServiceBroker.asmx?WSDL\].

Wiki Markup
\* \[AgentCloseExperiment\|http://dexter.mit.edu/iLab_WSDL/I_ServiceBroker.asmx?op=AgentCloseExperiment\]
<span style="color: black">Agent to ServiceBroker call, coupon is from the original ExecuteExperiment collection and is used to route to the issueing SB. Closes an Experiment on the ServiceBroker, if an ESS is associated with this experiment the ESS experiment is closed so that no further ExperimentRecords or BLOBs can be written to the ESS.</span>

Wiki Markup
\* \[ClientCloseExperiment\|http://dexter.mit.edu/iLab_WSDL/I_ServiceBroker.asmx?op=ClientCloseExperiment\]
<span style="color: black">Client call that requests that the ServiceBroker Close an Experiment , if an ESS is associated with this experiment the ESS experiment is closed so that no further ExperimentRecords or BLOBs can be written to the ESS.</span>

Wiki Markup
\* \[CreateExperiment\|http://dexter.mit.edu/iLab_WSDL/I_ServiceBroker.asmx?op=CreateExperiment\]
<span style="color: black">Creates an Experiment on the ServiceBroker, if an ESS is associated with this experiment the ESS experiment is opened so that ExperimentRecords or BLOBs can be written to the ESS.</span>

Wiki Markup
\* \[DeleteClientData\|http://dexter.mit.edu/iLab_WSDL/I_ServiceBroker.asmx?op=DeleteClientData\]
<span style="color: black">removes an client item from the user's opaque data store</span>

Wiki Markup
\* \[GetAnnotation\|http://dexter.mit.edu/iLab_WSDL/I_ServiceBroker.asmx?op=GetAnnotation\]
<span style="color: black">Retrieves a previously saved experiment annotation.</span>

Wiki Markup
\* \[ListClientDataItems\|http://dexter.mit.edu/iLab_WSDL/I_ServiceBroker.asmx?op=ListClientDataItems\]
<span style="color: black">Enumerates the names of all client items in the user's opaque data store. This is performed for the user's current client as stored in the session state.</span>

Wiki Markup
\* \[LoadClientData\|http://dexter.mit.edu/iLab_WSDL/I_ServiceBroker.asmx?op=LoadClientData\]
<span style="color: black">returns the value of an client item in the user's opaque data store</span>

Wiki Markup
\* \[OpenExperiment\|http://dexter.mit.edu/iLab_WSDL/I_ServiceBroker.asmx?op=OpenExperiment\]
<span style="color: black">Opens an existing Experiment, if an ESS is associated with this experiment the ESS experiment is opened so that ExperimentRecords or BLOBs can be written to the ESS.</span>

Wiki Markup
\* \[RequestExperimentAccess\|http://dexter.mit.edu/iLab_WSDL/I_ServiceBroker.asmx?op=RequestExperimentAccess\]
<span style="color: black">Uses the credentials granted the experiment specified by the opHeader to check access to the requested experiment, if allowed a new ticket collection is started to access the requested experiment and optional ESS records. Returns null if access denied.</span>

Wiki Markup
\* \[RetrieveExperiment\|http://dexter.mit.edu/iLab_WSDL/I_ServiceBroker.asmx?op=RetrieveExperiment\]
<span style="color: black">Qualifies operation access and forwards request to the ESS</span>

Wiki Markup
\* \[RetrieveExperimentRecords\|http://dexter.mit.edu/iLab_WSDL/I_ServiceBroker.asmx?op=RetrieveExperimentRecords\]
<span style="color: black">Uses the users qualifiers to select Experiment summaries, no write permissions are created. Valid field names include; userName, groupName, labServerName,clientName, scheduledStart,creationTime, status and experimentID.</span>

Wiki Markup
\* \[RetrieveExperimentSummary\|http://dexter.mit.edu/iLab_WSDL/I_ServiceBroker.asmx?op=RetrieveExperimentSummary\]
<span style="color: black">Uses the users qualifiers to select Experiment summaries, no write permissions are created. Valid field names include; userName, groupName, labServerName,clientName, scheduledStart,creationTime, status and experimentID.</span>

Wiki Markup
\* \[RevokeReservation\|http://dexter.mit.edu/iLab_WSDL/I_ServiceBroker.asmx?op=RevokeReservation\]
<span style="color: black">Revokes reservations that intersect the specifications, may be called from the LSS or USS, but normally is called from the USS.</span>

Wiki Markup
\* \[SaveClientData\|http://dexter.mit.edu/iLab_WSDL/I_ServiceBroker.asmx?op=SaveClientData\]
<span style="color: black">Sets a client item value in the user's opaque data store</span>

.

·         AgentCloseExperiment
Agent to ServiceBroker call, coupon is from the original ExecuteExperiment collection and is used to route to the issueing SB. Closes an Experiment on the ServiceBroker, if an ESS is associated with this experiment the ESS experiment is closed so that no further ExperimentRecords or BLOBs can be written to the ESS.

·         ClientCloseExperiment
Client call that requests that the ServiceBroker Close an Experiment , if an ESS is associated with this experiment the ESS experiment is closed so that no further ExperimentRecords or BLOBs can be written to the ESS.

·         CreateExperiment
Creates an Experiment on the ServiceBroker, if an ESS is associated with this experiment the ESS experiment is opened so that ExperimentRecords or BLOBs can be written to the ESS.

·         DeleteClientData
removes an client item from the user's opaque data store

·         GetAnnotation
Retrieves a previously saved experiment annotation.

·         ListClientDataItems
Enumerates the names of all client items in the user's opaque data store. This is performed for the user's current client as stored in the session state.

·         LoadClientData
returns the value of an client item in the user's opaque data store

·         OpenExperiment
Opens an existing Experiment, if an ESS is associated with this experiment the ESS experiment is opened so that ExperimentRecords or BLOBs can be written to the ESS.

·         RequestExperimentAccess
Uses the credentials granted the experiment specified by the opHeader to check access to the requested experiment, if allowed a new ticket collection is started to access the requested experiment and optional ESS records. Returns null if access denied.

·         RetrieveExperiment
Qualifies operation access and forwards request to the ESS

·         RetrieveExperimentRecords
Uses the users qualifiers to select Experiment summaries, no write permissions are created. Valid field names include; userName, groupName, labServerName,clientName, scheduledStart,creationTime, status and experimentID.

·         RetrieveExperimentSummary
Uses the users qualifiers to select Experiment summaries, no write permissions are created. Valid field names include; userName, groupName, labServerName,clientName, scheduledStart,creationTime, status and experimentID.

·         RevokeReservation
Revokes reservations that intersect the specifications, may be called from the LSS or USS, but normally is called from the USS.

·         SaveClientData
Sets a client item value in the user's opaque data store

·         SetAnnotation
Saves or modifies an optional user defined annotation to the experiment record. Wiki Markup\* \[SetAnnotation\|http://dexter.mit.edu/iLab_WSDL/I_ServiceBroker.asmx?op=SetAnnotation\] <span style="color: black">Saves or modifies an optional user defined annotation to the experiment record.</span>