DiscoveryEnvUtil (OLE 2.0.0-SNAPSHOT API)

java.lang.Object
- org.kuali.ole.docstore.discovery.util.DiscoveryEnvUtil

```
public class DiscoveryEnvUtil
extends Object
```
Created by IntelliJ IDEA. User: Sreekanth Date: 6/6/12 Time: 2:41 PM To change this template use File | Settings | File Templates.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DISCOVERY_PROPERTIES_FILE`
`static String`	`DISCOVERY_PROPERTIES_FOLDER`
`static String`	`DISCOVERY_ROOT_DEFAULT`
`static String`	`DISCOVERY_ROOT_DIR`
`static String`	`DISCOVERY_ROOT_TEST_DEFAULT`
`protected String`	`discoveryPropertiesFilePath`
`protected String`	`discoveryPropertyFolderPath`
`protected String`	`rootFolderPath`
`static String`	`SOLR_CONFIG_FOLDER`
`static String`	`SOLR_DATA_FOLDER`
`protected String`	`solrConfigFolderPath`
`protected String`	`solrDataFolderPath`
`static String`	`UTF8`

Constructor Summary

Constructors
Constructor and Description

DiscoveryEnvUtil()

Constructors
Constructor and Description
`DiscoveryEnvUtil()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getDiscoveryHome(String defaultDiscoveryHome)` Logic for determining the correct home directory for discovery.
`String`	`getDiscoveryPropertiesFilePath()`
`String`	`getDiscoveryPropertyFolderPath()`
`protected List<ResourceItem>`	`getResourceItems()` Return a list of `ResourceItem` objects representing resources required by discovery
`String`	`getRootFolderPath()`
`String`	`getSolrConfigDirectoryPath()`
`String`	`getSolrConfigFolderPath()`
`String`	`getSolrDataFolderPath()`
`protected void`	`handleSolrConfig()`
`protected void`	`initEnv(String defaultDiscoveryHome)` Configure the home directory for discovery.
`void`	`initEnvironment()` Initializes environment for normal use of discovery.
`void`	`initEnvironmentCommon(String docStoreRoot)` Initializes an environment for discovery at the given root folder.
`void`	`initPathValues(String discoveryRoot)`
`void`	`initTestEnvironment()` Initializes environment for testing.
`void`	`logEnvironment()`
`void`	`printEnvironment()`
`void`	`setDiscoveryPropertiesFilePath(String discoveryPropertiesFilePath)`
`void`	`setDiscoveryPropertyFolderPath(String discoveryPropertyFolderPath)`
`void`	`setRootFolderPath(String rootFolderPath)`
`void`	`setSolrConfigFolderPath(String solrConfigFolderPath)`
`void`	`setSolrDataFolderPath(String solrDataFolderPath)`

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

- Field Detail
  - DISCOVERY_ROOT_DIR
```
public static final String DISCOVERY_ROOT_DIR
```
    See Also:
    Constant Field Values
  - DISCOVERY_ROOT_DEFAULT
```
public static final String DISCOVERY_ROOT_DEFAULT
```
    See Also:
    Constant Field Values
  - DISCOVERY_ROOT_TEST_DEFAULT
```
public static final String DISCOVERY_ROOT_TEST_DEFAULT
```
  - SOLR_CONFIG_FOLDER
```
public static final String SOLR_CONFIG_FOLDER
```
    See Also:
    Constant Field Values
  - SOLR_DATA_FOLDER
```
public static final String SOLR_DATA_FOLDER
```
    See Also:
    Constant Field Values
  - DISCOVERY_PROPERTIES_FOLDER
```
public static final String DISCOVERY_PROPERTIES_FOLDER
```
    See Also:
    Constant Field Values
  - DISCOVERY_PROPERTIES_FILE
```
public static final String DISCOVERY_PROPERTIES_FILE
```
    See Also:
    Constant Field Values
  - UTF8
```
public static final String UTF8
```
    See Also:
    Constant Field Values
  - rootFolderPath
```
protected String rootFolderPath
```
  - solrConfigFolderPath
```
protected String solrConfigFolderPath
```
  - solrDataFolderPath
```
protected String solrDataFolderPath
```
  - discoveryPropertyFolderPath
```
protected String discoveryPropertyFolderPath
```
  - discoveryPropertiesFilePath
```
protected String discoveryPropertiesFilePath
```
- Constructor Detail
  - DiscoveryEnvUtil
```
public DiscoveryEnvUtil()
```
- Method Detail
  - getSolrConfigDirectoryPath
```
public String getSolrConfigDirectoryPath()
```
  - initEnvironment
```
public void initEnvironment()
```
    Initializes environment for normal use of discovery. This should be called during web app initialization.
  - initTestEnvironment
```
public void initTestEnvironment()
```
    Initializes environment for testing. This should be called in all test cases.
  - initEnv
```
protected void initEnv(String defaultDiscoveryHome)
```
    Configure the home directory for discovery. When this method return, the system property ole.discover.home is guaranteed to be set.
  - getDiscoveryHome
```
public String getDiscoveryHome(String defaultDiscoveryHome)
```
    Logic for determining the correct home directory for discovery. The directory to use can be configured by system property settings. If no system property is set, discovery home becomes a path relative to docstore home. If docstore home is not set, it falls through to the default value.
  - initPathValues
```
public void initPathValues(String discoveryRoot)
```
  - initEnvironmentCommon
```
public void initEnvironmentCommon(String docStoreRoot)
```
    Initializes an environment for discovery at the given root folder. Looks for necessary folders and files under the root folder. Any resources that already exist are left untouched. Any that are missing are created using default values.
  - handleSolrConfig
```
protected void handleSolrConfig()
```
  - getResourceItems
```
protected List<ResourceItem> getResourceItems()
```
    Return a list of ResourceItem objects representing resources required by discovery
  - printEnvironment
```
public void printEnvironment()
```
  - logEnvironment
```
public void logEnvironment()
```
  - getRootFolderPath
```
public String getRootFolderPath()
```
  - setRootFolderPath
```
public void setRootFolderPath(String rootFolderPath)
```
  - getSolrConfigFolderPath
```
public String getSolrConfigFolderPath()
```
  - setSolrConfigFolderPath
```
public void setSolrConfigFolderPath(String solrConfigFolderPath)
```
  - getSolrDataFolderPath
```
public String getSolrDataFolderPath()
```
  - setSolrDataFolderPath
```
public void setSolrDataFolderPath(String solrDataFolderPath)
```
  - getDiscoveryPropertyFolderPath
```
public String getDiscoveryPropertyFolderPath()
```
  - setDiscoveryPropertyFolderPath
```
public void setDiscoveryPropertyFolderPath(String discoveryPropertyFolderPath)
```
  - getDiscoveryPropertiesFilePath
```
public String getDiscoveryPropertiesFilePath()
```
  - setDiscoveryPropertiesFilePath
```
public void setDiscoveryPropertiesFilePath(String discoveryPropertiesFilePath)
```

Class DiscoveryEnvUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DISCOVERY_ROOT_DIR

DISCOVERY_ROOT_DEFAULT

DISCOVERY_ROOT_TEST_DEFAULT

SOLR_CONFIG_FOLDER

SOLR_DATA_FOLDER

DISCOVERY_PROPERTIES_FOLDER

DISCOVERY_PROPERTIES_FILE

UTF8

rootFolderPath

solrConfigFolderPath

solrDataFolderPath

discoveryPropertyFolderPath

discoveryPropertiesFilePath

Constructor Detail

DiscoveryEnvUtil

Method Detail

getSolrConfigDirectoryPath

initEnvironment

initTestEnvironment

initEnv

getDiscoveryHome

initPathValues

initEnvironmentCommon

handleSolrConfig

getResourceItems

printEnvironment

logEnvironment

getRootFolderPath

setRootFolderPath

getSolrConfigFolderPath

setSolrConfigFolderPath

getSolrDataFolderPath

setSolrDataFolderPath

getDiscoveryPropertyFolderPath

setDiscoveryPropertyFolderPath

getDiscoveryPropertiesFilePath

setDiscoveryPropertiesFilePath