GeezerVison

New Features

Optic fragment Option
Added support for the Optic fragment option in fromSearch and fromSearchDocs plans. This option allows callers to specify which document fragment is returned.

Supported values are:

• 'document' — Default
• 'properties'
• 'locks'
• 'any'

This option requires MarkLogic Server 12.1 or later.

cts.param Support
Added support for cts.param expressions in CTS queries and expanded the supported CTS parameter types to allow CTS expressions wherever CTS parameters are accepted. Callers can now pass cts.param values through the Java Client API, providing greater flexibility for building parameterized and complex server-side queries.

This capability requires MarkLogic Server 12.1 or later.

Document Version in Bulk Read Responses
Bulk read responses now include the document version with each document. This makes it easier to implement optimistic-locking workflows when retrieving multiple documents in a single request.

Improvements

Improved ClientCookie.toString()
ClientCookie now overrides toString() to return the cookie in name=value format, making cookie values easier to inspect during debugging and logging.

Dedicated OkHttp Logger
OkHttp HTTP logging is now routed through the dedicated com.marklogic.client.okhttp logger.

This allows applications to configure low-level HTTP logging independently from other Java Client API log output.

Security Improvements

Sensitive credentials are now protected from being exposed in application logs.

• Passwords are sanitized before being written to log output.
• Authorization headers are redacted from OkHttp HTTP logs.

XXE Protection
XML parsing has been hardened by disabling external entity resolution and external DTD and resource access, reducing exposure to XML External Entity (XXE) attacks.

Secure TLS Trust Store Configuration
TLS connections now use a more secure trust store configuration with proper certificate validation.

Dependency Updates

The following dependencies have been updated to address known vulnerabilities and maintain compatibility:

• Jackson 2.22.1 — Addresses vulnerabilities present in earlier releases.
• OkHttp 5.4.0 — Updated to the latest supported release.
• Logback 1.5.37 — Addresses vulnerabilities present in earlier releases.
• Kotlin 2.4.10 — Includes security and dependency updates associated with the OkHttp upgrade.

Compatibility

OkHttp 5.x
The upgrade from OkHttp 4.x to 5.x is a significant internal dependency change. The public Java Client API is not affected.

Applications that provide their own OkHttpClient instance or depend on OkHttp implementation details should review the OkHttp 5 migration guidance.

HTTP Debug Logging
OkHttp HTTP logs are now emitted through the com.marklogic.client.okhttp logger instead of the okhttp3 logger.

If your application relies on HTTP wire logging, update your logging configuration to use the new logger name.

Authorization Header Redaction
Authorization headers are now redacted from HTTP logs.

Applications or diagnostic tooling that previously relied on retrieving authorization credentials from log output must retrieve those values from the application's configuration instead.

This minor release includes the following items:

• Added com.marklogic.client.datamovement.DocumentWriteSetFilter as an abstraction for processing a DocumentWriteSet before it is written to MarkLogic via a WriteBatcher. Can be applied to a WriteBatcher via withDocumentWriteSetFilter.
• Can now implement incremental writes via com.marklogic.client.datamovement.filter.IncrementalWriteFilter. See the Builder in this class for instructions on configuring this capability.
• #1872 Fixed a bug where QueryBatcher will no longer throw an error when it receives a value of -1 from the server when calculating the "max document to URI batch ratio".

This major release does not provide any new functionality, but rather raises the minimum Java version to 17 and updates all dependencies to their latest version, most notably the underlying OkHttp library.

Customers wishing to remain on Java 8 or Java 11 can continue using the 7.2.0 release or earlier and may continue to submit enhancement requests or bug fixes that can be addressed via a 7.x release.

Other details on this release:

1. The deprecated MarkLogicCloudAuthenticationContext class has been removed. This class was deprecated in release 7.2.0 in favor of the ProgressDataCloudAuthenticationContext which provides the same functionality.
2. The jakarta.xml.bind:jakarta.xml.bind-api dependency is no longer an api dependency but rather an implementation dependency. Customers using JAXB are expected to provide their desired version of this dependency on their compile class path.
3. The ClientCookie class referenced in the public AP of the Java Client's transaction support is now in the com.marklogic.client package instead of com.marklogic.client.impl.
4. The RequestParameters and ServerTransform classes no longer use thread-safe maps for storing parameters. The thread-safe nature of these maps was not documented and was judged not to fit the expected use of these classes, as having multiple threads manipulate the set of parameters in these classes would lead to unpredictable behavior.

This minor release, which coincides with the 12 GA release of the MarkLogic server, addresses the following items:

1. The client now defaults to TLSv1.3 when possible, which includes when connecting to an app server in MarkLogic 12 that requires SSL.
2. Based on changes between the MarkLogic 12 EA and 12 GA releases, renamed cosineSimilarity to cosine in the com.marklogic.client.expression.VecExpr class and modified the signature of the annTopK method in the com.marklogic.client.expression.PlanBuilder class.
3. Added com.marklogic.client.util.VectorUtil to support encoding and decoding vectors. Encoded vectors can be indexed by MarkLogic 12 and will typically consume fewer system resources than un-encoded vectors.
4. Added com.marklogic.client.row.RowTemplate to simplify common use cases with Optic queries.
5. Bumped com.fasterxml.jackson dependencies from 2.17.2 to 2.19.0.
6. Deprecated com.marklogic.client.DatabaseClientFactory.MarkLogicCloudAuthContext class in favor of the new com.marklogic.client.DatabaseClientFactory.ProgressDataCloudAuthContext class.
7. Removed deprecated HttpClientConfigurator interface.

This minor release addresses the following items:

1. Invoking custom code via ServerEvaluationCall now results in the multipart response from MarkLogic being read via a stream instead of the entire response being ready into memory. Note that when using an EvalResultIterator, you must call the close() method to ensure that the stream is properly closed.
2. The DatabaseClient interface now extends java.io.Closeable so that it can be used in try-with-resources statements.
3. The property marklogic.client.connectionString is now supported via DatabaseClientFactory.
4. StructuredQueryBuilder now has methods for true and false queries and for building operator states.
5. MarkLogic 12 users can now use the shortestPath and annTopK methods in the Optic plan builder.
6. MarkLogic 12 users can now use the bm25, zero, and random score methods in the Optic plan builder.

This major release introduces one breaking change from the latest 6.x release - the client now depends on the Jakarta XML Binding API instead of the older JAXB API. This change is reflected in any public classes in the client that previously depended on types in the javax.xml.bind namespace. Those classes now depend on types with the same name but in the jakarta.xml.bind namespace.

This release is also tied to the early access release of MarkLogic Server version 12. The primary addition to this release that depends on MarkLogic 12 is a set of new APIs in the Optic PlanBuilder class. Please note that any change listed below that depends on MarkLogic 12 is subject to change in a future 7.x release to accommodate server changes before the general access release of MarkLogic 12.

Full set of changes in this release:

• Now depends on the jakarta.xml.bind API instead of the javax.xml.bind API.
• Can now use BM25 as a scoring method when building an Optic plan (depends on MarkLogic 12).
• Can now use search options with the Optic fromSearchDocs accessor (depends on MarkLogic 12).
• Can now use new functions in the vector namespace when building an Optic plan (depends on MarkLogic 12).
• Fixed bug #1688 that prevented reads on documents with non-US-ASCII characters in URIs.
• Bumped Jackson dependencies to 2.17.2.
• Removed deprecated classes.

This patch release addresses the following items:

• A DMSDK WriteBatcher now supports writing a "naked" document - i.e. a URI with only a properties fragment. This is supported by the v1/documents endpoint and was mistakenly prohibited by WriteBatcher.
• DMSDK batchers have new info-level logging to capture when they are started and stopped to facilitate debugging, particularly around when a batcher is unexpectedly stopped.
• Adjusting the thread pool size on a QueryBatcher now works correctly on Java 11 and higher; previously, it only worked correctly on Java 8.

This minor release coincides with the release of MarkLogic Server 11.2.0 and provides the following enhancements:

• Can now authenticate with a MarkLogic app server that requires OAuth authentication. Can either use the new OAuthContext class or the new marklogic.client.oauth.token property when constructing a DatabaseClient via properties.
• Can now patch one or more documents via an Optic plan using the new patchBuilder method available on com.marklogic.client.expression.PlanBuilder. Requires MarkLogic 11.2.0 or higher.
• Can now capture errors occuring during execution of an Optic plan via the new onError method. Requires MarkLogic 11.2.0 or higher.
• The com.marklogic.client.document.GenericDocumentManager interface now support temporal operations.
• DMSDK log messages pertaining to a queue being flushed are now at the debug and trace levels instead of info.
• Fixed #1637 so that the DMSDK awaitCompletion method waits for the correct duration.

This minor release addresses the following items:

• When constructing a DatabaseClient and configuring two-way SSL, a separate trust store can be configured via the new properties marklogic.client.truststore.path, marklogic.client.truststore.password, marklogic.client.truststore.type, and marklogic.client.truststore.algorithm. These can be passed in via the newClient(Function<String, Object> propertySource) method or programmatically set with new methods in DatabaseClientBuilder.
• The OkHttp dependency was bumped from 4.11.0 to 4.12.0.
• The Jackson dependency was bumped from 2.15.2 to 2.15.3.

This patch release addresses the following items:

• DocumentManager.search now works when METADATAVALUES has been set as a category on the DocumentManager.
• 3 methods in DocumentManager that support searching/reading on a server timestamp have been exposed; they have long been working in the implementation class but were mistakenly never exposed in the interface.