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
PropertyDefinitionControl DataObject
PropertyDefinitionControl is used to get the property definition of the specified properties in the specified repository
The PropertyDefinitionControl DataObject is extended from TypeControl and is used in the input data object of the getSchema method of SchemaService.
The structure of a PropertyDefinitionControl data object consists of:
repositoryId
is used to specify the ID of the repository in the virtual member manager configuration XML file. For example, if an LDAP server is configured in the virtual member manager configuration XML file with the ID LDAP1, you set the repositoryId to LDAP1 in the PropertyDefinitionControl. The getSchema method returns the properties schema for the repository LDAP1. If the repositoryId is not specified in the PropertyDefinitionControl, the properties schema in the virtual member manager level are returned.
propertyNames
contains the list of the properties that the caller wants to get the definition for. The property names need to be the qualified property names which mean they contain the namespace prefix. If the propertyNames property is not specified, all the properties defined for the specified entity type are returned.
entityTypeName
specifies the entity type. The entityTypeName also is a qualified name which means that it contains the namespace prefix of the entity type.
XML schema definition
The following is the XML schema definition for the PropertyDefinitionControl DataObject:
<xsd:complexType name="PropertyDefinitionControl"> <xsd:complexContent> <xsd:extension base="TypeControl"> <xsd:sequence> <xsd:element ref="propertyNames" minOccurs="0" maxOccurs="unbounded"/> </xsd:sequence> <xsd:attribute name="entityTypeName" type="xsd:token"/> </xsd:extension> </xsd:complexContent> </xsd:complexType>
Sample data object
The following is a sample PropertyDefinitionControl data object used in the getSchema operation to request all of the properties that the repository LDAP1 supports for the entity type PersonAccount:
<wim:controls xsi:type="wim:PropertyDefinitionControl" repositoryId="LDAP1" entityTypeName="PersonAccount"/>
Parent topic: Control DataObject