com.onlyoffice.manager.settings

Class DefaultSettingsManager

java.lang.Object

com.onlyoffice.manager.settings.DefaultSettingsManager

All Implemented Interfaces:

SettingsManager

public abstract class DefaultSettingsManager
extends Object
implements SettingsManager

Constructor Summary

Constructors

Constructor and Description
DefaultSettingsManager()

Method Summary

Modifier and Type	Method and Description
protected <T> Map<String,String>	convertObjectToDotNotationMap(T object)
void	disableDemo() Disables the use of the demo editor.
Boolean	enableDemo() Checks whether the demo editor is enabled.
DocsIntegrationSdkProperties	getDocsIntegrationSdkProperties() Returns Docs Integration SDK Properties.
protected <T> List<String>	getNamesSettings(T object)
String	getSecurityHeader() Returns the authorization header.
String	getSecurityKey() Returns the security key.
String	getSecurityPrefix() Returns the authorization prefix.
abstract String	getSetting(String name) Returns a value of the setting with the name specified in the request.
Boolean	getSettingBoolean(String name, Boolean defaultValue) Returns a boolean value of the setting with the name specified in the request.
Map<String,String>	getSettings() Returns a map of the settings.
Boolean	isDemoActive() Checks whether the demo editor is active.
Boolean	isDemoAvailable() Checks whether the demo editor is available.
Boolean	isIgnoreSSLCertificate() Checks whether the setting to ignore SSL certificate is enabled.
Boolean	isSecurityEnabled() Checks whether JWT validation is enabled.
abstract void	setSetting(String name, String value) Sets a value for the setting with the name specified in the request.
void	setSettings(Settings settings) Sets the settings specified with the "Settings" object.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSettingsManager

public DefaultSettingsManager()

Method Detail

getSetting

public abstract String getSetting(String name)

Description copied from interface: SettingsManager

Returns a value of the setting with the name specified in the request.

Specified by:

getSetting in interface SettingsManager

Parameters:

name - The setting name.

Returns:

The setting value.

setSetting

public abstract void setSetting(String name,
                                String value)

Description copied from interface: SettingsManager

Sets a value for the setting with the name specified in the request.

Specified by:

setSetting in interface SettingsManager

Parameters:

name - The setting name.

value - The setting value.

setSettings

public void setSettings(Settings settings)
                 throws IntrospectionException,
                        InvocationTargetException,
                        IllegalAccessException

Description copied from interface: SettingsManager

Sets the settings specified with the "Settings" object.

Specified by:

setSettings in interface SettingsManager

Parameters:

settings - The settings to be set.

Throws:

IntrospectionException - If the processing fails unexpectedly.

InvocationTargetException - – If the underlying method throws an exception.

IllegalAccessException - – If this Method object is enforcing Java language access control and the underlying method is inaccessible.

See Also:

Settings

getSettings

public Map<String,String> getSettings()
                               throws IntrospectionException,
                                      InvocationTargetException,
                                      IllegalAccessException

Description copied from interface: SettingsManager

Returns a map of the settings.

Specified by:

getSettings in interface SettingsManager

Returns:

A map of the settings.

Throws:

IntrospectionException - If the processing fails unexpectedly.

InvocationTargetException - – If the underlying method throws an exception.

IllegalAccessException - – If this Method object is enforcing Java language access control and the underlying method is inaccessible.

getSettingBoolean

public Boolean getSettingBoolean(String name,
                                 Boolean defaultValue)

Description copied from interface: SettingsManager

Returns a boolean value of the setting with the name specified in the request.

Specified by:

getSettingBoolean in interface SettingsManager

Parameters:

name - The setting name.

defaultValue - The setting default value.

Returns:

The setting boolean value.

getDocsIntegrationSdkProperties

public DocsIntegrationSdkProperties getDocsIntegrationSdkProperties()

Description copied from interface: SettingsManager

Returns Docs Integration SDK Properties.

Specified by:

getDocsIntegrationSdkProperties in interface SettingsManager

Returns:

The object DocsIntegrationSdkProperties.

isSecurityEnabled

public Boolean isSecurityEnabled()

Description copied from interface: SettingsManager

Checks whether JWT validation is enabled.

Specified by:

isSecurityEnabled in interface SettingsManager

Returns:

True if JWT validation is enabled.

getSecurityKey

public String getSecurityKey()

Description copied from interface: SettingsManager

Returns the security key.

Specified by:

getSecurityKey in interface SettingsManager

Returns:

The security key.

getSecurityHeader

public String getSecurityHeader()

Description copied from interface: SettingsManager

Returns the authorization header.

Specified by:

getSecurityHeader in interface SettingsManager

Returns:

The authorization header.

getSecurityPrefix

public String getSecurityPrefix()

Description copied from interface: SettingsManager

Returns the authorization prefix.

Specified by:

getSecurityPrefix in interface SettingsManager

Returns:

The authorization prefix.

isIgnoreSSLCertificate

public Boolean isIgnoreSSLCertificate()

Description copied from interface: SettingsManager

Checks whether the setting to ignore SSL certificate is enabled.

Specified by:

isIgnoreSSLCertificate in interface SettingsManager

Returns:

True if the setting to ignore SSL certificate is enabled.

enableDemo

public Boolean enableDemo()

Description copied from interface: SettingsManager

Checks whether the demo editor is enabled.

Specified by:

enableDemo in interface SettingsManager

Returns:

True if the demo editor is enabled.

disableDemo

public void disableDemo()

Description copied from interface: SettingsManager

Disables the use of the demo editor.

Specified by:

disableDemo in interface SettingsManager

isDemoActive

public Boolean isDemoActive()

Description copied from interface: SettingsManager

Checks whether the demo editor is active.

Specified by:

isDemoActive in interface SettingsManager

Returns:

True if the demo editor is enabled and the demo version has not expired.

isDemoAvailable

public Boolean isDemoAvailable()

Description copied from interface: SettingsManager

Checks whether the demo editor is available.

Specified by:

isDemoAvailable in interface SettingsManager

Returns:

True if the demo version has not expired.

convertObjectToDotNotationMap

protected <T> Map<String,String> convertObjectToDotNotationMap(T object)
                                                        throws IntrospectionException,
                                                               InvocationTargetException,
                                                               IllegalAccessException

Throws:

IntrospectionException

InvocationTargetException

IllegalAccessException

getNamesSettings

protected <T> List<String> getNamesSettings(T object)
                                     throws IntrospectionException,
                                            InvocationTargetException,
                                            IllegalAccessException

Throws:

IntrospectionException

InvocationTargetException

IllegalAccessException