Disclaimer
This document describes changes in the upcoming Sophora 6 release. Please note that this version of the documentation is still in development—details may change before the final release.
Overview
Sophora 6 introduces a new internal API based on gRPC, bringing significant architectural changes. As a result:
- Some existing methods are no longer supported due to technical or security-related reasons.
- New methods and features have been added.
- Others have been renamed or restructured for clarity.
These changes mainly affect the deprecated internal API, the IContentManager. Since the public ISophoraClient API provides access to IContentManager in earlier versions, some of your existing scripts or applications may also be impacted.
The new internal API in V6 will not be publicly accessible in Sophora 6. All Java-based API calls should now go through
ISophoraClient or (in scripts) other relevant interfaces.Transition Notes
- Compatibility mode: In Sophora 6, the server still supports
ContentManagerfor V5 Sophora Clients and Server-side scripts. However, you should stop using any deprecated methods listed below. - JavaDoc is your friend: Always check the JavaDoc for annotations. Avoid using deprecated methods—they won’t be around for long.
Notable changes in IContentManager
IContentManager is no longer available in Sophora Client V6. These notes may still be useful for server-executed scripts:
| Method | Status | Notes |
|---|---|---|
| solrRawQuery | Removed | Use IQuery or SoQL for searches |
Changes in ISophoraClient
Many of these were already marked as deprecated in the latest V5 version:
| Method | Status | Notes |
|---|---|---|
getContentManager | Removed | Use only ISophoraClient methods |
publishToExternalService | Removed | Use the new HttpClient in scripts |
getTags | Removed | This was from an older system; not related to the Taxo API |
saveSophoraDocument | Changed | The preserveHistory flag has been removed / has no effect anymore. |
getDocumentVersionsByUuid | Removed | Removed for performance reasons. Alternatives are available |
findDocuments(String soqlString) | New | Search documents using SoQL |
findDocumentIds(String soqlString) | New | Query document IDs using SoQL |
isApiMatching | Removed | Internal use only. Listed for completeness |
sendDataToUrl, getDataFromUrl | Removed | Use HttpClient directly |
getCompressedDictionary, saveDictionary(String name, byte[] wordsData) | Removed | Only used internally. Listed for completeness |
getCndHashEntries, getDocumentProposalSectionHashEntries, getStructureNodeDocumentHashEntries, getSystemDocumentHashEntries | Removed | Now available via Sophora Server HTTP endpoints |
sendServerEvent, getServerEvents | Removed | Internal use only. Listed for completeness. |
reconnectOnNonMatchingAPI | Removed | The reconnection logic has changed |
isReadAnywhereMode | Removed | Use isReadAnywhereActive() instead |
getAvailableReadOnlyContentManagers | Removed | Use getAvailableReadAnywhereReplicas() instead |
isReadAnywhereActive | New | Indicates if ReadAnywhere mode is active |
getAvailableReadAnywhereReplicas | New | Lists ReadAnywhere replicas |
requestDocumentLock, grantLock, rejectLockRequest | New | Useful for coordinated editing |
reconnectTo, getProtocol, getConnectionBarrier | Removed | Listed for completeness |
Other notable changes
DeskClientSettings,ImageVariant,SelectValues, andChannelnow return document IDs in a new wrapper object.UserChangedEventnow return just the username instead of the full user object.IUserListenermethod now receives just the username instead of a full user object.SophoraClientFactoryhas been removed. UseSophoraClientBuilderinstead.- Proxy settings have been removed from
SophoraClientBuilder. Use JVM proxy properties. - Use
withNetworkConnectionDatainstead ofwithAuthorizationHeaderSupplierinSophoraClientBuilder. - The Cluster feature for Sophora Staging Servers has been removed (still available for Sophora Primary Servers.)
- Binary data is now transferred in chunks, reducing HTTP message size. Binary data is stored separately and linked via references.Scripts must work with
BinaryReferenceValuesand manually resolve the data.
The following methods have been removed from IValidationScriptDocumentManager:
findDocumentUuids(String xPathQuery, int pageIndex, int pageSize)getDocumentVersionsByUuid(UUID uuid, int count,TimeRange timeRange)getDocumentFromVersion(UUID versionUuid)
Known incompatibilities (V5 → V6)
- XPath queries are no longer supported in Sophora Server V6. Use
IQueryor SoQL. - Lock requests for documents by editors or tools can only be made between V5 Clients or among V6 Clients. This affects features like the “Polite Import,” and also applies in mixed environments where both V5 and V6 Sophora Clients are used.
Changed behavior: Connection retries
In Sophora 6, if the Client loses the connection to the Primary Server (or a Staging Server):
It will retry the connection a fixed number of times based on:
connectRetriesconnectRetryIntervalInSeconds
If it still can’t reconnect, it enters a broken state. You'll need to recover it manually or with custom logic.
Previously: The Sophora Client would keep retrying indefinitely.
