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 |
---|---|
ServerConfigurationManager.Policy |
getContentVersionRequests()
Deprecated.
use
getUpdatePolicy() , which provides more alternatives |
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 |
setContentVersionRequests(ServerConfigurationManager.Policy policy)
Deprecated.
use
setUpdatePolicy(UpdatePolicy) , which provides more alternatives |
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
void writeConfiguration() throws FailedRequestException, ResourceNotFoundException, ResourceNotResendableException, ForbiddenUserException
Boolean getQueryOptionValidation()
void setQueryOptionValidation(Boolean on)
on
- set to true to validate the query optionsBoolean getQueryValidation()
void setQueryValidation(Boolean on)
on
- set to true to validate queriesString getDefaultDocumentReadTransform()
void setDefaultDocumentReadTransform(String name)
name
- the default transform nameBoolean getDefaultDocumentReadTransformAll()
void setDefaultDocumentReadTransformAll(Boolean on)
on
- true to apply the default read transform to all usersBoolean getServerRequestLogging()
void setServerRequestLogging(Boolean on)
on
- true to log requests on the serverServerConfigurationManager.UpdatePolicy getUpdatePolicy()
void setUpdatePolicy(ServerConfigurationManager.UpdatePolicy policy)
policy
- the policy controlling updates or deletesServerConfigurationManager.Policy getContentVersionRequests()
getUpdatePolicy()
, which provides more alternativesvoid setContentVersionRequests(ServerConfigurationManager.Policy policy)
setUpdatePolicy(UpdatePolicy)
, which provides more alternativespolicy
- required, optional, or none for document versionsQueryOptionsManager newQueryOptionsManager()
NamespacesManager newNamespacesManager()
ResourceExtensionsManager newResourceExtensionsManager()
TransformExtensionsManager newTransformExtensionsManager()
ExtensionLibrariesManager newExtensionLibrariesManager()
Copyright © 2013-2016 MarkLogic Corporation.