com.onlyoffice.client

Class ApacheHttpclientDocumentServerClient

java.lang.Object

com.onlyoffice.client.AbstractDocumentServerClient

com.onlyoffice.client.ApacheHttpclientDocumentServerClient

All Implemented Interfaces:

DocumentServerClient

public class ApacheHttpclientDocumentServerClient
extends AbstractDocumentServerClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	ApacheHttpclientDocumentServerClient.Callback<Result>

Field Summary

Fields

Modifier and Type	Field and Description
private String	baseUrl Base URL for document server API endpoints.
private org.apache.hc.client5.http.impl.classic.CloseableHttpClient	httpClient HttpClient.
private org.apache.hc.client5.http.impl.classic.CloseableHttpClient	httpClientForSyncConvertRequest HttpClient.
private boolean	isIgnoreSSLCertificate Flag indicating whether to ignore SSL certificate validation.
private com.fasterxml.jackson.databind.ObjectMapper	objectMapper ObjectMapper.

Fields inherited from class com.onlyoffice.client.AbstractDocumentServerClient

documentServerClientSettings, settingsManager, urlManager

Constructor Summary

Constructors

Constructor and Description
ApacheHttpclientDocumentServerClient(DocumentServerClientSettings documentServerClientSettings) Constructs ApacheHttpclientDocumentServerClient with document server client settings.
ApacheHttpclientDocumentServerClient(SettingsManager settingsManager, UrlManager urlManager) Constructs ApacheHttpclientDocumentServerClient with required managers.

Method Summary

Modifier and Type	Method and Description
protected void	authorizeRequest(org.apache.hc.core5.http.ClassicHttpRequest request, RequestEntity requestEntity) Authorizes a request by adding a JWT header if security key is configured.
CommandResponse	command(CommandRequest commandRequest) Executes a command on the document server.
ConvertResponse	convert(ConvertRequest convertRequest) Converts a document according to the specified conversion parameters.
protected org.apache.hc.core5.http.HttpEntity	createEntity(RequestEntity requestEntity) Creates an HTTP entity from the request entity, generating auth token if needed.
protected org.apache.hc.client5.http.impl.classic.CloseableHttpClient	createHttpClient(HttpClientProperties httpClientProperties)
DocBuilderResponse	docbuilder(DocBuilderRequest docBuilderRequest) Executes a DocBuilder request to perform document processing operations.
protected <T> T	executeRequest(org.apache.hc.core5.http.ClassicHttpRequest classicHttpRequest, Class<T> valueType)
protected int	executeRequest(org.apache.hc.core5.http.ClassicHttpRequest classicHttpRequest, OutputStream outputStream)
protected <R> R	executeRequest(org.apache.hc.client5.http.classic.HttpClient httpClient, org.apache.hc.core5.http.ClassicHttpRequest classicHttpRequest, ApacheHttpclientDocumentServerClient.Callback<R> callback)
protected <T> T	executeRequestWithHttpClientForSyncConvertRequest(org.apache.hc.core5.http.ClassicHttpRequest classicHttpRequest, Class<T> valueType)
byte[]	getFile(String fileUrl) Retrieves a file from the specified path as a byte array.
int	getFile(String fileUrl, OutputStream outputStream) Retrieves a file from the specified path and writes it to the provided output stream.
protected Long	getSyncSocketTimeoutForConvertService()
Boolean	healthcheck() Performs a health check of the document server.
protected void	init()
protected void	prepareHttpClient()
protected boolean	shouldReinit()

Methods inherited from class com.onlyoffice.client.AbstractDocumentServerClient

applySettings, applySettings, getBaseUrl, getHttpClientProperties, getSecurityHeader, getSecurityKey, getSecurityPrefix, isSecurityEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

httpClient

private org.apache.hc.client5.http.impl.classic.CloseableHttpClient httpClient

HttpClient.

httpClientForSyncConvertRequest

private org.apache.hc.client5.http.impl.classic.CloseableHttpClient httpClientForSyncConvertRequest

HttpClient.

baseUrl

private String baseUrl

Base URL for document server API endpoints.

isIgnoreSSLCertificate

private boolean isIgnoreSSLCertificate

Flag indicating whether to ignore SSL certificate validation.

objectMapper

private final com.fasterxml.jackson.databind.ObjectMapper objectMapper

ObjectMapper.

Constructor Detail

ApacheHttpclientDocumentServerClient

public ApacheHttpclientDocumentServerClient(DocumentServerClientSettings documentServerClientSettings)

Constructs ApacheHttpclientDocumentServerClient with document server client settings.

Parameters:

documentServerClientSettings - the settings for the document server client

ApacheHttpclientDocumentServerClient

public ApacheHttpclientDocumentServerClient(SettingsManager settingsManager,
                                            UrlManager urlManager)

Constructs ApacheHttpclientDocumentServerClient with required managers.

Parameters:

settingsManager - the settings manager for managing configuration

urlManager - the URL manager for handling document server URLs

Method Detail

healthcheck

public Boolean healthcheck()

Description copied from interface: DocumentServerClient

Performs a health check of the document server.

Returns:

Boolean value indicating the health status of the server: true if the server is healthy and operational, false if the server is experiencing issues

getFile

public byte[] getFile(String fileUrl)

Description copied from interface: DocumentServerClient

Retrieves a file from the specified path as a byte array.

Parameters:

fileUrl - The fileUrl to the file to be retrieved

Returns:

byte array containing the file contents

getFile

public int getFile(String fileUrl,
                   OutputStream outputStream)

Description copied from interface: DocumentServerClient

Retrieves a file from the specified path and writes it to the provided output stream.

Parameters:

fileUrl - The fileUrl to the file to be retrieved

outputStream - The output stream to write the file contents to

Returns:

The number of bytes written to the output stream

convert

public ConvertResponse convert(ConvertRequest convertRequest)

Description copied from interface: DocumentServerClient

Converts a document according to the specified conversion parameters.

Parameters:

convertRequest - The conversion request containing parameters and settings

Returns:

ConvertResponse object containing the conversion result

command

public CommandResponse command(CommandRequest commandRequest)

Description copied from interface: DocumentServerClient

Executes a command on the document server.

Parameters:

commandRequest - The command request containing the command and parameters

Returns:

CommandResponse object containing the command execution result

docbuilder

public DocBuilderResponse docbuilder(DocBuilderRequest docBuilderRequest)

Description copied from interface: DocumentServerClient

Executes a DocBuilder request to perform document processing operations.

Parameters:

docBuilderRequest - The request containing DocBuilder instructions and parameters

Returns:

DocBuilderResponse The response containing the result of the DocBuilder operation

executeRequestWithHttpClientForSyncConvertRequest

protected <T> T executeRequestWithHttpClientForSyncConvertRequest(org.apache.hc.core5.http.ClassicHttpRequest classicHttpRequest,
                                                                  Class<T> valueType)

executeRequest

protected <T> T executeRequest(org.apache.hc.core5.http.ClassicHttpRequest classicHttpRequest,
                               Class<T> valueType)

executeRequest

protected int executeRequest(org.apache.hc.core5.http.ClassicHttpRequest classicHttpRequest,
                             OutputStream outputStream)

executeRequest

protected <R> R executeRequest(org.apache.hc.client5.http.classic.HttpClient httpClient,
                               org.apache.hc.core5.http.ClassicHttpRequest classicHttpRequest,
                               ApacheHttpclientDocumentServerClient.Callback<R> callback)

authorizeRequest

protected void authorizeRequest(org.apache.hc.core5.http.ClassicHttpRequest request,
                                RequestEntity requestEntity)

Authorizes a request by adding a JWT header if security key is configured.

Parameters:

request - the HTTP request to authorize

requestEntity - the request entity containing data for authorization

createEntity

protected org.apache.hc.core5.http.HttpEntity createEntity(RequestEntity requestEntity)

Creates an HTTP entity from the request entity, generating auth token if needed.

Parameters:

requestEntity - the request entity to convert

Returns:

HttpEntity containing the JSON payload

prepareHttpClient

protected void prepareHttpClient()

shouldReinit

protected boolean shouldReinit()

init

protected void init()

createHttpClient

protected org.apache.hc.client5.http.impl.classic.CloseableHttpClient createHttpClient(HttpClientProperties httpClientProperties)

getSyncSocketTimeoutForConvertService

protected Long getSyncSocketTimeoutForConvertService()