com.onlyoffice.client

Interface DocumentServerClient

All Known Implementing Classes:

AbstractDocumentServerClient, ApacheHttpclientDocumentServerClient

public interface DocumentServerClient

Method Summary

Modifier and Type	Method and Description
void	applySettings(DocumentServerClientSettings documentServerClientSettings) Applies the specified document server client settings.
void	applySettings(Settings settings) Applies the specified settings to the document server client.
CommandResponse	command(CommandRequest commandRequest) Executes a command on the document server.
ConvertResponse	convert(ConvertRequest convertRequest) Converts a document according to the specified conversion parameters.
DocBuilderResponse	docbuilder(DocBuilderRequest docBuilderRequest) Executes a DocBuilder request to perform document processing operations.
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.
Boolean	healthcheck() Performs a health check of the document server.

Method Detail

applySettings

void applySettings(Settings settings)

Applies the specified settings to the document server client.

Parameters:

settings - The settings object containing configuration parameters to be applied

Throws:

IllegalArgumentException - if the settings parameter is null

applySettings

void applySettings(DocumentServerClientSettings documentServerClientSettings)

Applies the specified document server client settings.

Parameters:

documentServerClientSettings - The document server client settings to be applied

Throws:

IllegalArgumentException - if the documentServerClientSettings parameter is null

healthcheck

Boolean healthcheck()

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

byte[] getFile(String fileUrl)

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

int getFile(String fileUrl,
            OutputStream outputStream)

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

ConvertResponse convert(ConvertRequest convertRequest)

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

CommandResponse command(CommandRequest commandRequest)

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

DocBuilderResponse docbuilder(DocBuilderRequest docBuilderRequest)

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