com.onlyoffice.manager.settings

Interface SettingsManager

All Known Implementing Classes:

DefaultSettingsManager

public interface SettingsManager

Method Summary

Modifier and Type	Method and Description
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.
String	getSecurityHeader() Returns the authorization header.
String	getSecurityKey() Returns the security key.
String	getSecurityPrefix() Returns the authorization prefix.
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.
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.

Method Detail

getSetting

String getSetting(String name)

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

Parameters:

name - The setting name.

Returns:

The setting value.

setSetting

void setSetting(String name,
                String value)

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

Parameters:

name - The setting name.

value - The setting value.

setSettings

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

Sets the settings specified with the "Settings" object.

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

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

Returns a map of the settings.

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

Boolean getSettingBoolean(String name,
                          Boolean defaultValue)

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

Parameters:

name - The setting name.

defaultValue - The setting default value.

Returns:

The setting boolean value.

getDocsIntegrationSdkProperties

DocsIntegrationSdkProperties getDocsIntegrationSdkProperties()

Returns Docs Integration SDK Properties.

Returns:

The object DocsIntegrationSdkProperties.

isSecurityEnabled

Boolean isSecurityEnabled()

Checks whether JWT validation is enabled.

Returns:

True if JWT validation is enabled.

isIgnoreSSLCertificate

Boolean isIgnoreSSLCertificate()

Checks whether the setting to ignore SSL certificate is enabled.

Returns:

True if the setting to ignore SSL certificate is enabled.

getSecurityKey

String getSecurityKey()

Returns the security key.

Returns:

The security key.

getSecurityHeader

String getSecurityHeader()

Returns the authorization header.

Returns:

The authorization header.

getSecurityPrefix

String getSecurityPrefix()

Returns the authorization prefix.

Returns:

The authorization prefix.

enableDemo

Boolean enableDemo()

Checks whether the demo editor is enabled.

Returns:

True if the demo editor is enabled.

disableDemo

void disableDemo()

Disables the use of the demo editor.

isDemoActive

Boolean isDemoActive()

Checks whether the demo editor is active.

Returns:

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

isDemoAvailable

Boolean isDemoAvailable()

Checks whether the demo editor is available.

Returns:

True if the demo version has not expired.