Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact UnboundID support in order to understand the potential impact of that change.
The Boolean Attribute Syntax defines a syntax for attribute values that can hold Boolean values of "TRUE" or "FALSE".
In most cases, values of attributes with a Boolean syntax can be compacted to a single byte. Although the strict definition of the syntax requires values of either TRUE or FALSE, the compaction process will preserve case for any of the following forms:
↓Parent Component
↓Properties
↓dsconfig Usage
The Boolean Attribute Syntax component inherits from the Attribute Syntax
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ enabled | ↓ enable-compaction |
| ↓ java-class | ↓ include-attribute-in-compaction |
| ↓ exclude-attribute-from-compaction | |
| ↓ require-binary-transfer |
| Description | Indicates whether the Attribute Syntax is enabled. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the fully-qualified name of the Java class that provides the Attribute Syntax implementation. |
| Default Value | None |
| Allowed Values | The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.api.AttributeSyntax |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
enable-compaction (Advanced Property)
| Description | Indicates whether values of attributes with this syntax should be compacted when stored in a local DB database. Compacted attribute values may consume less space on disk and in memory, but it is possible that the compaction performed by some attribute syntaxes may result in values that are logically equivalent to the original values but differ in some cosmetic manner (e.g., different capitalization, loss of insignificant spaces, etc.). If client applications are not tolerant of this possibility, then it is recommended that compaction be disabled for attribute syntaxes that are known to have the possibility of introducing such cosmetic differences. Changes to compaction settings will take effect for subsequent writes performed in the server. If you wish to have the changes applied immediately, you may export the data to LDIF and re-import, or you may use the re-encode entries task. If compaction is enabled, then by default all attributes with this syntax will be compacted, unless one or more values are specified for either include-attribute-in-compaction or exclude-attribute-from-compaction. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
include-attribute-in-compaction (Advanced Property)
| Description | Specifies the specific attributes (which should be associated with this syntax) whose values should be compacted. If one or more include attributes are specified, then only those attributes will have their values compacted. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
exclude-attribute-from-compaction (Advanced Property)
| Description | Specifies the specific attributes (which should be associated with this syntax) whose values should not be compacted. If one or more exclude attributes are specified, then values of those attributes will not have their values compacted. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
require-binary-transfer (Advanced Property)
| Description | Indicates whether values of this attribute are required to have a "binary" transfer option as described in RFC 4522. Attributes with this syntax will generally be referenced with names including ";binary" (e.g., "userCertificate;binary"). |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | The Identity Data Store must be restarted for changes to this setting to take effect. Changes to this property will take effect immediately for new attribute type definitions created after the change, but the change will not take effect for existing attributes with this syntax until the server is restarted. |
To list the configured Attribute Syntaxes:
dsconfig list-attribute-syntaxes
[--property {propertyName}] ...
To view the configuration for an existing Attribute Syntax:
dsconfig get-attribute-syntax-prop
--syntax-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Attribute Syntax:
dsconfig set-attribute-syntax-prop
--syntax-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Boolean Attribute Syntax:
dsconfig create-attribute-syntax
--syntax-name {name}
--type boolean
--set enabled:{propertyValue}
--set java-class:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Attribute Syntax:
dsconfig delete-attribute-syntax
--syntax-name {name}