Class CoreSchemaCfgDefn
- java.lang.Object
-
- org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
-
- org.forgerock.opendj.config.ManagedObjectDefinition<CoreSchemaCfgClient,CoreSchemaCfg>
-
- org.forgerock.opendj.server.config.meta.CoreSchemaCfgDefn
-
public final class CoreSchemaCfgDefn extends ManagedObjectDefinition<CoreSchemaCfgClient,CoreSchemaCfg>
An interface for querying the Core Schema managed object definition meta information.Core Schema define the core schema elements to load.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CoreSchemaCfgDefn.JsonValidationPolicy
Defines the set of permissable values for the "json-validation-policy" property.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description CoreSchemaCfgClient
createClientConfiguration(ManagedObject<? extends CoreSchemaCfgClient> impl)
Creates a client configuration view of the provided managed object.CoreSchemaCfg
createServerConfiguration(ServerManagedObject<? extends CoreSchemaCfg> impl)
Creates a server configuration view of the provided server managed object.BooleanPropertyDefinition
getAllowAttributeTypesWithNoSupOrSyntaxPropertyDefinition()
Get the "allow-attribute-types-with-no-sup-or-syntax" property definition.BooleanPropertyDefinition
getAllowZeroLengthValuesDirectoryStringPropertyDefinition()
Get the "allow-zero-length-values-directory-string" property definition.StringPropertyDefinition
getDisabledMatchingRulePropertyDefinition()
Get the "disabled-matching-rule" property definition.StringPropertyDefinition
getDisabledSyntaxPropertyDefinition()
Get the "disabled-syntax" property definition.BooleanPropertyDefinition
getEnabledPropertyDefinition()
Get the "enabled" property definition.static CoreSchemaCfgDefn
getInstance()
Get the Core Schema configuration definition singleton.ClassPropertyDefinition
getJavaClassPropertyDefinition()
Get the "java-class" property definition.EnumPropertyDefinition<CoreSchemaCfgDefn.JsonValidationPolicy>
getJsonValidationPolicyPropertyDefinition()
Get the "json-validation-policy" property definition.Class<CoreSchemaCfg>
getServerConfigurationClass()
Gets the server configuration class instance associated with this managed object definition.BooleanPropertyDefinition
getStrictFormatBooleanPropertyDefinition()
Get the "strict-format-boolean" property definition.BooleanPropertyDefinition
getStrictFormatCertificatesPropertyDefinition()
Get the "strict-format-certificates" property definition.BooleanPropertyDefinition
getStrictFormatCountryStringPropertyDefinition()
Get the "strict-format-country-string" property definition.BooleanPropertyDefinition
getStrictFormatJpegPhotosPropertyDefinition()
Get the "strict-format-jpeg-photos" property definition.BooleanPropertyDefinition
getStrictFormatTelephoneNumbersPropertyDefinition()
Get the "strict-format-telephone-numbers" property definition.BooleanPropertyDefinition
getStripSyntaxMinUpperBoundAttributeTypeDescriptionPropertyDefinition()
Get the "strip-syntax-min-upper-bound-attribute-type-description" property definition.-
Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString
-
-
-
-
Method Detail
-
getInstance
public static CoreSchemaCfgDefn getInstance()
Get the Core Schema configuration definition singleton.- Returns:
- Returns the Core Schema configuration definition singleton.
-
createClientConfiguration
public CoreSchemaCfgClient createClientConfiguration(ManagedObject<? extends CoreSchemaCfgClient> impl)
Description copied from class:ManagedObjectDefinition
Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.- Specified by:
createClientConfiguration
in classManagedObjectDefinition<CoreSchemaCfgClient,CoreSchemaCfg>
- Parameters:
impl
- The managed object.- Returns:
- Returns a client configuration view of the provided managed object.
-
createServerConfiguration
public CoreSchemaCfg createServerConfiguration(ServerManagedObject<? extends CoreSchemaCfg> impl)
Description copied from class:ManagedObjectDefinition
Creates a server configuration view of the provided server managed object.- Specified by:
createServerConfiguration
in classManagedObjectDefinition<CoreSchemaCfgClient,CoreSchemaCfg>
- Parameters:
impl
- The server managed object.- Returns:
- Returns a server configuration view of the provided server managed object.
-
getServerConfigurationClass
public Class<CoreSchemaCfg> getServerConfigurationClass()
Description copied from class:ManagedObjectDefinition
Gets the server configuration class instance associated with this managed object definition.- Specified by:
getServerConfigurationClass
in classManagedObjectDefinition<CoreSchemaCfgClient,CoreSchemaCfg>
- Returns:
- Returns the server configuration class instance associated with this managed object definition.
-
getAllowAttributeTypesWithNoSupOrSyntaxPropertyDefinition
public BooleanPropertyDefinition getAllowAttributeTypesWithNoSupOrSyntaxPropertyDefinition()
Get the "allow-attribute-types-with-no-sup-or-syntax" property definition.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.
- Returns:
- Returns the "allow-attribute-types-with-no-sup-or-syntax" property definition.
-
getAllowZeroLengthValuesDirectoryStringPropertyDefinition
public BooleanPropertyDefinition getAllowZeroLengthValuesDirectoryStringPropertyDefinition()
Get the "allow-zero-length-values-directory-string" property definition.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.
- Returns:
- Returns the "allow-zero-length-values-directory-string" property definition.
-
getDisabledMatchingRulePropertyDefinition
public StringPropertyDefinition getDisabledMatchingRulePropertyDefinition()
Get the "disabled-matching-rule" property definition.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.
- Returns:
- Returns the "disabled-matching-rule" property definition.
-
getDisabledSyntaxPropertyDefinition
public StringPropertyDefinition getDisabledSyntaxPropertyDefinition()
Get the "disabled-syntax" property definition.The set of disabled syntaxes.
Syntaxes must be specified using the syntax: OID, or use the default value 'NONE' to specify no value.
- Returns:
- Returns the "disabled-syntax" property definition.
-
getEnabledPropertyDefinition
public BooleanPropertyDefinition getEnabledPropertyDefinition()
Get the "enabled" property definition.Indicates whether the Core Schema is enabled for use.
- Returns:
- Returns the "enabled" property definition.
-
getJavaClassPropertyDefinition
public ClassPropertyDefinition getJavaClassPropertyDefinition()
Get the "java-class" property definition.Specifies the fully-qualified name of the Java class that provides the Core Schema implementation.
- Returns:
- Returns the "java-class" property definition.
-
getJsonValidationPolicyPropertyDefinition
public EnumPropertyDefinition<CoreSchemaCfgDefn.JsonValidationPolicy> getJsonValidationPolicyPropertyDefinition()
Get the "json-validation-policy" property definition.Specifies the policy that will be used when validating JSON syntax values.
- Returns:
- Returns the "json-validation-policy" property definition.
-
getStrictFormatBooleanPropertyDefinition
public BooleanPropertyDefinition getStrictFormatBooleanPropertyDefinition()
Get the "strict-format-boolean" property definition.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.
- Returns:
- Returns the "strict-format-boolean" property definition.
-
getStrictFormatCertificatesPropertyDefinition
public BooleanPropertyDefinition getStrictFormatCertificatesPropertyDefinition()
Get the "strict-format-certificates" property definition.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.
- Returns:
- Returns the "strict-format-certificates" property definition.
-
getStrictFormatCountryStringPropertyDefinition
public BooleanPropertyDefinition getStrictFormatCountryStringPropertyDefinition()
Get the "strict-format-country-string" property definition.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.
- Returns:
- Returns the "strict-format-country-string" property definition.
-
getStrictFormatJpegPhotosPropertyDefinition
public BooleanPropertyDefinition getStrictFormatJpegPhotosPropertyDefinition()
Get the "strict-format-jpeg-photos" property definition.Indicates whether to require JPEG values to strictly comply with the standard definition for this syntax.
- Returns:
- Returns the "strict-format-jpeg-photos" property definition.
-
getStrictFormatTelephoneNumbersPropertyDefinition
public BooleanPropertyDefinition getStrictFormatTelephoneNumbersPropertyDefinition()
Get the "strict-format-telephone-numbers" property definition.Indicates whether to require telephone number values to strictly comply with the standard definition for this syntax.
- Returns:
- Returns the "strict-format-telephone-numbers" property definition.
-
getStripSyntaxMinUpperBoundAttributeTypeDescriptionPropertyDefinition
public BooleanPropertyDefinition getStripSyntaxMinUpperBoundAttributeTypeDescriptionPropertyDefinition()
Get the "strip-syntax-min-upper-bound-attribute-type-description" property definition.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.
- Returns:
- Returns the "strip-syntax-min-upper-bound-attribute-type-description" property definition.
-
-