SolrProperties (BroadleafCommerce Solr Starter 2.3.11-GA API)

java.lang.Object
- com.broadleafcommerce.solr.autoconfigure.SolrProperties

@ConfigurationProperties(value="solr.server")
public class SolrProperties
extends Object

Author:: Jeff Fischer

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`autoConfigEnabled` Allows explicit declaration via property for whether or not solr is allowed to launch via auto configuration.
`protected String`	`configSourcePath` The resource path (on the classpath) where solr configuration is found at runtime.
`protected String`	`downloadProxyHost` Proxy host should a proxy be required to download solr
`protected String`	`downloadProxyPassword` Password to use to access a proxy for downloading solr
`protected String`	`downloadProxyPort` Port to use to access a proxy for downloading solr
`protected String`	`downloadProxyUserName` User name to use to access a proxy for downloading solr
`protected String`	`downloadUrl` The url from which to download the solr executable archive.
`protected Boolean`	`force` Force startup when using ROOT user.
`protected String`	`name` The name of the solr directory.
`protected int`	`port` Port on which solr will listen for requests
`protected String`	`version` The version of solr to use.
`protected String`	`workingDirectory` The working directory in the filesystem where solr will be downloaded and expanded for execution.

Constructor Summary

Constructors
Constructor and Description

SolrProperties()

Constructors
Constructor and Description
`SolrProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getAutoConfigEnabled()`
`String`	`getConfigSourcePath()`
`String`	`getDownloadProxyHost()`
`String`	`getDownloadProxyPassword()`
`String`	`getDownloadProxyPort()`
`String`	`getDownloadProxyUserName()`
`String`	`getDownloadUrl()`
`Boolean`	`getForce()`
`String`	`getName()`
`int`	`getPort()`
`String`	`getVersion()`
`String`	`getWorkingDirectory()`
`void`	`setAutoConfigEnabled(Boolean autoConfigEnabled)`
`void`	`setConfigSourcePath(String configSourcePath)`
`void`	`setDownloadProxyHost(String downloadProxyHost)`
`void`	`setDownloadProxyPassword(String downloadProxyPassword)`
`void`	`setDownloadProxyPort(String downloadProxyPort)`
`void`	`setDownloadProxyUserName(String downloadProxyUserName)`
`void`	`setDownloadUrl(String downloadUrl)`
`void`	`setForce(Boolean force)`
`void`	`setName(String name)`
`void`	`setPort(int port)`
`void`	`setVersion(String version)`
`void`	`setWorkingDirectory(String workingDirectory)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - version
```
protected String version
```
    The version of solr to use.
  - workingDirectory
```
protected String workingDirectory
```
    The working directory in the filesystem where solr will be downloaded and expanded for execution.
  - downloadUrl
```
protected String downloadUrl
```
    The url from which to download the solr executable archive. There should be two params (using String.format %s syntax) declared in the url pattern. These params take the solr version.
  - name
```
protected String name
```
    The name of the solr directory. Includes a param (using String.format %s syntax) to hold ther version.
  - downloadProxyHost
```
protected String downloadProxyHost
```
    Proxy host should a proxy be required to download solr
  - downloadProxyPort
```
protected String downloadProxyPort
```
    Port to use to access a proxy for downloading solr
  - downloadProxyUserName
```
protected String downloadProxyUserName
```
    User name to use to access a proxy for downloading solr
  - downloadProxyPassword
```
protected String downloadProxyPassword
```
    Password to use to access a proxy for downloading solr
  - port
```
protected int port
```
    Port on which solr will listen for requests
  - configSourcePath
```
protected String configSourcePath
```
    The resource path (on the classpath) where solr configuration is found at runtime. Used during solr initial expansion and is synched on each subsequent solr start.
  - autoConfigEnabled
```
protected Boolean autoConfigEnabled
```
    Allows explicit declaration via property for whether or not solr is allowed to launch via auto configuration.
  - force
```
protected Boolean force
```
    Force startup when using ROOT user. False by default.
- Constructor Detail
  - SolrProperties
```
public SolrProperties()
```
- Method Detail
  - getVersion
```
public String getVersion()
```
  - setVersion
```
public void setVersion(String version)
```
  - getWorkingDirectory
```
public String getWorkingDirectory()
```
  - setWorkingDirectory
```
public void setWorkingDirectory(String workingDirectory)
```
  - getDownloadUrl
```
public String getDownloadUrl()
```
  - setDownloadUrl
```
public void setDownloadUrl(String downloadUrl)
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getDownloadProxyHost
```
public String getDownloadProxyHost()
```
  - setDownloadProxyHost
```
public void setDownloadProxyHost(String downloadProxyHost)
```
  - getDownloadProxyPort
```
public String getDownloadProxyPort()
```
  - setDownloadProxyPort
```
public void setDownloadProxyPort(String downloadProxyPort)
```
  - getDownloadProxyUserName
```
public String getDownloadProxyUserName()
```
  - setDownloadProxyUserName
```
public void setDownloadProxyUserName(String downloadProxyUserName)
```
  - getDownloadProxyPassword
```
public String getDownloadProxyPassword()
```
  - setDownloadProxyPassword
```
public void setDownloadProxyPassword(String downloadProxyPassword)
```
  - getPort
```
public int getPort()
```
  - setPort
```
public void setPort(int port)
```
  - getConfigSourcePath
```
public String getConfigSourcePath()
```
  - setConfigSourcePath
```
public void setConfigSourcePath(String configSourcePath)
```
  - getAutoConfigEnabled
```
public Boolean getAutoConfigEnabled()
```
  - setAutoConfigEnabled
```
public void setAutoConfigEnabled(Boolean autoConfigEnabled)
```
  - getForce
```
public Boolean getForce()
```
  - setForce
```
public void setForce(Boolean force)
```

Class SolrProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version

workingDirectory

downloadUrl

name

downloadProxyHost

downloadProxyPort

downloadProxyUserName

downloadProxyPassword

port

configSourcePath

autoConfigEnabled

force

Constructor Detail

SolrProperties

Method Detail

getVersion

setVersion

getWorkingDirectory

setWorkingDirectory

getDownloadUrl

setDownloadUrl

getName

setName

getDownloadProxyHost

setDownloadProxyHost

getDownloadProxyPort

setDownloadProxyPort

getDownloadProxyUserName

setDownloadProxyUserName

getDownloadProxyPassword

setDownloadProxyPassword

getPort

setPort

getConfigSourcePath

setConfigSourcePath

getAutoConfigEnabled

setAutoConfigEnabled

getForce

setForce