public interface ServerConfigurationManager
The ServerConfigurationManager reads and writes the configurable properties of the server.
| Modifier and Type | Interface and Description |
|---|---|
static class |
ServerConfigurationManager.Policy
Specifies the policy for use of a capability.
|
static class |
ServerConfigurationManager.UpdatePolicy
Specifies the policy for updating documents in the database.
|
| Modifier and Type | Method and Description |
|---|---|
String |
getDefaultDocumentReadTransform()
Returns the name of the default transform for reading documents.
|
Boolean |
getDefaultDocumentReadTransformAll()
Returns whether the default transform for reading documents applies to all users or only users with the rest-reader role.
|
Boolean |
getQueryOptionValidation()
Returns whether the server validates query options before storing them.
|
Boolean |
getQueryValidation()
Returns whether the server validates queries before running them.
|
Boolean |
getServerRequestLogging()
Returns whether the server logs requests to the error log on the server.
|
ServerConfigurationManager.UpdatePolicy |
getUpdatePolicy()
Returns the policy for updating or deleting documents in the database.
|
ExtensionLibrariesManager |
newExtensionLibrariesManager()
Creates a manager for writing and reading assets in the REST server’s modules database.
|
NamespacesManager |
newNamespacesManager()
Creates a manager for listing, reading, writing, and deleting namespace bindings.
|
QueryOptionsManager |
newQueryOptionsManager()
Creates a manager for listing, reading, writing, and deleting query options.
|
ResourceExtensionsManager |
newResourceExtensionsManager()
Creates a manager for listing, reading, writing, and deleting resource service extensions.
|
TransformExtensionsManager |
newTransformExtensionsManager()
Creates a manager for listing, reading, writing, and deleting transform extensions.
|
void |
readConfiguration()
Reads the values of the properties from the server into this object.
|
void |
setDefaultDocumentReadTransform(String name)
Specifies the name of the default transform for reading documents.
|
void |
setDefaultDocumentReadTransformAll(Boolean on)
Specifies whether the default transform for reading documents applies to all users or only users with the rest-reader role.
|
void |
setQueryOptionValidation(Boolean on)
Specifies whether the server validates query options before storing them.
|
void |
setQueryValidation(Boolean on)
Specifies whether the server validates queries before running them.
|
void |
setServerRequestLogging(Boolean on)
Specifies whether the server logs requests to the error log on the server.
|
void |
setUpdatePolicy(ServerConfigurationManager.UpdatePolicy policy)
Specifies the policy for updating or deleting documents in the database.
|
void |
writeConfiguration()
Writes the values of the properties of this object to the server.
|
void readConfiguration()
throws FailedRequestException,
ForbiddenUserException
Reads the values of the properties from the server into this object.
void writeConfiguration()
throws FailedRequestException,
ResourceNotFoundException,
ResourceNotResendableException,
ForbiddenUserException
Writes the values of the properties of this object to the server.
Boolean getQueryOptionValidation()
Returns whether the server validates query options before storing them.
void setQueryOptionValidation(Boolean on)
Specifies whether the server validates query options before storing them.
on - set to true to validate the query optionsBoolean getQueryValidation()
Returns whether the server validates queries before running them.
void setQueryValidation(Boolean on)
Specifies whether the server validates queries before running them.
on - set to true to validate queriesString getDefaultDocumentReadTransform()
Returns the name of the default transform for reading documents.
void setDefaultDocumentReadTransform(String name)
Specifies the name of the default transform for reading documents. The default transform is applied before any transform specified on the read request.
name - the default transform nameBoolean getDefaultDocumentReadTransformAll()
Returns whether the default transform for reading documents applies to all users or only users with the rest-reader role.
void setDefaultDocumentReadTransformAll(Boolean on)
Specifies whether the default transform for reading documents applies to all users or only users with the rest-reader role.
on - true to apply the default read transform to all usersBoolean getServerRequestLogging()
Returns whether the server logs requests to the error log on the server.
void setServerRequestLogging(Boolean on)
Specifies whether the server logs requests to the error log on the server.
on - true to log requests on the serverServerConfigurationManager.UpdatePolicy getUpdatePolicy()
Returns the policy for updating or deleting documents in the database.
void setUpdatePolicy(ServerConfigurationManager.UpdatePolicy policy)
Specifies the policy for updating or deleting documents in the database.
policy - the policy controlling updates or deletesQueryOptionsManager newQueryOptionsManager()
Creates a manager for listing, reading, writing, and deleting query options.
NamespacesManager newNamespacesManager()
Creates a manager for listing, reading, writing, and deleting namespace bindings.
ResourceExtensionsManager newResourceExtensionsManager()
Creates a manager for listing, reading, writing, and deleting resource service extensions.
TransformExtensionsManager newTransformExtensionsManager()
Creates a manager for listing, reading, writing, and deleting transform extensions.
ExtensionLibrariesManager newExtensionLibrariesManager()
Creates a manager for writing and reading assets in the REST server’s modules database.
Copyright © 2013-2017 MarkLogic Corporation.