The CacheControl specifies whether the repository adapter cache should be cleared before an operation is performed and the mode of clearing the cache.
You can pass the CacheControl to the get(), search(), and update() methods of the application programming interface (API). The LDAP adapter uses the CacheControl to clear its cache; the other out-of-the-box adapters ignore the CacheControl as they do not have a cache. If you are using a custom adapter, you can implement its own handling for clearing cache using the CacheControl.
The CacheControl data object consists of the following attribute:
The XML schema definition for the CacheControl data object is shown here:
<xsd:complexType name="CacheControl">
<xsd:complexContent>
<xsd:extension base="Control">
<xsd:sequence>
<xsd:element name="mode" type="xsd:string" />
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
The following example shows a CacheControl data object:
<wim:Root>
<wim:entities xsi:type="wim:PersonAccount">
<wim:identifier uniqueName="cn=testUser1,dc=yourco,dc=com"/>
</wim:entities>
<wim:controls xsi:type="wim:CacheControl">
<wim:mode>clearEntity</wim:mode>
</wim:controls>
<wim:controls xsi:type="wim:PropertyControl">
<wim:properties>sn</wim:properties>
</wim:controls>
</wim:Root>