public interface ServerConfigurationManager
The ServerConfigurationManager reads and writes
the configurable properties of the server.
Nested Class Summary
Nested Classes
static
enum
Specifies the policy for use of a
capability.
static
enum
Specifies the policy for updating documents in
the database.
Method Summary
All Methods Instance Methods Abstract Methods
Returns the name of the default transform for
reading documents.
Returns whether the default transform for
reading documents applies to all users or only users with the
rest-reader role.
Returns whether the server validates query
options before storing them.
Returns whether the server validates queries
before running them.
Returns whether the server logs requests to the
error log on the server.
Returns the policy for updating or deleting
documents in the database.
Creates a manager for writing and reading assets
in the REST server's modules database.
Creates a manager for listing, reading, writing,
and deleting query options.
Creates a manager for listing, reading, writing,
and deleting resource service extensions.
Creates a manager for listing, reading, writing,
and deleting transform extensions.
void
Reads the values of the properties from the
server into this object.
void
Specifies the name of the default transform for
reading documents.
void
Specifies whether the default transform for
reading documents applies to all users or only users with the
rest-reader role.
void
Specifies whether the server validates query
options before storing them.
void
Specifies whether the server validates queries
before running them.
void
Specifies whether the server logs requests to
the error log on the server.
void
Specifies the policy for updating or deleting
documents in the database.
void
Writes the values of the properties of this
object to the server.
Method Details
readConfiguration
Reads the values of the properties from the
server into this object.
Throws:
FailedRequestException ForbiddenUserException
writeConfiguration
Writes the values of the properties of this
object to the server.
Throws:
FailedRequestException ResourceNotFoundException ResourceNotResendableException ForbiddenUserException
getQueryOptionValidation
Returns whether the server validates query
options before storing them.
Returns:
true if query options are validated
setQueryOptionValidation
void setQueryOptionValidation (Boolean on) Specifies whether the server validates query
options before storing them.
Parameters:
on - set to true to validate the query
options
getQueryValidation
Returns whether the server validates queries
before running them.
Returns:
true if queries are validated
setQueryValidation
void setQueryValidation (Boolean on) Specifies whether the server validates queries
before running them.
Parameters:
on - set to true to validate queries
getDefaultDocumentReadTransform
String getDefaultDocumentReadTransform ()
Returns the name of the default transform for
reading documents.
Returns:
the default transform name
setDefaultDocumentReadTransform
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.
Parameters:
name - the default transform name
getDefaultDocumentReadTransformAll
Boolean getDefaultDocumentReadTransformAll ()
Returns whether the default transform for
reading documents applies to all users or only users with the
rest-reader role.
Returns:
true if the default read transform applies to all users
setDefaultDocumentReadTransformAll
void setDefaultDocumentReadTransformAll (Boolean on) Specifies whether the default transform for
reading documents applies to all users or only users with the
rest-reader role.
Parameters:
on - true to apply the default read transform to
all users
getServerRequestLogging
Returns whether the server logs requests to the
error log on the server.
Returns:
true if the server logs requests
setServerRequestLogging
void setServerRequestLogging (Boolean on) Specifies whether the server logs requests to
the error log on the server.
Parameters:
on - true to log requests on the server
getUpdatePolicy
Returns the policy for updating or deleting
documents in the database.
Returns:
the policy controlling updates or deletes
setUpdatePolicy
Specifies the policy for updating or deleting
documents in the database.
Parameters:
policy - the policy controlling updates or
deletes
newQueryOptionsManager
Creates a manager for listing, reading, writing,
and deleting query options.
Returns:
a new manager for query options
newResourceExtensionsManager
Creates a manager for listing, reading, writing,
and deleting resource service extensions.
Returns:
a new manager for resource service extensions
newTransformExtensionsManager
Creates a manager for listing, reading, writing,
and deleting transform extensions.
Returns:
a new manager for transform extensions
newExtensionLibrariesManager
Creates a manager for writing and reading assets
in the REST server's modules database.
Returns:
The extensions manager.
Copyright (c) 2010-2025 Progress
Software Corporation and/or its subsidiaries or affiliates. All
Rights Reserved.