|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SchemaBackendCfgClient
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 | |
---|---|
ManagedObjectDefinition<? extends SchemaBackendCfgClient,? extends SchemaBackendCfg> |
definition()
Get the configuration definition associated with this Schema Backend. |
java.lang.String |
getJavaClass()
Gets the "java-class" property. |
java.util.SortedSet<DN> |
getSchemaEntryDN()
Gets the "schema-entry-dn" property. |
BackendCfgDefn.WritabilityMode |
getWritabilityMode()
Gets the "writability-mode" property. |
java.lang.Boolean |
isShowAllAttributes()
Gets the "show-all-attributes" property. |
void |
setJavaClass(java.lang.String value)
Sets the "java-class" property. |
void |
setSchemaEntryDN(java.util.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 |
---|
ManagedObjectDefinition<? extends SchemaBackendCfgClient,? extends SchemaBackendCfg> definition()
definition
in interface BackendCfgClient
definition
in interface ConfigurationClient
java.lang.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the backend implementation.
getJavaClass
in interface BackendCfgClient
void setJavaClass(java.lang.String value) throws IllegalPropertyValueException
Specifies the fully-qualified name of the Java class that provides the backend implementation.
setJavaClass
in interface BackendCfgClient
value
- The value of the "java-class" property.
IllegalPropertyValueException
- If the new value is invalid.java.util.SortedSet<DN> getSchemaEntryDN()
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.
void setSchemaEntryDN(java.util.Collection<DN> values) throws IllegalPropertyValueException
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.
values
- The values of the "schema-entry-dn" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.java.lang.Boolean isShowAllAttributes()
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.
void setShowAllAttributes(boolean value) throws IllegalPropertyValueException
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.
value
- The value of the "show-all-attributes" property.
IllegalPropertyValueException
- If the new value is invalid.BackendCfgDefn.WritabilityMode getWritabilityMode()
Specifies the behavior that the backend should use when processing write operations.
getWritabilityMode
in interface BackendCfgClient
void setWritabilityMode(BackendCfgDefn.WritabilityMode value) throws IllegalPropertyValueException
Specifies the behavior that the backend should use when processing write operations.
setWritabilityMode
in interface BackendCfgClient
value
- The value of the "writability-mode" property.
IllegalPropertyValueException
- If the new value is invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |