Express (Distributed operating systems), v8.0 > Secure applications and their environment > Authenticate users > Select a registry or repository > Manage realms in a federated repository > Virtual member manager > Reference > Program model > Control DataObject
RequestControl DataObject
RequestControl can be passed in the input data object of an API to indicate how the adapter handles the request and to check the status of an asynchronous call.
RequestControl is passed in the input data object of an API call. It is used to check the status of an asynchronous call using the ticket received in the ResponseControl. RequestControl is also used to indicate how the adapter handles the request using the “requiredInteractionStyle” property
The structure of a RequestControl data object consists of:
abandon
is a boolean property that if set to true enables an application call to end an asynchronous operation. The default setting is false.
ticket
is a string that the caller is not required to interpret. After the call is completed, the complete flag is set to true and the returned data object contains the result of the call.
requiredInteractionStyle
indicates how the adapter is to handle the request:
sync
synchronous
async
asynchronous
syncOrAsync
synchronous or asynchronous
XML schema definition
The following is the XML schema definition for the RequestControl DataObject.
<xsd:complexType name="RequestControl"> <xsd:complexContent> <xsd:extension base="Control"> <!-- supported interaction styles are: sync, async, and syncOrAsync --> <xsd:attribute name="requiredInteractionStyle" type="xsd:token"/> <xsd:attribute name="ticket" type="xsd:string"/> </xsd:extension> </xsd:complexContent> </xsd:complexType>
Sample data objects
Following is a sample RequestControl data object. It is used to check the status of the asynchronous call using the ticket.
<wim:controls xsi:type="wim:RequestControl" ticket="AsyncLDAP1:1113940307424:-1278154994"/>
Parent topic: Control DataObject