com.onlyoffice.configuration

Interface DocsIntegrationSdkConfiguration

public interface DocsIntegrationSdkConfiguration

Configuration interface for the ONLYOFFICE Docs Integration SDK. Provides methods to access core components and configure the document server client.

Method Summary

Modifier and Type	Method and Description
default CallbackService	callbackService(JwtManager jwtManager, SettingsManager settingsManager) Creates and configures a default CallbackService instance.
default ConfigService	configService(DocumentManager documentManager, UrlManager urlManager, JwtManager jwtManager, SettingsManager settingsManager) Creates and configures a ConfigService instance.
default ConvertService	convertService(DocumentManager documentManager, UrlManager urlManager, DocumentServerClient documentServerClient) Creates and configures a ConvertService instance.
DocumentManager	documentManager(SettingsManager settingsManager) Creates a DocumentManager instance for managing document operations.
default DocumentServerClient	documentServerClient(SettingsManager settingsManager, UrlManager urlManager) Creates and configures a DocumentServerClient instance.
default JwtManager	jwtManager(SettingsManager settingsManager) Creates and configures a JwtManager instance.
SettingsManager	settingsManager() Gets the settings manager instance.
default SettingsValidationService	settingsValidationService(DocumentServerClient documentServerClient, UrlManager urlManager) Creates and configures a SettingsValidationService instance.
default UrlManager	urlManager(SettingsManager settingsManager) Gets the URL manager instance.

Method Detail

settingsManager

SettingsManager settingsManager()

Gets the settings manager instance.

Returns:

The settings manager

documentManager

DocumentManager documentManager(SettingsManager settingsManager)

Creates a DocumentManager instance for managing document operations.

Parameters:

settingsManager - The settings manager to use for document operations

Returns:

A configured DocumentManager instance

jwtManager

default JwtManager jwtManager(SettingsManager settingsManager)

Creates and configures a JwtManager instance.

Parameters:

settingsManager - The settings manager used to configure the JWT manager

Returns:

A configured JwtManager instance that handles JWT operations

urlManager

default UrlManager urlManager(SettingsManager settingsManager)

Gets the URL manager instance.

Parameters:

settingsManager - The settings manager to use for configuration

Returns:

The URL manager

documentServerClient

default DocumentServerClient documentServerClient(SettingsManager settingsManager,
                                                  UrlManager urlManager)

Creates and configures a DocumentServerClient instance.

Parameters:

settingsManager - The settings manager containing configuration settings

urlManager - The URL manager for handling server URLs

Returns:

A configured DocumentServerClient instance

configService

default ConfigService configService(DocumentManager documentManager,
                                    UrlManager urlManager,
                                    JwtManager jwtManager,
                                    SettingsManager settingsManager)

Creates and configures a ConfigService instance.

Parameters:

documentManager - The document manager to handle document operations

urlManager - The URL manager to handle URL operations

jwtManager - The JWT manager to handle JSON Web Token operations

settingsManager - The settings manager to handle configuration settings

Returns:

A new instance of ConfigService configured with the provided managers

callbackService

default CallbackService callbackService(JwtManager jwtManager,
                                        SettingsManager settingsManager)

Creates and configures a default CallbackService instance.

Parameters:

jwtManager - The JWT manager used for token handling and validation

settingsManager - The settings manager for configuration management

Returns:

A new instance of DefaultCallbackService configured with the provided managers

convertService

default ConvertService convertService(DocumentManager documentManager,
                                      UrlManager urlManager,
                                      DocumentServerClient documentServerClient)

Creates and configures a ConvertService instance.

Parameters:

documentManager - The document manager used for handling document operations

urlManager - The URL manager used for managing URLs

documentServerClient - The client for interacting with the document server

Returns:

A new instance of ConvertService configured with the provided components

settingsValidationService

default SettingsValidationService settingsValidationService(DocumentServerClient documentServerClient,
                                                            UrlManager urlManager)

Creates and configures a SettingsValidationService instance.

Parameters:

documentServerClient - The client for interacting with the document server

urlManager - The URL manager used for managing URLs

Returns:

A new instance of SettingsValidationService configured with the provided components