com.onlyoffice.service.documenteditor.config

Class DefaultConfigService

java.lang.Object

com.onlyoffice.service.documenteditor.config.DefaultConfigService

All Implemented Interfaces:

ConfigService

public class DefaultConfigService
extends Object
implements ConfigService

Field Summary

Fields

Modifier and Type	Field and Description
private DocumentManager	documentManager DocumentManager.
private JwtManager	jwtManager JwtManager.
private SettingsManager	settingsManager SettingsManager.
private UrlManager	urlManager UrlManager.

Constructor Summary

Constructors

Constructor and Description
DefaultConfigService()

Method Summary

Modifier and Type	Method and Description
Config	createConfig(String fileId, Mode mode, String userAgent) Creates a configuration for the document editor using the User-Agent request header.
Config	createConfig(String fileId, Mode mode, Type type) Creates a configuration for the document editor using the Type parameter.
CoEditing	getCoEditing(String fileId, Mode mode, Type type) Returns the CoEditing object.
Customization	getCustomization(String fileId) Returns the Customization object.
Document	getDocument(String fileId, Type type) Returns the Document object.
EditorConfig	getEditorConfig(String fileId, Mode mode, Type type) Returns the EditorConfig object.
Embedded	getEmbedded(String fileId) Returns the Embedded object.
Info	getInfo(String fileId) Returns the Info object.
Permissions	getPermissions(String fileId) Returns the Permissions object.
Plugins	getPlugins(Object object) Returns the Plugins object.
List<Recent>	getRecent(Object object) Returns a list of the Recent objects.
ReferenceData	getReferenceData(String fileId) Returns the ReferenceData object.
List<Template>	getTemplates(String fileId) Returns a list of the Template objects.
Type	getType(String userAgent) Returns the Type object.
User	getUser() Returns the User object.

Methods inherited from class java.lang.Object

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

Field Detail

documentManager

private DocumentManager documentManager

DocumentManager.

urlManager

private UrlManager urlManager

UrlManager.

jwtManager

private JwtManager jwtManager

JwtManager.

settingsManager

private SettingsManager settingsManager

SettingsManager.

Constructor Detail

DefaultConfigService

public DefaultConfigService()

Method Detail

createConfig

public Config createConfig(String fileId,
                           Mode mode,
                           String userAgent)

Description copied from interface: ConfigService

Creates a configuration for the document editor using the User-Agent request header.

Specified by:

createConfig in interface ConfigService

Parameters:

fileId - The file ID.

mode - The editor opening mode.

userAgent - The User-Agent request header that is used to determine the platform type ("desktop" or "mobile").

Returns:

The Config object.

createConfig

public Config createConfig(String fileId,
                           Mode mode,
                           Type type)

Description copied from interface: ConfigService

Creates a configuration for the document editor using the Type parameter.

Specified by:

createConfig in interface ConfigService

Parameters:

fileId - The file ID.

mode - The editor opening mode.

type - The platform type used to access the document.

Returns:

The Config object.

getDocument

public Document getDocument(String fileId,
                            Type type)

Description copied from interface: ConfigService

Returns the Document object.

Specified by:

getDocument in interface ConfigService

Parameters:

fileId - The file ID.

type - The platform type used to access the document.

Returns:

The ReferenceData object.

getEditorConfig

public EditorConfig getEditorConfig(String fileId,
                                    Mode mode,
                                    Type type)

Description copied from interface: ConfigService

Returns the EditorConfig object.

Specified by:

getEditorConfig in interface ConfigService

Parameters:

fileId - The file ID.

mode - The editor opening mode.

type - The platform type used to access the document.

Returns:

The EditorConfig object.

getReferenceData

public ReferenceData getReferenceData(String fileId)

Description copied from interface: ConfigService

Returns the ReferenceData object.

Specified by:

getReferenceData in interface ConfigService

Parameters:

fileId - The file ID.

Returns:

The ReferenceData object.

getInfo

public Info getInfo(String fileId)

Description copied from interface: ConfigService

Returns the Info object.

Specified by:

getInfo in interface ConfigService

Parameters:

fileId - The file ID.

Returns:

The Info object.

getPermissions

public Permissions getPermissions(String fileId)

Description copied from interface: ConfigService

Returns the Permissions object.

Specified by:

getPermissions in interface ConfigService

Parameters:

fileId - The file ID.

Returns:

The Permissions object.

getCoEditing

public CoEditing getCoEditing(String fileId,
                              Mode mode,
                              Type type)

Description copied from interface: ConfigService

Returns the CoEditing object.

Specified by:

getCoEditing in interface ConfigService

Parameters:

fileId - The file ID.

mode - The editor opening mode.

type - The platform type used to access the document.

Returns:

The CoEditing object.

getRecent

public List<Recent> getRecent(Object object)

Description copied from interface: ConfigService

Returns a list of the Recent objects.

Specified by:

getRecent in interface ConfigService

Parameters:

object - The object.

Returns:

A list of the Recent objects.

getTemplates

public List<Template> getTemplates(String fileId)

Description copied from interface: ConfigService

Returns a list of the Template objects.

Specified by:

getTemplates in interface ConfigService

Parameters:

fileId - The file ID.

Returns:

A list of the Template objects.

getUser

public User getUser()

Description copied from interface: ConfigService

Returns the User object.

Specified by:

getUser in interface ConfigService

Returns:

The User object.

getCustomization

public Customization getCustomization(String fileId)

Description copied from interface: ConfigService

Returns the Customization object.

Specified by:

getCustomization in interface ConfigService

Parameters:

fileId - The file ID.

Returns:

The Customization object.

getEmbedded

public Embedded getEmbedded(String fileId)

Description copied from interface: ConfigService

Returns the Embedded object.

Specified by:

getEmbedded in interface ConfigService

Parameters:

fileId - The file ID.

Returns:

The Embedded object.

getPlugins

public Plugins getPlugins(Object object)

Description copied from interface: ConfigService

Returns the Plugins object.

Specified by:

getPlugins in interface ConfigService

Parameters:

object - The object.

Returns:

The Plugins object.

getType

public Type getType(String userAgent)

Description copied from interface: ConfigService

Returns the Type object.

Specified by:

getType in interface ConfigService

Parameters:

userAgent - The User-Agent request header that is used to determine the platform type ("desktop" or "mobile").

Returns:

The Type object.