MarkLogic Server 11.0 Product Documentation

Java Application Developer's Guide — Chapter 13

Creating a Server Configuration Manager Object

Using a com.marklogic.client.DatabaseClient object, call newServerConfigManager()

DatabaseClient client = DatabaseClientFactory.newClient(...);

// create a manager for server configuration
ServerConfigurationManager configMgr =
                           client.newServerConfigManager();

Your application only needs one active ServerConfigurationManager at any time.

Reading and Writing Server Configuration Properties

Use com.marklogic.client.admin.ServerConfigurationManager to manage server configuration properties. To read the current server configuration values into the ServerConfigurationManager object, do:

configMgr.readConfiguration();

If your application changes these values, they will not persist unless written out to the server. To write the REST Server Configuration values to the server, do:

configMgr.writeConfiguration();

REST Server Properties

com.marklogic.client.admin.ServerConfigurationManager objects have get and set methods for the following server properties:

• ContentVersionRequests: Deprecated. Use UpdatePolicy instead.
• DefaultDocumentReadTransform: Name of the default transform applied to documents as they are read from the server. For information about document transforms, see Content Transformations.
• QueryOptionsValidation: Boolean specifying whether the server validates query options before storing them in configurations. For information about query options, see Query Options.
• ServerRequestLogging: Boolean specifying whether the REST Server logs requests to the MarkLogic Server error log (ErrorLog.txt). For performance reasons, you should only enable this when debugging your application. For information about logging, see Logging.
• UpdatePolicy: Value from the ServerConfigurationManager.UpdatePolicy enum specifying whether the system tries to detect if a document is fresh or not via use of an opaque numeric identifier and whether to merge or overwrite metadata on update. For more information, see Optimistic Locking.

Creating New Server-Related Manager Objects

Most manager objects described so far handle access to the database and its content, and accordingly are created via a method on a DatabaseClient object. The following managers handle listing, reading, writing, and deleting REST Server data and settings, rather than those of the database. Therefore, these managers are created by factory methods on a ServerConfigurationManager instead of a DatabaseClient.

The ServerConfigurationManager associated managers are:

• NamespaceManager: Namespace bindings. For details about namespaces, see Namespaces.
• QueryOptionsManager: Query options. For details, about query options, see Query Options.
• ResourceExtensionsManager: Resource service extensions. For details about resource service extensions, see Extending the Java API.
• TransformExtensionManager: Transform extensions. For details, about transform extensions, see Content Transformations.

Namespaces

Namespaces are similar to Java packages in that they differentiate between potentially ambiguous XML elements. With the Java API, you can define namespace bindings on the REST Server.

In XML and XQuery, element and attribute nodes are always in a namespace, even if it is the empty namespace (sometimes called no namespace) which has the name of the empty string (""). Each non-empty namespace has an associated URI, which is essentially a unique string that identifies the namespace. That string can be bound to a namespace prefix, which is a shorthand string used as an alias for the namespace in path expressions, element QNames, and variable declarations. Namespace operations in the Java Client API are used to define namespace prefixes on the REST Server so the client and server can share identical namespace bindings on XML elements and attributes for use in queries.

Note that a namespace URI can be bound to multiple prefixes, but a prefix can only be bound to one URI.

If you need to use a namespace prefix in a context in which you cannot declare it, use the REST Management API to define the binding in the App Server. For details, see PUT:/manage/v2/servers/[id-or-name]/properties.

For more information about namespaces, see Understanding XML Namespaces in XQuery in the XQuery and XSLT Reference Guide, which provides a detailed description of XML namespaces and their use.

This section includes the following parts:

• Namespaces Manager
• Getting Server Defined Namespaces
• Adding And Updating A Namespace Prefix
• Reading Prefixes
• Deleting Prefixes

NamespacesManager nsManager =
    client.newServerConfigManager().newNamespacesManager();

nsManager.readAll();

nsContext.getNamespaceURI(prefix-string);
nsContext.getPrefix(URI-string);
nsContext.getPrefixes(URI-string);

EditableNamespaceContext c =(EditableNamespaceContext)nsMgr.readAll();
for (Entry e:c.entrySet()){
  prefix = e.getKey();
  nsURI = e.getValue();
...
}

nsManager.addPrefix("ml", "http://marklogic.com/exercises");

nsManager.updatePrefix("ml", "http://marklogic.com/new_exercises");

nsManager.readPrefix("ml");

NamespaceContext context = nsManager.readAll();

nsManager.deletePrefix("ml");

nsManager.deleteAll();

Logging Namespace Operations

As with all manager objects, you can start and stop logging operations on a NamespacesManager via the startLogging() and stopLogging() methods. For details on how to use the logging facility, see Logging.