public interface BackendCfgClient extends ConfigurationClient
Backends are responsible for providing access to the underlying data presented by the server.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends BackendCfgClient,? extends BackendCfg> |
definition()
Get the configuration definition associated with this Backend.
|
String |
getBackendId()
Gets the "backend-id" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
Boolean |
isEnabled()
Gets the "enabled" property.
|
void |
setBackendId(String value)
Sets the "backend-id" property.
|
void |
setEnabled(boolean value)
Sets the "enabled" property.
|
void |
setJavaClass(String value)
Sets the "java-class" property.
|
commit, properties
ManagedObjectDefinition<? extends BackendCfgClient,? extends BackendCfg> definition()
definition
in interface ConfigurationClient
String getBackendId()
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.
void setBackendId(String value) throws PropertyException, PropertyException
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.
This property is read-only and can only be modified during creation of a Backend.
value
- The value of the "backend-id" property.PropertyException
- If the new value is invalid.PropertyException
- If this Backend is not being initialized.Boolean isEnabled()
Indicates whether the backend is enabled in the server.
If a backend is not enabled, then its contents are not accessible when processing operations.
void setEnabled(boolean value) throws PropertyException
Indicates whether the backend is enabled in the server.
If a backend is not enabled, then its contents are not accessible when processing operations.
value
- The value of the "enabled" property.PropertyException
- If the new value is invalid.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the backend implementation.
void setJavaClass(String value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the backend implementation.
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.Copyright 2010-2020 ForgeRock AS.