com.onlyoffice.service.settings

Interface SettingsValidationService

All Known Implementing Classes:

DefaultSettingsValidationService

public interface SettingsValidationService

Method Summary

Modifier and Type	Method and Description
ValidationResult	checkCommandService() Checks the Command Service.
ValidationResult	checkCommandService(String url, Security security, HttpClientSettings httpClientSettings) Checks the Command Service by the Document Server URL.
ValidationResult	checkConvertService() Checks the Convert Service.
ValidationResult	checkConvertService(String url, String productInnerUrl, Security security, HttpClientSettings httpClientSettings) Checks the Convert Service by the Document Server URL.
ValidationResult	checkDocumentServer() Checks the Document Server.
ValidationResult	checkDocumentServer(String url, HttpClientSettings httpClientSettings) Checks the Document Server by its URL.

Method Detail

checkDocumentServer

ValidationResult checkDocumentServer()
                              throws Exception

Checks the Document Server.

Returns:

The ValidationResult object.

Throws:

Exception - If the processing fails unexpectedly.

checkDocumentServer

ValidationResult checkDocumentServer(String url,
                                     HttpClientSettings httpClientSettings)
                              throws Exception

Checks the Document Server by its URL.

Parameters:

url - The URL to the Document Server.

httpClientSettings - The settings for http client.

Returns:

The ValidationResult object.

Throws:

Exception - If the processing fails unexpectedly.

See Also:

HttpClientSettings

checkCommandService

ValidationResult checkCommandService()
                              throws Exception

Checks the Command Service.

Returns:

The ValidationResult object.

Throws:

Exception - If the processing fails unexpectedly.

checkCommandService

ValidationResult checkCommandService(String url,
                                     Security security,
                                     HttpClientSettings httpClientSettings)
                              throws Exception

Checks the Command Service by the Document Server URL.

Parameters:

url - The URL to the Document Server.

security - The security parameters.

httpClientSettings - The settings for http client.

Returns:

The ValidationResult object.

Throws:

Exception - If the processing fails unexpectedly.

See Also:

Security

checkConvertService

ValidationResult checkConvertService()
                              throws Exception

Checks the Convert Service.

Returns:

The ValidationResult object.

Throws:

Exception - If the processing fails unexpectedly.

checkConvertService

ValidationResult checkConvertService(String url,
                                     String productInnerUrl,
                                     Security security,
                                     HttpClientSettings httpClientSettings)
                              throws Exception

Checks the Convert Service by the Document Server URL.

Parameters:

url - The URL to the Document Server.

productInnerUrl - The internal URL to the integration product.

security - The security parameters.

httpClientSettings - The settings for http client.

Returns:

The ValidationResult object.

Throws:

Exception - If the processing fails unexpectedly.

See Also:

Security, HttpClientSettings