Data Store Documentation Index
Configuration Reference Home

Hex String Attribute Syntax

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 Hex String Attribute Syntax defines a syntax for attribute values that are comprised of hexadecimal digits (i.e., the numeric digits 0 through 9 and the ASCII letters A through F). Values will be treated in a case-insensitive manner by default, but it is recommended (for better compaction efficiency) that clients not mix uppercase and lowercase characters within the same value.

Parent Component
Properties
dsconfig Usage

Parent Component

The Hex String Attribute Syntax component inherits from the Attribute Syntax

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ enabled ↓ require-binary-transfer
↓ java-class

Basic Properties

enabled

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

java-class (Read-Only)

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


Advanced Properties

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 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.


dsconfig Usage

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}] ...