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
ChangeResponseControl DataObject
The ChangeReponseControl data object is returned to the client application with changed entities as the result of a search for changed entities using the ChangeControl data object.
This response control also returns the checkpoint to be used during a subsequent search for changed entities.
The structure of the ChangeResponseControl data object is described next.
checkPoint
defines the checkpoint for repositories configured in virtual member manager.
It is a list that contains the repositoryId and the repositoryCheckPoint. In the following example for IBM Tivoli Directory Server, TDS_LDAP is the repository ID for IBM Tivoli Directory Server and 21 is the checkpoint number for the configured LDAP.
There could be one or more instances of checkPoint in a ChangeResponseControl data object, depending on the number of repositories involved in a search.
XML schema definition
The XML schema definition for the ChangeResponseControl data object is shown here.
<xsd:complexType name=”ChangeResponseControl”> <xsd:complexContent> <xsd:extension base=”SearchResponseControl”> <xsd:sequence> <xsd:element name=”checkPoint” type=”wim:checkPointType” minOccurs="0" maxOccurs="unbounded"/> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType>
Sample data objects
The following example shows a ChangeResponseControl data object returned by the search API in a scenario where the TDS repository had 20 changes to be processed, and Active Directory had 40 changes to be processed.
<wim:controls xsi:type="wim:ChangeResponseControl"> <wim:checkPoint> <wim:repositoryId>TDS_LDAP </wim:repositoryId> <wim:repositoryCheckPoint>21 </wim:repositoryCheckPoint> </wim:checkPoint> <wim:checkPoint> <wim:repositoryId>AD_LDAP </wim:repositoryId> <wim:repositoryCheckPoint>41 </wim:repositoryCheckPoint> </wim:checkPoint> </wim:controls>
Parent topic: Control DataObject