public interface ServerConfigurationManager
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 |
---|---|
java.lang.String |
getDefaultDocumentReadTransform()
Returns the name of the default transform for reading documents.
|
java.lang.Boolean |
getDefaultDocumentReadTransformAll()
Returns whether the default transform for reading documents
applies to all users or only users with the rest-reader role.
|
java.lang.Boolean |
getQueryOptionValidation()
Returns whether the server validates query options before storing them.
|
java.lang.Boolean |
getQueryValidation()
Returns whether the server validates queries before running them.
|
java.lang.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()
Deprecated.
|
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(java.lang.String name)
Specifies the name of the default transform for reading documents.
|
void |
setDefaultDocumentReadTransformAll(java.lang.Boolean on)
Specifies whether the default transform for reading documents
applies to all users or only users with the rest-reader role.
|
void |
setQueryOptionValidation(java.lang.Boolean on)
Specifies whether the server validates query options before storing them.
|
void |
setQueryValidation(java.lang.Boolean on)
Specifies whether the server validates queries before running them.
|
void |
setServerRequestLogging(java.lang.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
void writeConfiguration() throws FailedRequestException, ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException
java.lang.Boolean getQueryOptionValidation()
void setQueryOptionValidation(java.lang.Boolean on)
on
- set to true to validate the query optionsjava.lang.Boolean getQueryValidation()
void setQueryValidation(java.lang.Boolean on)
on
- set to true to validate queriesjava.lang.String getDefaultDocumentReadTransform()
void setDefaultDocumentReadTransform(java.lang.String name)
name
- the default transform namejava.lang.Boolean getDefaultDocumentReadTransformAll()
void setDefaultDocumentReadTransformAll(java.lang.Boolean on)
on
- true to apply the default read transform to all usersjava.lang.Boolean getServerRequestLogging()
void setServerRequestLogging(java.lang.Boolean on)
on
- true to log requests on the serverServerConfigurationManager.UpdatePolicy getUpdatePolicy()
void setUpdatePolicy(ServerConfigurationManager.UpdatePolicy policy)
policy
- the policy controlling updates or deletesQueryOptionsManager newQueryOptionsManager()
@Deprecated NamespacesManager newNamespacesManager()
ResourceExtensionsManager newResourceExtensionsManager()
TransformExtensionsManager newTransformExtensionsManager()
ExtensionLibrariesManager newExtensionLibrariesManager()
Copyright © 2013-2020 MarkLogic Corporation.