org.opends.server.admin.std.client

Interface SchemaBackendCfgClient

All Superinterfaces:

BackendCfgClient, ConfigurationClient

public interface SchemaBackendCfgClient
extends BackendCfgClient

A client-side interface for reading and modifying Schema Backend settings.

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.

Method Summary

Methods

Modifier and Type	Method and Description
ManagedObjectDefinition<? extends SchemaBackendCfgClient,? extends SchemaBackendCfg>	definition() Get the configuration definition associated with this Schema Backend.
String	getJavaClass() Gets the "java-class" property.
SortedSet<DN>	getSchemaEntryDN() Gets the "schema-entry-dn" property.
BackendCfgDefn.WritabilityMode	getWritabilityMode() Gets the "writability-mode" property.
Boolean	isShowAllAttributes() Gets the "show-all-attributes" property.
void	setJavaClass(String value) Sets the "java-class" property.
void	setSchemaEntryDN(Collection<DN> values) Sets the "schema-entry-dn" property.
void	setShowAllAttributes(boolean value) Sets the "show-all-attributes" property.
void	setWritabilityMode(BackendCfgDefn.WritabilityMode value) Sets the "writability-mode" property.

Methods inherited from interface org.opends.server.admin.std.client.BackendCfgClient

getBackendId, getBaseDN, isEnabled, setBackendId, setBaseDN, setEnabled

Methods inherited from interface org.opends.server.admin.ConfigurationClient

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends SchemaBackendCfgClient,? extends SchemaBackendCfg> definition()

Get the configuration definition associated with this Schema Backend.

Specified by:

definition in interface BackendCfgClient

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Schema Backend.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the backend implementation.

Specified by:

getJavaClass in interface BackendCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(String value)
                  throws PropertyException

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the backend implementation.

Specified by:

setJavaClass in interface BackendCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.

getSchemaEntryDN

SortedSet<DN> getSchemaEntryDN()

Gets the "schema-entry-dn" property.

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.

Returns:

Returns the values of the "schema-entry-dn" property.

setSchemaEntryDN

void setSchemaEntryDN(Collection<DN> values)
                      throws PropertyException

Sets the "schema-entry-dn" property.

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.

Parameters:

values - The values of the "schema-entry-dn" property.

Throws:

PropertyException - If one or more of the new values are invalid.

isShowAllAttributes

Boolean isShowAllAttributes()

Gets the "show-all-attributes" property.

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.

Returns:

Returns the value of the "show-all-attributes" property.

setShowAllAttributes

void setShowAllAttributes(boolean value)
                          throws PropertyException

Sets the "show-all-attributes" property.

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.

Parameters:

value - The value of the "show-all-attributes" property.

Throws:

PropertyException - If the new value is invalid.

getWritabilityMode

BackendCfgDefn.WritabilityMode getWritabilityMode()

Gets the "writability-mode" property.

Specifies the behavior that the backend should use when processing write operations.

Specified by:

getWritabilityMode in interface BackendCfgClient

Returns:

Returns the value of the "writability-mode" property.

setWritabilityMode

void setWritabilityMode(BackendCfgDefn.WritabilityMode value)
                        throws PropertyException

Sets the "writability-mode" property.

Specifies the behavior that the backend should use when processing write operations.

Specified by:

setWritabilityMode in interface BackendCfgClient

Parameters:

value - The value of the "writability-mode" property.

Throws:

PropertyException - If the new value is invalid.