Local Backend
This is an abstract object type that cannot be instantiated.
Local Backends are responsible for providing access to the underlying data presented by the server.
The data may be stored locally in an embedded database, remotely in an external system, or generated on the fly (for example, calculated from other information that is available).
Local Backends
The following Local Backends are available:
These Local Backends inherit the properties described below.
Parent
The Local Backend object inherits from Backend.
Local Backend Properties
You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.
| Basic Properties |
|---|
backend-id
Synopsis |
Specifies a name to identify the associated backend. |
Description |
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. |
Default Value |
None |
Allowed Values |
A string. |
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
Yes |
enabled
Synopsis |
Indicates whether the backend is enabled in the server. |
Description |
If a backend is not enabled, then its contents are not accessible when processing operations. |
Default Value |
None |
Allowed Values |
true false |
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
java-class
Synopsis |
Specifies the fully-qualified name of the Java class that provides the backend implementation. |
Default Value |
None |
Allowed Values |
A Java class that extends or implements:
|
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
The object must be disabled and re-enabled for changes to take effect. |
Advanced |
No |
Read-Only |
No |
writability-mode
Synopsis |
Specifies the behavior that the backend should use when processing write operations. |
Default Value |
None |
Allowed Values |
|
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |