SolrEnvironment (Solr 9.6.0 core API)

java.lang.Object
- org.apache.solr.handler.admin.SolrEnvironment

```
public class SolrEnvironment
extends Object
```
It is possible to define an environment code when starting Solr, through -Dsolr.environment=prod|stage|test|dev or by setting the cluster property "environment". This class checks if any of these are defined, and parses the string, which may also contain custom overrides for environment name (label) and color to be shown in Admin UI

Constructor Summary

Constructors
Constructor Description

SolrEnvironment()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getCode()`
`String`	`getColor()`
`static SolrEnvironment`	`getFromSyspropOrClusterprop(org.apache.solr.common.cloud.ZkStateReader zkStateReader)`	Gets and parses the solr environment configuration string from either System properties "solr.environment" or from Clusterprop "environment"
`String`	`getLabel()`
`boolean`	`isDefined()`
`static SolrEnvironment`	`parse(String environmentString)`	Parse an environment string of format <prod\|stage\|test\|dev> with an optional label and color as arguments

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

- Constructor Detail
  - SolrEnvironment
```
public SolrEnvironment()
```
- Method Detail
  - getCode
```
public String getCode()
```
  - getLabel
```
public String getLabel()
```
  - getColor
```
public String getColor()
```
  - isDefined
```
public boolean isDefined()
```
  - parse
```
public static SolrEnvironment parse(String environmentString)
```
    Parse an environment string of format <prod|stage|test|dev> with an optional label and color as arguments
    
    Parameters:
    
    environmentString - the raw string to parse
    
    Returns:
    
    an instance of this object
  - getFromSyspropOrClusterprop
```
public static SolrEnvironment getFromSyspropOrClusterprop(org.apache.solr.common.cloud.ZkStateReader zkStateReader)
```
    Gets and parses the solr environment configuration string from either System properties "solr.environment" or from Clusterprop "environment"
    
    Parameters:
    
    zkStateReader - pass in the zkStateReader if in cloud mode
    
    Returns:
    
    an instance of this class