Interface CoreSchemaCfg
-
- All Superinterfaces:
Configuration
,SchemaProviderCfg
public interface CoreSchemaCfg extends SchemaProviderCfg
A server-side interface for querying Core Schema settings.Core Schema define the core schema elements to load.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addCoreSchemaChangeListener(ConfigurationChangeListener<CoreSchemaCfg> listener)
Register to be notified when this Core Schema is changed.Class<? extends CoreSchemaCfg>
configurationClass()
Gets the configuration class associated with this Core Schema.SortedSet<String>
getDisabledMatchingRule()
Gets the "disabled-matching-rule" property.SortedSet<String>
getDisabledSyntax()
Gets the "disabled-syntax" property.String
getJavaClass()
Gets the "java-class" property.CoreSchemaCfgDefn.JsonValidationPolicy
getJsonValidationPolicy()
Gets the "json-validation-policy" property.boolean
isAllowAttributeTypesWithNoSupOrSyntax()
Gets the "allow-attribute-types-with-no-sup-or-syntax" property.boolean
isAllowZeroLengthValuesDirectoryString()
Gets the "allow-zero-length-values-directory-string" property.boolean
isStrictFormatBoolean()
Gets the "strict-format-boolean" property.boolean
isStrictFormatCertificates()
Gets the "strict-format-certificates" property.boolean
isStrictFormatCountryString()
Gets the "strict-format-country-string" property.boolean
isStrictFormatJpegPhotos()
Gets the "strict-format-jpeg-photos" property.boolean
isStrictFormatTelephoneNumbers()
Gets the "strict-format-telephone-numbers" property.boolean
isStripSyntaxMinUpperBoundAttributeTypeDescription()
Gets the "strip-syntax-min-upper-bound-attribute-type-description" property.void
removeCoreSchemaChangeListener(ConfigurationChangeListener<CoreSchemaCfg> listener)
Deregister an existing Core Schema configuration change listener.-
Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name
-
Methods inherited from interface org.forgerock.opendj.server.config.server.SchemaProviderCfg
addChangeListener, isEnabled, removeChangeListener
-
-
-
-
Method Detail
-
configurationClass
Class<? extends CoreSchemaCfg> configurationClass()
Gets the configuration class associated with this Core Schema.- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfaceSchemaProviderCfg
- Returns:
- Returns the configuration class associated with this Core Schema.
-
addCoreSchemaChangeListener
void addCoreSchemaChangeListener(ConfigurationChangeListener<CoreSchemaCfg> listener)
Register to be notified when this Core Schema is changed.- Parameters:
listener
- The Core Schema configuration change listener.
-
removeCoreSchemaChangeListener
void removeCoreSchemaChangeListener(ConfigurationChangeListener<CoreSchemaCfg> listener)
Deregister an existing Core Schema configuration change listener.- Parameters:
listener
- The Core Schema configuration change listener.
-
isAllowAttributeTypesWithNoSupOrSyntax
boolean isAllowAttributeTypesWithNoSupOrSyntax()
Gets the "allow-attribute-types-with-no-sup-or-syntax" property.Indicates whether the schema should allow attribute type definitions that do not declare a superior attribute type or syntax
When set to true, invalid attribute type definitions will use the default syntax.
Default value:
true
- Returns:
- Returns the value of the "allow-attribute-types-with-no-sup-or-syntax" property.
-
isAllowZeroLengthValuesDirectoryString
boolean isAllowZeroLengthValuesDirectoryString()
Gets the "allow-zero-length-values-directory-string" property.Indicates whether zero-length (that is, an empty string) values are allowed for directory string.
This is technically not allowed by the revised LDAPv3 specification, but some environments may require it for backward compatibility with servers that do allow it.
Default value:
false
- Returns:
- Returns the value of the "allow-zero-length-values-directory-string" property.
-
getDisabledMatchingRule
SortedSet<String> getDisabledMatchingRule()
Gets the "disabled-matching-rule" property.The set of disabled matching rules.
Matching rules must be specified using the syntax: OID, or use the default value 'NONE' to specify no value.
Default value:
NONE
- Returns:
- Returns an unmodifiable set containing the values of the "disabled-matching-rule" property.
-
getDisabledSyntax
SortedSet<String> getDisabledSyntax()
Gets the "disabled-syntax" property.The set of disabled syntaxes.
Syntaxes must be specified using the syntax: OID, or use the default value 'NONE' to specify no value.
Default value:
NONE
- Returns:
- Returns an unmodifiable set containing the values of the "disabled-syntax" property.
-
getJavaClass
String getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the Core Schema implementation.
Default value:
org.opends.server.schema.CoreSchemaProvider
- Specified by:
getJavaClass
in interfaceSchemaProviderCfg
- Returns:
- Returns the value of the "java-class" property.
-
getJsonValidationPolicy
CoreSchemaCfgDefn.JsonValidationPolicy getJsonValidationPolicy()
Gets the "json-validation-policy" property.Specifies the policy that will be used when validating JSON syntax values.
Default value:
strict
- Returns:
- Returns the value of the "json-validation-policy" property.
-
isStrictFormatBoolean
boolean isStrictFormatBoolean()
Gets the "strict-format-boolean" property.Indicates whether boolean values are required to strictly comply with the standard definition for this syntax.
When set to true, only "TRUE" and "FALSE" will be acceptable, per RFC 4517. When set to false, the server will accept true/false, yes/no, 1/0, on/off.
Default value:
false
- Returns:
- Returns the value of the "strict-format-boolean" property.
-
isStrictFormatCertificates
boolean isStrictFormatCertificates()
Gets the "strict-format-certificates" property.Indicates whether X.509 Certificate values are required to strictly comply with the standard definition for this syntax.
When set to false, certificates will not be validated and, as a result any sequence of bytes will be acceptable.
Default value:
true
- Returns:
- Returns the value of the "strict-format-certificates" property.
-
isStrictFormatCountryString
boolean isStrictFormatCountryString()
Gets the "strict-format-country-string" property.Indicates whether country code values are required to strictly comply with the standard definition for this syntax.
When set to false, country codes will not be validated and, as a result any string containing 2 characters will be acceptable.
Default value:
true
- Returns:
- Returns the value of the "strict-format-country-string" property.
-
isStrictFormatJpegPhotos
boolean isStrictFormatJpegPhotos()
Gets the "strict-format-jpeg-photos" property.Indicates whether to require JPEG values to strictly comply with the standard definition for this syntax.
Default value:
false
- Returns:
- Returns the value of the "strict-format-jpeg-photos" property.
-
isStrictFormatTelephoneNumbers
boolean isStrictFormatTelephoneNumbers()
Gets the "strict-format-telephone-numbers" property.Indicates whether to require telephone number values to strictly comply with the standard definition for this syntax.
Default value:
false
- Returns:
- Returns the value of the "strict-format-telephone-numbers" property.
-
isStripSyntaxMinUpperBoundAttributeTypeDescription
boolean isStripSyntaxMinUpperBoundAttributeTypeDescription()
Gets the "strip-syntax-min-upper-bound-attribute-type-description" property.Indicates whether the suggested minimum upper bound appended to an attribute's syntax OID in it's schema definition Attribute Type Description is stripped off.
When retrieving the server's schema, some APIs (JNDI) fail in their syntax lookup methods, because they do not parse this value correctly. This configuration option allows the server to be configured to provide schema definitions these APIs can parse correctly.
Default value:
false
- Returns:
- Returns the value of the "strip-syntax-min-upper-bound-attribute-type-description" property.
-
-