Package com.acrolinx.sidebar.pojo.settings

Class AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder

  • Enclosing class:
    AcrolinxSidebarInitParameter
    public static class AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder
extends java.lang.Object

    • Constructor Detail

      • AcrolinxSidebarInitParameterBuilder

        public AcrolinxSidebarInitParameterBuilder​(java.lang.String clientSignature,
                                           java.util.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 Detail

      • withServerAddress

        public AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder withServerAddress​(java.lang.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.

      • withClientLocale

        public AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder withClientLocale​(java.lang.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​(java.lang.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.

      • 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.

      • withLogFileLocation

        public AcrolinxSidebarInitParameter.AcrolinxSidebarInitParameterBuilder withLogFileLocation​(java.lang.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.