Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact UnboundID support for assistance if you believe that you have a need to create or modify this type of object.
Note: this is an abstract component that cannot be instantiated.
Attribute Syntaxes define the type of data that may be stored in an attribute with that syntax. A syntax is generally associated with a set of matching rules that indicate how to perform matching operations against values of that syntax.
↓Direct Subcomponents
↓Properties
↓dsconfig Usage
The following Attribute Syntaxes are available in the server :
These Attribute Syntaxes inherit from the properties described below.
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ enabled | ↓ require-binary-transfer |
| ↓ java-class |
| 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 |
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 delete an existing Attribute Syntax:
dsconfig delete-attribute-syntax
--syntax-name {name}