Interface MonitorBackendCfgClient
-
- All Superinterfaces:
BackendCfgClient,ConfigurationClient,LocalBackendCfgClient
public interface MonitorBackendCfgClient extends LocalBackendCfgClient
A client-side interface for reading and modifying Monitor Backend settings.The Monitor Backend allows clients to access the information made available by directory server monitor providers.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ManagedObjectDefinition<? extends MonitorBackendCfgClient,? extends MonitorBackendCfg>definition()Get the configuration definition associated with this Monitor Backend.ValueOrExpression<String>getJavaClass()Gets the "java-class" property.ValueOrExpression<LocalBackendCfgDefn.WritabilityMode>getWritabilityMode()Gets the "writability-mode" property.voidsetJavaClass(ValueOrExpression<String> value)Sets the "java-class" property.voidsetWritabilityMode(ValueOrExpression<LocalBackendCfgDefn.WritabilityMode> value)Sets the "writability-mode" property.-
Methods inherited from interface org.forgerock.opendj.server.config.client.BackendCfgClient
getBackendId, isEnabled, setBackendId, setEnabled
-
Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient
commit, properties
-
-
-
-
Method Detail
-
definition
ManagedObjectDefinition<? extends MonitorBackendCfgClient,? extends MonitorBackendCfg> definition()
Get the configuration definition associated with this Monitor Backend.- Specified by:
definitionin interfaceBackendCfgClient- Specified by:
definitionin interfaceConfigurationClient- Specified by:
definitionin interfaceLocalBackendCfgClient- Returns:
- Returns the configuration definition associated with this Monitor Backend.
-
getJavaClass
@MandatoryProperty ValueOrExpression<String> getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the backend implementation.
Default value:
org.opends.server.backends.MonitorBackend- Specified by:
getJavaClassin interfaceBackendCfgClient- Returns:
- Returns the value of the "java-class" property.
-
setJavaClass
@MandatoryProperty void setJavaClass(ValueOrExpression<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:
setJavaClassin interfaceBackendCfgClient- Parameters:
value- The value of the "java-class" property.- Throws:
PropertyException- If the new value is invalid.
-
getWritabilityMode
@MandatoryProperty ValueOrExpression<LocalBackendCfgDefn.WritabilityMode> getWritabilityMode()
Gets the "writability-mode" property.Specifies the behavior that the backend should use when processing write operations.
Default value:
disabled- Specified by:
getWritabilityModein interfaceLocalBackendCfgClient- Returns:
- Returns the value of the "writability-mode" property.
-
setWritabilityMode
@MandatoryProperty void setWritabilityMode(ValueOrExpression<LocalBackendCfgDefn.WritabilityMode> value) throws PropertyException
Sets the "writability-mode" property.Specifies the behavior that the backend should use when processing write operations.
- Specified by:
setWritabilityModein interfaceLocalBackendCfgClient- Parameters:
value- The value of the "writability-mode" property.- Throws:
PropertyException- If the new value is invalid.
-
-