Package lumis.portal.configuration

Class EnvironmentConfiguration

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class EnvironmentConfiguration
extends java.lang.Object
implements java.lang.Cloneable
    Holds the configuration of the LumisXP environment.
    Since:
    7.1.0
    Version:
    $Revision: 26587 $ $Date: 2024-08-26 21:09:17 -0300 (Mon, 26 Aug 2024) $

    • Constructor Detail

      • EnvironmentConfiguration

        public EnvironmentConfiguration()

    • Method Detail

      • getId

        public java.lang.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

      • getTags

        public java.util.Collection<java.lang.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​(java.util.Collection<java.lang.String> tags)
        Sets the collection of tags this environment has.
        Since:
        7.1.0

      • getFileSystemImplementation

        public java.lang.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​(java.lang.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

      • isGeolocationServiceEnabled

        public boolean isGeolocationServiceEnabled()
        Returns whether the Geolocation service is enabled.
        Returns:
        whether the Geolocation service is enabled.
        Since:
        10.2.0

      • setGeolocationServiceEnabled

        public void setGeolocationServiceEnabled​(boolean geolocationServiceEnabled)
        Sets whether the Geolocation service is enabled.
        Parameters:
        geolocationServiceEnabled - whether the Geolocation service is enabled.
        Since:
        10.2.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 java.lang.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​(java.lang.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

      • getElasticsearchRestConnectionAddresses

        public java.lang.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​(java.lang.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

      • getElasticsearchApiKey

        public java.lang.String getElasticsearchApiKey()
        The identifier of the API Key. Corresponds to the encoded returned by the create api key operation.
        Returns:
        the API Key.
        Since:
        14.2.0

      • setElasticsearchApiKey

        public void setElasticsearchApiKey​(java.lang.String elasticsearchApiKey)
        Sets identifier of the API Key. Corresponds to the encoded returned by the create api key operation.
        Parameters:
        elasticsearchApiKey - the identifier of the API Key.
        Since:
        14.2.0

      • getElasticsearchIndexNamePrefix

        public java.lang.String getElasticsearchIndexNamePrefix()
        Returns the Elasticsearch index names prefix.
        Returns:
        the Elasticsearch index names prefix.
        Since:
        8.1.0

      • setElasticsearchIndexNamePrefix

        public void setElasticsearchIndexNamePrefix​(java.lang.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

      • getEnvironmentStandardBigDataDocumentPopularityProviderConfiguration

        public EnvironmentStandardBigDataDocumentPopularityProviderConfiguration getEnvironmentStandardBigDataDocumentPopularityProviderConfiguration()
        Returns the standard big data document popularity provider configuration.
        Returns:
        the standard big data document popularity provider configuration.
        Since:
        11.1.0

      • setEnvironmentStandardBigDataDocumentPopularityProviderConfiguration

        public void setEnvironmentStandardBigDataDocumentPopularityProviderConfiguration​(EnvironmentStandardBigDataDocumentPopularityProviderConfiguration bigDataPopularityProviderConfig)
        Set the standard big data document popularity provider configuration.
        Parameters:
        the - standard big data document popularity provider configuration.
        Since:
        11.1.0

      • isUserGroupsSessionCacheEnabled

        public boolean isUserGroupsSessionCacheEnabled()
        Returns whether the user's group session cache is enabled.
        Returns:
        whether the user's group session cache is enabled.
        Since:
        10.3.0

      • setUserGroupsSessionCacheEnabled

        public void setUserGroupsSessionCacheEnabled​(boolean userGroupsSessionCacheEnabled)
        Sets whether the user's group session cache is enabled.
        Parameters:
        userGroupsSessionCacheEnabled - true if the user's group session cache is enabled.
        Since:
        10.3.0

      • getCurrentConfiguration

        public static EnvironmentConfiguration getCurrentConfiguration()
        Returns the current configuration.
        Returns:
        the current configuration.
        Since:
        7.1.0

      • getIdentification

        public java.lang.String getIdentification()
        Returns the identification.
        Returns:
        the identification
        Since:
        8.2.0

      • setIdentification

        public void setIdentification​(java.lang.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 EnvironmentMonitorConfiguration getMonitorConfiguration()
        Returns the monitor configuration.
        Returns:
        the monitor configuration.
        Since:
        9.0.0

      • getCacheUserSegmentationExpirationUnit

        public java.util.concurrent.TimeUnit getCacheUserSegmentationExpirationUnit()
        Returns the cache user segmentation member expiration unit.
        Returns:
        the cache user segmentation member expiration unit.
        Since:
        11.2.0

      • setCacheUserSegmentationExpirationUnit

        public void setCacheUserSegmentationExpirationUnit​(java.util.concurrent.TimeUnit cacheUserSegmentationExpirationUnit)
        Sets the cache user segmentation member expiration unit.
        Parameters:
        cacheUserSegmentationExpirationUnit - the cache user segmentation member expiration unit.
        Since:
        11.2.0

      • getCacheUserSegmentationExpirationAmount

        public java.lang.Long getCacheUserSegmentationExpirationAmount()
        Returns the cache user segmentation member expiration amount.
        Returns:
        the cache user segmentation member expiration amount.
        Since:
        11.2.0

      • setCacheUserSegmentationExpirationAmount

        public void setCacheUserSegmentationExpirationAmount​(java.lang.Long cacheUserSegmentationExpirationAmount)
        Sets the cache user segmentation member expiration amount.
        Parameters:
        cacheUserSegmentationExpirationAmount - the cache user segmentation member expiration amount.
        Since:
        11.2.0

      • getCacheUserSegmentationExpirationMillis

        public long getCacheUserSegmentationExpirationMillis()
        Returns the cache user segmentation expiration in milliseconds.
        Returns:
        the cache user segmentation expiration in milliseconds.
        Since:
        11.2.0

      • getUserSegmentationMaxMembers

        public java.lang.Integer getUserSegmentationMaxMembers()
        Returns the maximum number of members are calculated for each user segmentation.
        Returns:
        the maximum number of members calculated for each user segmentation.
        Since:
        12.0.0

      • setUserSegmentationMaxMembers

        public void setUserSegmentationMaxMembers​(java.lang.Integer segmentationMaxMembers)
        Sets the maximum number of members are calculated for each segmentation.
        Parameters:
        segmentationMaxMembers - the maximum number of members calculated for each segmentation.
        Since:
        12.0.0

      • addProperty

        public EnvironmentProperty addProperty​(java.lang.String name)
                                throws PortalException
        Adds a property with the given name in the configuration.
        Parameters:
        name - the property name.
        Returns:
        the added property.
        Throws:
        java.lang.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​(java.lang.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 java.util.List<java.lang.String> getPropertyValues​(java.lang.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:
        java.lang.IllegalArgumentException - if property name is null or empty.
        PortalObjectNotFoundException - if there's no such property.
        PortalException
        Since:
        8.2.0

      • getPropertyValue

        public java.lang.String getPropertyValue​(java.lang.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:
        java.lang.IllegalArgumentException - if property name is null or empty.
        PortalObjectNotFoundException - if there's no such property.
        PortalException
        Since:
        8.2.0

      • getProperties

        public java.util.Map<java.lang.String,​java.util.List<java.lang.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

      • getMaxLoginFailures

        public java.lang.Integer getMaxLoginFailures()
        Returns the maximum number of login failures before a given user is blocked.
        Returns:
        the maximum number of login failures before a given user is blocked.
        Since:
        12.0.0

      • getMaxLoginFailuresOrDefault

        public java.lang.Integer getMaxLoginFailuresOrDefault()
        Returns the maximum number of login failures before a given user is blocked or the default value.
        Returns:
        the maximum number of login failures before a given user is blocked or the default value.
        Since:
        12.0.0

      • setMaxLoginFailures

        public void setMaxLoginFailures​(java.lang.Integer maxLoginFailures)
        Set the maximum number of login failures before a given user is blocked.
        Parameters:
        maxLoginFailures -
        Since:
        12.0.0

      • getElasticsearchFlushInterval

        public java.lang.Integer getElasticsearchFlushInterval()
        Returns the interval in milliseconds for flush elastic search data.
        Returns:
        The interval in milliseconds for flush elastic search data.
        Since:
        12.0.0

      • setElasticsearchFlushInterval

        public void setElasticsearchFlushInterval​(java.lang.Integer elasticsearchFlushInterval)
        Sets the interval in milliseconds for flush elastic search data.
        Parameters:
        elasticsearchFlushInterval - The interval in milliseconds for flush elastic search data value to set.
        Since:
        12.0.0

      • getGeoLocationIPAddressUpdateLicenseKey

        public java.lang.String getGeoLocationIPAddressUpdateLicenseKey()
        Returns the geoLocationIPAddressUpdateLicenseKey.
        Returns:
        the geoLocationIPAddressUpdateLicenseKey
        Since:
        12.2.0

      • setGeoLocationIPAddressUpdateLicenseKey

        public void setGeoLocationIPAddressUpdateLicenseKey​(java.lang.String geoLocationIPAddressUpdateLicenseKey)
        Sets the geoLocationIPAddressUpdateLicenseKey.
        Parameters:
        geoLocationIPAddressUpdateLicenseKey - the geoLocationIPAddressUpdateLicenseKey value to set.
        Since:
        12.2.0

      • setActivityAnonymizationPolicy

        public void setActivityAnonymizationPolicy​(EnvironmentConfiguration.ActivityAnonymizationPolicy activityAnonymizationPolicy)
        Sets the activityAnonymizationPolicy.
        Parameters:
        activityAnonymizationPolicy - the dataPrivacyAnonymizedActivities value to set.
        Since:
        12.3.0

      • isDataPrivacySystemEnabled

        public boolean isDataPrivacySystemEnabled()
        Returns the dataPrivacySystemEnabled.
        Returns:
        the dataPrivacySystemEnabled
        Since:
        12.3.0

      • setDataPrivacySystemEnabled

        public void setDataPrivacySystemEnabled​(boolean dataPrivacySystemEnabled)
        Sets the dataPrivacySystemEnabled.
        Parameters:
        dataPrivacySystemEnabled - the dataPrivacySystemEnabled value to set.
        Since:
        12.3.0

      • getMfaServiceInstance

        public java.lang.String getMfaServiceInstance()
                                       throws PortalException
        Returns the mfaServiceInstance Id
        Returns:
        the mfaServiceInstance Id
        Throws:
        PortalException
        Since:
        16.1.0

      • setMfaServiceInstance

        public void setMfaServiceInstance​(java.lang.String mfaServiceInstance)
        Sets the mfaServiceInstance Id value
        Parameters:
        mfaServiceInstance - the mfa Service Instance value to set
        Since:
        16.1.0

      • getUserPwdMinLength

        public java.lang.Integer getUserPwdMinLength()
        Returns user's password minimum length
        Returns:
        the user's password minimum length
        Since:
        17.0.0

      • setUserPwdMinLength

        public void setUserPwdMinLength​(java.lang.Integer userPwdMinLength)
        Sets the user's password minimum length
        Parameters:
        userPwdMinLength - the user's password minimum length
        Since:
        17.0.0

      • isUserPwdReqLetterLc

        public boolean isUserPwdReqLetterLc()
        Returns if user's password requires at least one letter in lower case
        Returns:
        if user's password requires at least one letter in lower case
        Since:
        17.0.0

      • setUserPwdReqLetterLc

        public void setUserPwdReqLetterLc​(boolean userPwdReqLetterLc)
        Sets if user's password requires at least one letter in lower case
        Parameters:
        userPwdReqLetterLc - true if user's password requires at least one letter in lower case
        Since:
        17.0.0

      • isUserPwdReqLetterUc

        public boolean isUserPwdReqLetterUc()
        Returns if user's password requires at least one letter in upper case
        Returns:
        if user's password requires at least one letter in upper case
        Since:
        17.0.0

      • setUserPwdReqLetterUc

        public void setUserPwdReqLetterUc​(boolean userPwdReqLetterUc)
        Sets if user's password requires at least one letter in lower case
        Parameters:
        userPwdReqLetterUc - true if user's password requires at least one letter in upper case
        Since:
        17.0.0

      • isUserPwdReqNumber

        public boolean isUserPwdReqNumber()
        Returns if user's password requires at least one number
        Returns:
        if user's password requires at least one number
        Since:
        17.0.0

      • setUserPwdReqNumber

        public void setUserPwdReqNumber​(boolean userPwdReqNumber)
        Sets if user's password requires at least one number
        Parameters:
        userPwdReqNumber - true if user's password requires at least one number
        Since:
        17.0.0

      • isUserPwdReqOther

        public boolean isUserPwdReqOther()
        Returns if user's password requires at least one special character
        Returns:
        if user's password requires at least one special character
        Since:
        17.0.0

      • setUserPwdReqOther

        public void setUserPwdReqOther​(boolean userPwdReqOther)
        Sets if user's password requires at least one special character
        Parameters:
        userPwdReqOther - true if user's password requires at least special character
        Since:
        17.0.0

      • getUserSegmentationConfiguration

        public UserSegmentationConfiguration getUserSegmentationConfiguration()
        Returns the user segmentation configuration.
        Returns:
        the user segmentation configuration
        Since:
        17.0.0