Package org.forgerock.opendj.server.config.client

Interface RootDseBackendCfgClient

All Superinterfaces:
ConfigurationClient
public interface RootDseBackendCfgClient extends ConfigurationClient
A client-side interface for reading and modifying Root DSE Backend settings.

The Root DSE Backend contains the directory server root DSE.

  • Method Details

    • definition

      ManagedObjectDefinition<? extends RootDseBackendCfgClient,? extends RootDseBackendCfg> definition()
      Get the configuration definition associated with this Root DSE Backend.
      Specified by:
      definition in interface ConfigurationClient
      Returns:
      Returns the configuration definition associated with this Root DSE Backend.

    • isShowAllAttributes

      @MandatoryProperty ValueOrExpression<Boolean> isShowAllAttributes()
      Gets the "show-all-attributes" property.

      Indicates whether all attributes in the root DSE are to be treated like user attributes (and therefore returned to clients by default) regardless of the directory server schema configuration.

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

    • setShowAllAttributes

      @MandatoryProperty void setShowAllAttributes(ValueOrExpression<Boolean> value) throws PropertyException
      Sets the "show-all-attributes" property.

      Indicates whether all attributes in the root DSE are to be treated like user attributes (and therefore returned to clients by default) regardless of the directory server schema configuration.

      Parameters:
      value - The value of the "show-all-attributes" property.
      Throws:
      PropertyException - If the new value is invalid.

    • isShowSubordinateNamingContexts

      @MandatoryProperty ValueOrExpression<Boolean> isShowSubordinateNamingContexts()
      Gets the "show-subordinate-naming-contexts" property.

      Indicates whether subordinate naming contexts should be visible in the namingContexts attribute of the RootDSE. By default only top level naming contexts are visible

      Default value: false

      Returns:
      Returns the value of the "show-subordinate-naming-contexts" property.

    • setShowSubordinateNamingContexts

      @MandatoryProperty void setShowSubordinateNamingContexts(ValueOrExpression<Boolean> value) throws PropertyException
      Sets the "show-subordinate-naming-contexts" property.

      Indicates whether subordinate naming contexts should be visible in the namingContexts attribute of the RootDSE. By default only top level naming contexts are visible

      Parameters:
      value - The value of the "show-subordinate-naming-contexts" property.
      Throws:
      PropertyException - If the new value is invalid.