Package com.broadleafcommerce.search.provider.solr.autoconfigure

Class BroadleafSolrProperties.ServerProperties

java.lang.Object
com.broadleafcommerce.search.provider.solr.autoconfigure.BroadleafSolrProperties.ServerProperties
Enclosing class:
BroadleafSolrProperties
public static class BroadleafSolrProperties.ServerProperties extends Object

  • Constructor Summary

    Constructors
    Constructor
    Description
    ServerProperties()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    String
    getChroot()
    The Zookeeper chroot, which represents the root path to the Zookeeper virtual file system for SolrCloud configuration.
    int
    getClientSessionTimeoutMillis()
    If using SolrCloud, this should be the value of the ZooKeeper client session timeout setting ('zkClientTimeout') in milliseconds.
    String
    getHost()
    The host URL to connect to the Solr Server.
    String
    getPassword()
    Optional password to use for Basic Authentication along with the userName field for Solr.
    String
    getUserName()
    Optional user name to use for BasicAuth with Solr.
    int
    hashCode()
     
    boolean
    isSuppressSolrClientConnection()
    Whether or not the solr client automatic connection at startup should be suppressed.
    void
    setChroot(String chroot)
    The Zookeeper chroot, which represents the root path to the Zookeeper virtual file system for SolrCloud configuration.
    void
    setClientSessionTimeoutMillis(int clientSessionTimeoutMillis)
    If using SolrCloud, this should be the value of the ZooKeeper client session timeout setting ('zkClientTimeout') in milliseconds.
    void
    setHost(String host)
    The host URL to connect to the Solr Server.
    void
    setPassword(String password)
    Optional password to use for Basic Authentication along with the userName field for Solr.
    void
    setSuppressSolrClientConnection(boolean suppressSolrClientConnection)
    Whether or not the solr client automatic connection at startup should be suppressed.
    void
    setUserName(String userName)
    Optional user name to use for BasicAuth with Solr.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ServerProperties

      public ServerProperties()

  • Method Details

    • isSuppressSolrClientConnection

      public boolean isSuppressSolrClientConnection()
      Whether or not the solr client automatic connection at startup should be suppressed. Default is false.

    • getHost

      public String getHost()
      The host URL to connect to the Solr Server.

      If this is a Solr Cloud implementation, this should be a comma separated list of ZK nodes.

      Ignored if embedded is true.

      Returns:
      The host URL to connect to the Solr Server

    • getChroot

      public String getChroot()
      The Zookeeper chroot, which represents the root path to the Zookeeper virtual file system for SolrCloud configuration.
      Returns:
      The Zookeeper chroot

    • getUserName

      public String getUserName()
      Optional user name to use for BasicAuth with Solr. Note that this user must have permissions for all access that is expected by the application using this lib. Query, write, admin, etc. are all types of access that can be granted. See additional Solr documentation related to Basic Authentication and other security concerns.
      Returns:
      Optional user name to use for BasicAuth with Solr

    • getPassword

      public String getPassword()
      Optional password to use for Basic Authentication along with the userName field for Solr.
      Returns:
      Optional password to use for BasicAuth with Solr

    • getClientSessionTimeoutMillis

      public int getClientSessionTimeoutMillis()
      If using SolrCloud, this should be the value of the ZooKeeper client session timeout setting ('zkClientTimeout') in milliseconds. Note that the ZK server may not honor this value if it exceeds the server-side configured maximum ('maxSessionTimeout').

    • setSuppressSolrClientConnection

      public void setSuppressSolrClientConnection(boolean suppressSolrClientConnection)
      Whether or not the solr client automatic connection at startup should be suppressed. Default is false.

    • setHost

      public void setHost(String host)
      The host URL to connect to the Solr Server.

      If this is a Solr Cloud implementation, this should be a comma separated list of ZK nodes.

      Ignored if embedded is true.

      Parameters:
      host - The host URL to connect to the Solr Server

    • setChroot

      public void setChroot(String chroot)
      The Zookeeper chroot, which represents the root path to the Zookeeper virtual file system for SolrCloud configuration.
      Parameters:
      chroot - The Zookeeper chroot

    • setUserName

      public void setUserName(String userName)
      Optional user name to use for BasicAuth with Solr. Note that this user must have permissions for all access that is expected by the application using this lib. Query, write, admin, etc. are all types of access that can be granted. See additional Solr documentation related to Basic Authentication and other security concerns.
      Parameters:
      userName - Optional user name to use for BasicAuth with Solr

    • setPassword

      public void setPassword(String password)
      Optional password to use for Basic Authentication along with the userName field for Solr.
      Parameters:
      password - Optional password to use for BasicAuth with Solr

    • setClientSessionTimeoutMillis

      public void setClientSessionTimeoutMillis(int clientSessionTimeoutMillis)
      If using SolrCloud, this should be the value of the ZooKeeper client session timeout setting ('zkClientTimeout') in milliseconds. Note that the ZK server may not honor this value if it exceeds the server-side configured maximum ('maxSessionTimeout').

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object