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

Control is used for specifying the request and response control information in the API calls.

Control can be divided into two categories:

request control

The request control is sent from client to server within the input data object. It is used to specify and to request information. For example, property control is used to specify the properties of the entity to be returned. Group membership control is used to request the groups that the entity belongs to.

response control

The response control is sent from server to client within the output data object. Response control is used for sending back control information. For example, PageResponseControl is used for sending back the cookie to the client so that the client can send the cookie back to request next page.

The Control data object is at the top level of control hierarchy. All other controls are extended from it. The Control data object itself is abstract and is not directly used in a data graph.

The following list shows the inheritance relationship among control data objects:

• Control (abstract control)
  • PageResponseControl
  • PageControl
  • PropertyControl
    • SearchControl
      • LoginControl
      • HierarchyControl (abstract control)
        • AncestorControl
        • DescendantControl
        • GroupControl (abstract control)
          • GroupMemberControl
          • GroupMembershipControl

      • ChangeControl

  • SortControl
  • DeleteControl
  • TypeControl (abstract control)
    • DataTypeControl
    • EntityTypeControl
    • PropertyDefinitionControl
    • PropertyExtensionPropertyDefinitionControl

  • PropertyExtensionDataTypeControl
  • ResponseControl
  • RequestControl
  • SearchResponseControl
    • ChangeResponseControl

  • CheckGroupMembershipControl
  • ExternalNameControl

• PropertyControl DataObject
  PropertyControl is used to specify which properties of an entity are returned.
• DeleteControl DataObject
  The DeleteControl specifies whether to delete the descendants, if they exist, of a deleted entity.
• SearchControl DataObject
  SearchControl is used to specify the search criteria.
• SearchResponse Control
  SearchResponseControl extends from Control and indicates that additional search results have been found
• HierarchyControl DataObject
  HierarchyControl is an extension from the SearchControl data object.
• AncestorControl DataObject
  AncestorControl is used to request the ancestors of an entity.
• DescendantControl DataObject
  DescendantControl is used to request the descendants of an entity.
• GroupMembershipControl DataObject
  GroupMembershipControl is used in the input data object of both the get API and the update API.
• GroupMemberControl DataObject
  GroupMemberControl is used in the input data object of both the get API and the update API.
• CheckGroupMembershipControl DataObject
  CheckGroupMembershipControl verifies whether a group contains a specific member.
• PageControl DataObject
  PageControl enables the application to retrieve additional pages of search results.
• PageResponseControl DataObject
  PageResponseControl returns the requested search results along with a cookie to enable the requestor to get the next page.
• ChangeControl DataObject
  The ChangeControl data object provides a client application with the ability to query federated repositories for changed entities, such as new, modified, and deleted entities, from a specified checkpoint onwards.
• 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.
• SortControl DataObject
  SortControl specifies how the returned search results are to be sorted.
• ResponseControl DataObject
  ResponseControl is returned in the return data object of an API call.
• 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.
• LoginControl DataObject
  LoginControl enables multiple principal name authentication.
• TypeControl DataObject
  TypeControl is used to specify the repository ID.
• DataTypeControl DataObject
  DataTypeControl is used to specify which repository the caller wants to return the supported data type information.
• PropertyExtensionDataTypeControl DataObject
  PropertyExtensionDataTypeControl is used to get the supported data types of the virtual member manager property extension repository.
• PropertyDefinitionControl DataObject
  PropertyDefinitionControl is used to get the property definition of the specified properties in the specified repository
• PropertyExtensionPropertyDefinitionControl DataObject
  PropertyExtensionPropertyDefinitionControl is used to get the property definition of the specified properties in the virtual member manager property extension repository.
• EntityTypeControl DataObject
  EntityTypeControl is used to get the information for a specified entity type.

Parent topic: Program model

---

+

Search Tips   |   Advanced Search