Package com.acrolinx.sidebar.pojo.settings

Class AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder

java.lang.Object

com.acrolinx.sidebar.pojo.settings.AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder

Enclosing class:

AcrolinxSidebarInitParameter

public static class AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder
extends Object

Constructor Summary

Constructors

Constructor	Description
AcrolinxSidebarInitParameterBuilder(String clientSignature, List<SoftwareComponent> softwareComponents)	Class to build the parameters to initialize the Acrolinx Sidebar.

Method Summary

Modifier and Type	Method	Description
AcrolinxSidebarInitParameter	build()	Builds the AcrolinxInitParameters.
AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder	withCheckSettings(CheckSettings checkSettings)	This parameter defines the check settings that will apply to all triggered checks.
AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder	withClientLocale(String clientLocale)	By default the client locale is set to 'en'.
AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder	withDefaultCheckSettings(CheckSettings defaultCheckSettings)	These check settings will be used as the initial check settings when the Acrolinx Sidebar is used for the first time.
AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder	withEnableSingleSignOn(boolean enableSingleSignOn)	If the Acrolinx Server is set up for single sign on, this parameter has to be set to 'true' in order enable single sign on from the integration.
AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder	withEnforceHTTPS(boolean enforceHttps)	This setting will prevent any connection with an Acrolinx Server except via 'https'.
AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder	withLogFileLocation(String logFileLocation)	This can be used to provide the log file location if it is known and the sidebar can use the `OPEN LOG FILE` feature.
AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder	withMinimumJavaVersion(int minimumJavaVersion)	This can be set to require a minimum version of Java JRE.
AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder	withMinimumSidebarVersion(String minimumSidebarVersion)	This can be set to require a minimum version of the sidebar.
AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder	withPluginSupportedParameters(PluginSupportedParameters supported)	Add a parameter for integrations to enable check selection in the sidebar.
AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder	withServerAddress(String serverAddress)	Configure the server that should be used to check the content.
AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder	withShowServerSelector(Boolean showServerSelector)	If this parameter is set to 'true' the Acrolinx Sidebar will provide an input field to set an url for the Acrolinx Server.
AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder	withSidebarUrl(String sidebarUrl)	The url of the Acrolinx Sidebar.

Methods inherited from class java.lang.Object

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

Constructor Details

AcrolinxSidebarInitParameterBuilder

public AcrolinxSidebarInitParameterBuilder(String clientSignature,
 List<SoftwareComponent> softwareComponents)

Class to build the parameters to initialize the Acrolinx Sidebar. Two parameters have to be set, all others are optional.

Parameters:

clientSignature - This signature will be provided by Acrolinx once the integration got certified.

softwareComponents - This contains id, name and version of the Acrolinx integration as well as other software components that where used.

See Also:

• SoftwareComponent

Method Details

withServerAddress

public AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder withServerAddress(String serverAddress)

Configure the server that should be used to check the content. If this is not set, set member 'showServerSelector' to true.

Parameters:

serverAddress - Address of the Acrolinx Server that is used to check the content.

Returns:

Returns the AcrolinxInitParameterBuilder for chaining.

withSidebarUrl

public AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder withSidebarUrl(String sidebarUrl)

The url of the Acrolinx Sidebar. If this is not set the publicly available Sidebar will be used by default.

Returns:

Returns the AcrolinxInitParameterBuilder for chaining.

withClientLocale

public AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder withClientLocale(String clientLocale)

By default the client locale is set to 'en'. It can be set to "fr", "de", etc.

Parameters:

clientLocale - Should be "en", "fr", "de", "sv", "ja", etc.

Returns:

Returns the AcrolinxInitParameterBuilder for chaining.

withShowServerSelector

public AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder withShowServerSelector(Boolean showServerSelector)

If this parameter is set to 'true' the Acrolinx Sidebar will provide an input field to set an url for the Acrolinx Server.

Returns:

Returns the AcrolinxInitParameterBuilder for chaining.

withCheckSettings

public AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder withCheckSettings(CheckSettings checkSettings)

This parameter defines the check settings that will apply to all triggered checks. If this parameter is set, then the default check settings and the check settings saved by the user will be ignored.

Returns:

Returns the AcrolinxInitParameterBuilder for chaining.

withDefaultCheckSettings

public AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder withDefaultCheckSettings(CheckSettings defaultCheckSettings)

These check settings will be used as the initial check settings when the Acrolinx Sidebar is used for the first time.

Returns:

Returns the AcrolinxInitParameterBuilder for chaining.

withEnableSingleSignOn

public AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder withEnableSingleSignOn(boolean enableSingleSignOn)

If the Acrolinx Server is set up for single sign on, this parameter has to be set to 'true' in order enable single sign on from the integration.

Returns:

Returns the AcrolinxInitParameterBuilder for chaining.

withEnforceHTTPS

public AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder withEnforceHTTPS(boolean enforceHttps)

This setting will prevent any connection with an Acrolinx Server except via 'https'.

Returns:

Returns the AcrolinxInitParameterBuilder for chaining.

withMinimumSidebarVersion

public AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder withMinimumSidebarVersion(String minimumSidebarVersion)

This can be set to require a minimum version of the sidebar. (eg. "4.4", "4.4.1")

Returns:

Returns the AcrolinxInitParameterBuilder for chaining.

withPluginSupportedParameters

public AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder withPluginSupportedParameters(PluginSupportedParameters supported)

Add a parameter for integrations to enable check selection in the sidebar. Requires minimum sidebar version 14.5.0.

Returns:

Returns the AcrolinxInitParameterBuilder for chaining.

withMinimumJavaVersion

public AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder withMinimumJavaVersion(int minimumJavaVersion)

This can be set to require a minimum version of Java JRE. (eg. "8", "11")

Returns:

Returns the AcrolinxInitParameterBuilder for chaining.

withLogFileLocation

public AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder withLogFileLocation(String logFileLocation)

This can be used to provide the log file location if it is known and the sidebar can use the `OPEN LOG FILE` feature.

Parameters:

logFileLocation - the log file location.

Returns:

Returns the AcrolinxInitParameterBuilder for chaining.

build

public AcrolinxSidebarInitParameter build()

Builds the AcrolinxInitParameters.

Returns:

Returns the AcrolinxInitParameters.