public final class SchemaBackendCfgDefn extends ManagedObjectDefinition<SchemaBackendCfgClient,SchemaBackendCfg>
The Schema Backend provides access to the directory server schema information, including the attribute types, object classes, attribute syntaxes, matching rules, matching rule uses, DIT content rules, and DIT structure rules that it contains.
Modifier and Type | Method and Description |
---|---|
SchemaBackendCfgClient |
createClientConfiguration(ManagedObject<? extends SchemaBackendCfgClient> impl)
Creates a client configuration view of the provided managed object.
|
SchemaBackendCfg |
createServerConfiguration(ServerManagedObject<? extends SchemaBackendCfg> impl)
Creates a server configuration view of the provided server managed
object.
|
StringPropertyDefinition |
getBackendIdPropertyDefinition()
Get the "backend-id" property definition.
|
BooleanPropertyDefinition |
getEnabledPropertyDefinition()
Get the "enabled" property definition.
|
static SchemaBackendCfgDefn |
getInstance()
Get the Schema Backend configuration definition singleton.
|
ClassPropertyDefinition |
getJavaClassPropertyDefinition()
Get the "java-class" property definition.
|
DnPropertyDefinition |
getSchemaEntryDnPropertyDefinition()
Get the "schema-entry-dn" property definition.
|
Class<SchemaBackendCfg> |
getServerConfigurationClass()
Gets the server configuration class instance associated with this managed
object definition.
|
BooleanPropertyDefinition |
getShowAllAttributesPropertyDefinition()
Get the "show-all-attributes" property definition.
|
EnumPropertyDefinition<LocalBackendCfgDefn.WritabilityMode> |
getWritabilityModePropertyDefinition()
Get the "writability-mode" property definition.
|
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
public static SchemaBackendCfgDefn getInstance()
public SchemaBackendCfgClient createClientConfiguration(ManagedObject<? extends SchemaBackendCfgClient> impl)
ManagedObjectDefinition
createClientConfiguration
in class ManagedObjectDefinition<SchemaBackendCfgClient,SchemaBackendCfg>
impl
- The managed object.public SchemaBackendCfg createServerConfiguration(ServerManagedObject<? extends SchemaBackendCfg> impl)
ManagedObjectDefinition
createServerConfiguration
in class ManagedObjectDefinition<SchemaBackendCfgClient,SchemaBackendCfg>
impl
- The server managed object.public Class<SchemaBackendCfg> getServerConfigurationClass()
ManagedObjectDefinition
getServerConfigurationClass
in class ManagedObjectDefinition<SchemaBackendCfgClient,SchemaBackendCfg>
public StringPropertyDefinition getBackendIdPropertyDefinition()
Specifies a name to identify the associated backend.
The name must be unique among all backends in the server. The backend ID may not be altered after the backend is created in the server.
public BooleanPropertyDefinition getEnabledPropertyDefinition()
Indicates whether the backend is enabled in the server.
If a backend is not enabled, then its contents are not accessible when processing operations.
public ClassPropertyDefinition getJavaClassPropertyDefinition()
Specifies the fully-qualified name of the Java class that provides the backend implementation.
public DnPropertyDefinition getSchemaEntryDnPropertyDefinition()
Defines the base DNs of the subtrees in which the schema information is published in addition to the value included in the base-dn property.
The value provided in the base-dn property is the only one that appears in the subschemaSubentry operational attribute of the server's root DSE (which is necessary because that is a single-valued attribute) and as a virtual attribute in other entries. The schema-entry-dn attribute may be used to make the schema information available in other locations to accommodate certain client applications that have been hard-coded to expect the schema to reside in a specific location.
public BooleanPropertyDefinition getShowAllAttributesPropertyDefinition()
Indicates whether to treat all attributes in the schema entry as if they were user attributes regardless of their configuration.
This may provide compatibility with some applications that expect schema attributes like attributeTypes and objectClasses to be included by default even if they are not requested. Note that the ldapSyntaxes attribute is always treated as operational in order to avoid problems with attempts to modify the schema over protocol.
public EnumPropertyDefinition<LocalBackendCfgDefn.WritabilityMode> getWritabilityModePropertyDefinition()
Specifies the behavior that the backend should use when processing write operations.
Copyright 2010-2018 ForgeRock AS.