EnvironmentConfiguration

java.lang.Object
- lumis.portal.configuration.EnvironmentConfiguration

All Implemented Interfaces:

Cloneable
```
public class EnvironmentConfiguration
extends Object
implements Cloneable
```
Holds the configuration of the Lumis Portal environment.

Since:

7.1.0

Version:

$Revision: 19766 $ $Date: 2017-01-05 20:35:09 +0000 (Thu, 05 Jan 2017) $

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`EnvironmentConfiguration.EnvironmentConfigurationCommand` This is a environment configuration command that updates the configuration information cached.

Constructor Summary

Constructors
Constructor and Description

EnvironmentConfiguration()

Constructors
Constructor and Description
`EnvironmentConfiguration()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EnvironmentProperty`	`addProperty(String name)` Adds a property with the given name in the configuration.
`void`	`clearProperties()` Removes all environment properties.
`static void`	`clearPropertiesCache()` Clears the environment properties cache.
`protected Object`	`clone()`
`String`	`getBigDataRepositoryClassName()` Returns the class name of big data repository implementation to use.
`BigDataRepositoryType`	`getBigDataRepositoryType()` Returns the configured big data repository type.
`static EnvironmentConfiguration`	`getCurrentConfiguration()` Returns the current configuration.
`int`	`getElasticsearchBulkConcurrentRequests()` Returns the maximum number of bulk requests to be sent concurrently.
`String`	`getElasticsearchClusterName()` Returns the cluster name to use when initializing the Elasticsearch client
`String`	`getElasticsearchIndexNamePrefix()` Returns the Elasticsearch index names prefix.
`String`	`getElasticsearchNativeProtocolConnectionAddresses()` Returns the connection addresses to use when initializing the Elasticsearch native protocol client.
`String`	`getElasticsearchRestConnectionAddresses()` Returns the connection addresses to use when initializing the Elasticsearch Rest client.
`String`	`getFileSystemImplementation()` Returns the portal's file system implementation class name.
`String`	`getId()` Returns the id.
`String`	`getIdentification()` Returns the identification.
`MonitorConfiguration`	`getMonitorConfiguration()` Returns the monitor configuration.
`Map<String,List<String>>`	`getProperties()` Returns an immutable map of the environment properties.
`String`	`getPropertyValue(String propertyName)` Returns the value of the property that has the given name.
`List<String>`	`getPropertyValues(String propertyName)` Returns an immutable set of values of the property that has the given name.
`Collection<String>`	`getTags()` Returns the collection of tags this environment has.
`EnvironmentType`	`getType()` Returns the environment type.
`boolean`	`isJavaMelodyEnabled()` Returns whether the JavaMelody monitoring should be enabled next time portal starts.
`void`	`removeProperty(String name)` Removes the property that has the given name.
`void`	`setBigDataRepositoryClassName(String bigDataRepositoryClassName)` Sets the class name of big data repository implementation to use.
`void`	`setBigDataRepositoryType(BigDataRepositoryType bigDataRepositoryType)` Sets the configured big data repository type.
`void`	`setElasticsearchBulkConcurrentRequests(int elasticsearchBulkConcurrentRequests)` Sets the maximum number of bulk requests to be sent concurrently.
`void`	`setElasticsearchClusterName(String elasticsearchClusterName)` Sets the cluster name to use when initializing the Elasticsearch client
`void`	`setElasticsearchIndexNamePrefix(String elasticsearchIndexNamePrefix)` Sets the Elasticsearch index names prefix.
`void`	`setElasticsearchNativeProtocolConnectionAddresses(String addresses)` Sets the connection addresses to use when initializing the Elasticsearch native protocol client.
`void`	`setElasticsearchRestConnectionAddresses(String addresses)` Sets the connection addresses to use when initializing the Elasticsearch Rest client.
`void`	`setFileSystemImplementation(String fileSystemImplementation)` Sets the portal's file system implementation class name.
`void`	`setIdentification(String identification)` Sets the identification.
`void`	`setJavaMelodyEnabled(boolean javaMelodyEnabled)` Sets whether JavaMelody monitoring should be enabled next time portal starts.
`void`	`setTags(Collection<String> tags)` Sets the collection of tags this environment has.
`void`	`setType(EnvironmentType type)` Sets the environment type.
`static void`	`updateCurrentConfiguration(EnvironmentConfiguration config)` Returns the current configuration.

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

- Constructor Detail
  - EnvironmentConfiguration
```
public EnvironmentConfiguration()
```
- Method Detail
  - getId
```
public String getId()
```
    Returns the id.
    
    Returns:
    
    the id
    
    Since:
    
    7.1.0
  - getType
```
public EnvironmentType getType()
```
    Returns the environment type.
    
    Returns:
    
    the environment type
    
    Since:
    
    7.1.0
  - setType
```
public void setType(EnvironmentType type)
```
    Sets the environment type.
    
    Since:
    
    7.1.0
  - clone
```
protected Object clone()
                throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - getTags
```
public Collection<String> getTags()
```
    Returns the collection of tags this environment has. The returned collection is unmodifiable.
    
    Returns:
    
    the collection of tags this environment has.
    
    Since:
    
    7.1.0
  - setTags
```
public void setTags(Collection<String> tags)
```
    Sets the collection of tags this environment has.
    
    Since:
    
    7.1.0
  - getFileSystemImplementation
```
public String getFileSystemImplementation()
```
    Returns the portal's file system implementation class name.
    
    Returns:
    
    the portal's file system implementation class name.
    
    Since:
    
    8.0.0
  - setFileSystemImplementation
```
public void setFileSystemImplementation(String fileSystemImplementation)
```
    Sets the portal's file system implementation class name.
    
    Parameters:
    
    fileSystemImplementation - the portal's file system implementation class name
    
    Since:
    
    8.0.0
  - isJavaMelodyEnabled
```
public boolean isJavaMelodyEnabled()
```
    Returns whether the JavaMelody monitoring should be enabled next time portal starts.
    
    Returns:
    
    whether the JavaMelody monitoring should be enabled next time portal starts.
    
    Since:
    
    8.0.0
  - setJavaMelodyEnabled
```
public void setJavaMelodyEnabled(boolean javaMelodyEnabled)
```
    Sets whether JavaMelody monitoring should be enabled next time portal starts.
    
    Parameters:
    
    javaMelodyEnabled - whether JavaMelody monitoring should be enabled next time portal starts.
    
    Since:
    
    8.0.0
  - getBigDataRepositoryType
```
public BigDataRepositoryType getBigDataRepositoryType()
```
    Returns the configured big data repository type.
    
    Returns:
    
    the configured big data repository type.
    
    Since:
    
    8.1.0
  - setBigDataRepositoryType
```
public void setBigDataRepositoryType(BigDataRepositoryType bigDataRepositoryType)
```
    Sets the configured big data repository type.
    
    Parameters:
    
    bigDataRepositoryType - the big data repository type.
    
    Since:
    
    8.1.0
  - getBigDataRepositoryClassName
```
public String getBigDataRepositoryClassName()
```
    Returns the class name of big data repository implementation to use. Used only if getBigDataRepositoryType() is BigDataRepositoryType.CUSTOM.
    
    Returns:
    
    the big data repository class name.
    
    Since:
    
    8.1.0
  - setBigDataRepositoryClassName
```
public void setBigDataRepositoryClassName(String bigDataRepositoryClassName)
```
    Sets the class name of big data repository implementation to use. Used only if getBigDataRepositoryType() is BigDataRepositoryType.CUSTOM.
    
    Parameters:
    
    bigDataRepositoryClassName - the big data repository class name.
    
    Since:
    
    8.1.0
  - getElasticsearchClusterName
```
public String getElasticsearchClusterName()
```
    Returns the cluster name to use when initializing the Elasticsearch client
    
    Returns:
    
    the cluster name or null if not set.
    
    Since:
    
    8.1.0
  - setElasticsearchClusterName
```
public void setElasticsearchClusterName(String elasticsearchClusterName)
```
    Sets the cluster name to use when initializing the Elasticsearch client
    
    Parameters:
    
    elasticsearchClusterName - the cluster name.
    
    Since:
    
    8.1.0
  - getElasticsearchNativeProtocolConnectionAddresses
```
public String getElasticsearchNativeProtocolConnectionAddresses()
```
    Returns the connection addresses to use when initializing the Elasticsearch native protocol client. The addresses are in format of one or many "hostname:port" separated by colon.
    
    Returns:
    
    the connection addresses. Example: "host1:9300,host2:9300,192.168.1.13:9300"
    
    Since:
    
    10.0.0
  - setElasticsearchNativeProtocolConnectionAddresses
```
public void setElasticsearchNativeProtocolConnectionAddresses(String addresses)
```
    Sets the connection addresses to use when initializing the Elasticsearch native protocol client. The addresses are in format of one or many "hostname:port" separated by colon.
    
    Parameters:
    
    addresses - the connection addresses. Example: "host1:9300,host2:9300,192.168.1.13:9300"
    
    Since:
    
    10.0.0
  - getElasticsearchRestConnectionAddresses
```
public String getElasticsearchRestConnectionAddresses()
```
    Returns the connection addresses to use when initializing the Elasticsearch Rest client. The addresses are in format of one or many "hostname:port" separated by colon.
    
    Returns:
    
    the connection addresses. Example: "host1:9200,host2:9200,192.168.1.13:9200"
    
    Since:
    
    10.0.0
  - setElasticsearchRestConnectionAddresses
```
public void setElasticsearchRestConnectionAddresses(String addresses)
```
    Sets the connection addresses to use when initializing the Elasticsearch Rest client. The addresses are in format of one or many "hostname:port" separated by colon.
    
    Parameters:
    
    addresses - the connection addresses. Example: "host1:9200,host2:9200,192.168.1.13:9200"
    
    Since:
    
    10.0.0
  - getElasticsearchIndexNamePrefix
```
public String getElasticsearchIndexNamePrefix()
```
    Returns the Elasticsearch index names prefix.
    
    Returns:
    
    the Elasticsearch index names prefix.
    
    Since:
    
    8.1.0
  - setElasticsearchIndexNamePrefix
```
public void setElasticsearchIndexNamePrefix(String elasticsearchIndexNamePrefix)
```
    Sets the Elasticsearch index names prefix.
    
    Parameters:
    
    elasticsearchIndexNamePrefix - the Elasticsearch index names prefix.
    
    Since:
    
    8.1.0
  - getElasticsearchBulkConcurrentRequests
```
public int getElasticsearchBulkConcurrentRequests()
```
    Returns the maximum number of bulk requests to be sent concurrently.
    
    Returns:
    
    the maximum number of concurrent bulk requests.
    
    Since:
    
    8.1.0
  - setElasticsearchBulkConcurrentRequests
```
public void setElasticsearchBulkConcurrentRequests(int elasticsearchBulkConcurrentRequests)
```
    Sets the maximum number of bulk requests to be sent concurrently.
    
    Parameters:
    
    elasticsearchBulkConcurrentRequests - the maximum number of concurrent bulk requests.
    
    Since:
    
    8.1.0
  - getCurrentConfiguration
```
public static EnvironmentConfiguration getCurrentConfiguration()
```
    Returns the current configuration.
    
    Returns:
    
    the current configuration.
    
    Since:
    
    7.1.0
  - updateCurrentConfiguration
```
public static void updateCurrentConfiguration(EnvironmentConfiguration config)
                                       throws PortalException
```
    Returns the current configuration.
    
    Throws:
    
    PortalException
    
    Since:
    
    7.1.0
  - getIdentification
```
public String getIdentification()
```
    Returns the identification.
    
    Returns:
    
    the identification
    
    Since:
    
    8.2.0
  - setIdentification
```
public void setIdentification(String identification)
```
    Sets the identification. The identification parameter is expected to match the pattern ^[a-zA-Z0-9_]+$.
    
    Parameters:
    
    identification - the identification value to set.
    
    Since:
    
    8.2.0
  - getMonitorConfiguration
```
public MonitorConfiguration getMonitorConfiguration()
```
    Returns the monitor configuration.
    
    Returns:
    
    the monitor configuration.
    
    Since:
    
    9.0.0
  - addProperty
```
public EnvironmentProperty addProperty(String name)
                                throws PortalException
```
    Adds a property with the given name in the configuration.
    
    Parameters:
    
    name - the property name.
    
    Returns:
    
    the added property.
    
    Throws:
    
    IllegalArgumentException - if the given name is null or empty.
    
    PortalObjectAlreadyExistsException - if there's already a property with the given name.
    
    PortalException
    
    Since:
    
    8.2.0
  - removeProperty
```
public void removeProperty(String name)
```
    Removes the property that has the given name.
    
    Parameters:
    
    name - the property name.
    
    Since:
    
    8.2.0
  - clearProperties
```
public void clearProperties()
```
    Removes all environment properties.
    
    Since:
    
    8.2.0
  - getPropertyValues
```
public List<String> getPropertyValues(String propertyName)
                               throws PortalException
```
    Returns an immutable set of values of the property that has the given name.
    
    Parameters:
    
    propertyName - the desired property name.
    
    Returns:
    
    an immutable set of values of the property that has the given name.
    
    Throws:
    
    IllegalArgumentException - if property name is null or empty.
    
    PortalObjectNotFoundException - if there's no such property.
    
    PortalException
    
    Since:
    
    8.2.0
  - getPropertyValue
```
public String getPropertyValue(String propertyName)
                        throws PortalException
```
    Returns the value of the property that has the given name. If the given property has more than one value, the first will be returned.
    
    Parameters:
    
    propertyName - the desired property name.
    
    Returns:
    
    the value of the property that has the given name.
    
    Throws:
    
    IllegalArgumentException - if property name is null or empty.
    
    PortalObjectNotFoundException - if there's no such property.
    
    PortalException
    
    Since:
    
    8.2.0
  - getProperties
```
public Map<String,List<String>> getProperties()
                                       throws PortalException
```
    Returns an immutable map of the environment properties.
    
    Returns:
    
    an immutable map of the environment properties.
    
    Throws:
    
    PortalException
    
    Since:
    
    8.2.0
  - clearPropertiesCache
```
public static void clearPropertiesCache()
```
    Clears the environment properties cache.
    
    Since:
    
    8.2.0

Class EnvironmentConfiguration

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnvironmentConfiguration

Method Detail

getId

getType

setType

clone

getTags

setTags

getFileSystemImplementation

setFileSystemImplementation

isJavaMelodyEnabled

setJavaMelodyEnabled

getBigDataRepositoryType

setBigDataRepositoryType

getBigDataRepositoryClassName

setBigDataRepositoryClassName

getElasticsearchClusterName

setElasticsearchClusterName

getElasticsearchNativeProtocolConnectionAddresses

setElasticsearchNativeProtocolConnectionAddresses

getElasticsearchRestConnectionAddresses

setElasticsearchRestConnectionAddresses

getElasticsearchIndexNamePrefix

setElasticsearchIndexNamePrefix

getElasticsearchBulkConcurrentRequests

setElasticsearchBulkConcurrentRequests

getCurrentConfiguration

updateCurrentConfiguration

getIdentification

setIdentification

getMonitorConfiguration

addProperty

removeProperty

clearProperties

getPropertyValues

getPropertyValue

getProperties

clearPropertiesCache