Package pl.edu.icm.unity.engine.api.config

Class UnityServerConfiguration

java.lang.Object

eu.unicore.util.configuration.PropertiesHelper

eu.unicore.util.configuration.FilePropertiesHelper

pl.edu.icm.unity.engine.api.config.UnityFilePropertiesHelper

pl.edu.icm.unity.engine.api.config.UnityServerConfiguration

All Implemented Interfaces:

eu.unicore.util.configuration.PropertiesHelperAPI, eu.unicore.util.configuration.UpdateableConfiguration, Cloneable, Runnable

@Component
public class UnityServerConfiguration
extends UnityFilePropertiesHelper

Principal options are defined here: ids and corresponding default values.

Author:

K. Benedyczak

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UnityServerConfiguration.LogoutMode

Field Summary

Fields

Modifier and Type	Field	Description
static String	ACCOUNT_ACTIVATED_NOTIFICATION
static String	ACCOUNT_DISABLED_NOTIFICATION
static String	ACCOUNT_REMOVED_NOTIFICATION
static String	ALLOW_FULL_HTML
static String	AUDITEVENTLOGS_ENABLED
static String	AUTHENTICATION_FLOW
static String	AUTHENTICATION_FLOW_FIRST_FACTOR_AUTHENTICATORS
static String	AUTHENTICATION_FLOW_NAME
static String	AUTHENTICATION_FLOW_POLICY
static String	AUTHENTICATION_FLOW_SECOND_FACTOR_AUTHENTICATORS
static String	AUTHENTICATOR_CREDENTIAL
static String	AUTHENTICATOR_NAME
static String	AUTHENTICATOR_TYPE
static String	AUTHENTICATOR_VERIFICATOR_CONFIG
static String	AUTHENTICATORS
static String	AUTHZ_CACHE_MS
static String	BASE_PREFIX
static String	CONFIG_ONLY_ERA_CONTROL
static String	CONFIGURATION_FILE
static String	CONFIRMATION_AUTO_REDIRECT
static String	CONFIRMATION_DEFAULT_RETURN_URL
static String	CONFIRMATION_TEMPLATE
static String	CONFIRMATION_THEME
static String	CREDENTIAL_CONFIGURATION
static String	CREDENTIAL_DESCRIPTION
static String	CREDENTIAL_NAME
static String	CREDENTIAL_REQ_CONTENTS
static String	CREDENTIAL_REQ_DESCRIPTION
static String	CREDENTIAL_REQ_NAME
static String	CREDENTIAL_REQS
static String	CREDENTIAL_TYPE
static String	CREDENTIALS
static String	DEFAULT_EMAIL_CHANNEL
static String	DEFAULT_LOCALE
static String	DEFAULT_SMS_CHANNEL
static String	DEFAULT_WEB_CONTENT_PATH
static String	DEFAULT_WEB_PATH
static Map<String,eu.unicore.util.configuration.PropertyMD>	defaults
static String	EMAIL_CONFIRMATION_REQUEST_LIMIT
static String	EMAIL_CONFIRMATION_REQUEST_LIMIT_OLD
static String	ENABLE_LOW_LEVEL_EVENTS
static String	ENABLED_LOCALES
static String	ENDPOINT_ADDRESS
static String	ENDPOINT_AUTHENTICATORS
static String	ENDPOINT_CONFIGURATION
static String	ENDPOINT_DESCRIPTION
static String	ENDPOINT_DISPLAYED_NAME
static String	ENDPOINT_NAME
static String	ENDPOINT_REALM
static String	ENDPOINT_TYPE
static String	ENDPOINTS
static String	EXTENSION_PFX
static String	EXTERNAL_NOTIFICATION_FILE
static String	EXTERNAL_NOTIFICATION_NAME
static String	EXTERNAL_NOTIFICATION_PFX
static String	EXTERNAL_NOTIFICATION_SUPPORTS_TEMPLATES
static String	FILE_SIZE_LIMIT
static String	IGNORE_CONFIGURED_CONTENTS_SETTING
static String	IMPORT_PFX
static String	INITIAL_ADMIN_PASSWORD
static String	INITIAL_ADMIN_USER
static String	INITIAL_ADMIN_USER_OUTDATED
static String	INITIALIZERS
static String	LOGOUT_MODE
static String	MAIL_CONF
static String	MAIN_CREDENTIAL
static String	MAIN_TRUSTSTORE
static String	MAX_CONCURRENT_PASSWORD_CHECKS
static String	MAX_REMOTE_AUTHN_TIME_S
static String	MESSAGES_DIRECTORY
static String	MOBILE_CONFIRMATION_REQUEST_LIMIT
static String	P
static String	PKI_CONF
static String	PROFILE_PRODUCTION
static String	RE_AUTHENTICATION_BLOCK_ON_NONE
static String	RE_AUTHENTICATION_GRACE_TIME
static String	RE_AUTHENTICATION_POLICY
static String	REALM_BLOCK_AFTER_UNSUCCESSFUL
static String	REALM_BLOCK_FOR
static String	REALM_DESCRIPTION
static String	REALM_MAX_INACTIVITY
static String	REALM_NAME
static String	REALM_REMEMBER_ME_FOR
static String	REALM_REMEMBER_ME_POLICY
static String	REALMS
static String	REDIRECT_MODE
static String	RELOAD_MSG_TEMPLATES
static String	RESTRICT_FILE_SYSTEM_ACCESS
static String	SCRIPT_FILE
static String	SCRIPT_TRIGGER
static String	SCRIPT_TYPE
static String	SCRIPTS
static String	SMS_CONF
static Map<String,Locale>	SUPPORTED_LOCALES
static String	SYSTEM_ALLOW_FULL_HTML
static String	TEMPLATES_CONF
static String	THEME
static String	THREAD_POOL_SIZE
static String	TRANSLATION_PROFILES
static String	UNITYGW_WEB_CONTENT_PATH
static String	UPDATE_INTERVAL
static String	USE_CONFIG_FILE_AS_INITIAL_TEMPLATE_ONLY
static String	WELL_KNOWN_URL_TEMPLATE
static String	WELL_KNOWN_URL_THEME
static String	WORKSPACE_DIRECTORY

Fields inherited from class eu.unicore.util.configuration.FilePropertiesHelper

file, lastAccess

Fields inherited from class eu.unicore.util.configuration.PropertiesHelper

genericListeners, metadata, prefix, properties, propertyFocusedListeners, structuredPrefixes

Constructor Summary

Constructors

Constructor	Description
UnityServerConfiguration(org.springframework.core.env.Environment env, ConfigurationLocationProvider locProvider)

Method Summary

Modifier and Type	Method	Description
String	getConfiguredTheme(String themeConfigKey, String defaultTheme)	Returns either a theme configured with the key given as argument or the default theme if the specific one is not defined.
List<ScriptConfiguration>	getContentInitializersConfiguration()
Locale	getDefaultLocale()
int	getEmailConfirmationRequestLimit()
Map<String,Locale>	getEnabledLocales()
List<String>	getEndpointAuth(String endpointKey)
int	getFileSizeLimit()
UnityHttpServerConfiguration	getJettyProperties()
int	getMaxConcurrentPasswordChecks()
UnityPKIConfiguration	getPKIConfiguration()
Properties	getProperties()
List<String>	getSortedListKeys(String listPrefix)
boolean	isLocaleSupported(Locale toSearch)
static Locale	safeLocaleDecode(String inputRaw)

Methods inherited from class pl.edu.icm.unity.engine.api.config.UnityFilePropertiesHelper

getLocalizedString

Methods inherited from class eu.unicore.util.configuration.FilePropertiesHelper

getFile, hasFileChanged, load, load, reload, reloadIfChanged, run

Methods inherited from class eu.unicore.util.configuration.PropertiesHelper

addPropertyChangeListener, canHaveSubkeys, checkBounds, checkConstraints, checkConstraints, checkDeprecated, checkPropertyConstraints, checkStructuredListConstraints, clone, cloneTo, filterChanged, findUnknown, getBooleanValue, getClassValue, getDoubleValue, getDoubleValueNoCheck, getEnumValue, getFileValue, getFileValueAsString, getIntValue, getIntValueNoCheck, getKeyDescription, getListOfValues, getLocalizedValue, getLongValue, getLongValueNoCheck, getMetadata, getMetadataKey, getRawProperty, getSortedNumKeys, getSortedStringKeys, getStructuredListKeys, getSubkeyBooleanValue, getSubkeyEnumValue, getSubkeyIntValue, getSubkeyLongValue, getSubkeyValue, getValue, isSet, logValue, notifyAllWithKey, notifyFocusedListeners, notifyGenericListeners, removePropertyChangeListener, setProperties, setProperty

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROFILE_PRODUCTION

public static final String PROFILE_PRODUCTION

See Also:

Constant Field Values

CONFIGURATION_FILE

public static final String CONFIGURATION_FILE

See Also:

Constant Field Values

DEFAULT_EMAIL_CHANNEL

public static final String DEFAULT_EMAIL_CHANNEL

See Also:

Constant Field Values

DEFAULT_SMS_CHANNEL

public static final String DEFAULT_SMS_CHANNEL

See Also:

Constant Field Values

SYSTEM_ALLOW_FULL_HTML

public static final String SYSTEM_ALLOW_FULL_HTML

See Also:

Constant Field Values

BASE_PREFIX

public static final String BASE_PREFIX

See Also:

Constant Field Values

P

public static final String P

See Also:

Constant Field Values

ENABLED_LOCALES

public static final String ENABLED_LOCALES

See Also:

Constant Field Values

DEFAULT_LOCALE

public static final String DEFAULT_LOCALE

See Also:

Constant Field Values

MAIL_CONF

public static final String MAIL_CONF

See Also:

Constant Field Values

SMS_CONF

public static final String SMS_CONF

See Also:

Constant Field Values

TEMPLATES_CONF

public static final String TEMPLATES_CONF

See Also:

Constant Field Values

PKI_CONF

public static final String PKI_CONF

See Also:

Constant Field Values

THREAD_POOL_SIZE

public static final String THREAD_POOL_SIZE

See Also:

Constant Field Values

USE_CONFIG_FILE_AS_INITIAL_TEMPLATE_ONLY

public static final String USE_CONFIG_FILE_AS_INITIAL_TEMPLATE_ONLY

See Also:

Constant Field Values

IGNORE_CONFIGURED_CONTENTS_SETTING

public static final String IGNORE_CONFIGURED_CONTENTS_SETTING

See Also:

Constant Field Values

RELOAD_MSG_TEMPLATES

public static final String RELOAD_MSG_TEMPLATES

See Also:

Constant Field Values

CONFIG_ONLY_ERA_CONTROL

public static final String CONFIG_ONLY_ERA_CONTROL

See Also:

Constant Field Values

LOGOUT_MODE

public static final String LOGOUT_MODE

See Also:

Constant Field Values

DEFAULT_WEB_CONTENT_PATH

public static final String DEFAULT_WEB_CONTENT_PATH

See Also:

Constant Field Values

MESSAGES_DIRECTORY

public static final String MESSAGES_DIRECTORY

See Also:

Constant Field Values

THEME

public static final String THEME

See Also:

Constant Field Values

CONFIRMATION_THEME

public static final String CONFIRMATION_THEME

See Also:

Constant Field Values

CONFIRMATION_TEMPLATE

public static final String CONFIRMATION_TEMPLATE

See Also:

Constant Field Values

WELL_KNOWN_URL_THEME

public static final String WELL_KNOWN_URL_THEME

See Also:

Constant Field Values

WELL_KNOWN_URL_TEMPLATE

public static final String WELL_KNOWN_URL_TEMPLATE

See Also:

Constant Field Values

UNITYGW_WEB_CONTENT_PATH

public static final String UNITYGW_WEB_CONTENT_PATH

See Also:

Constant Field Values

ALLOW_FULL_HTML

public static final String ALLOW_FULL_HTML

See Also:

Constant Field Values

DEFAULT_WEB_PATH

public static final String DEFAULT_WEB_PATH

See Also:

Constant Field Values

REDIRECT_MODE

public static final String REDIRECT_MODE

See Also:

Constant Field Values

AUDITEVENTLOGS_ENABLED

public static final String AUDITEVENTLOGS_ENABLED

See Also:

Constant Field Values

IMPORT_PFX

public static final String IMPORT_PFX

See Also:

Constant Field Values

ENDPOINTS

public static final String ENDPOINTS

See Also:

Constant Field Values

ENDPOINT_DESCRIPTION

public static final String ENDPOINT_DESCRIPTION

See Also:

Constant Field Values

ENDPOINT_TYPE

public static final String ENDPOINT_TYPE

See Also:

Constant Field Values

ENDPOINT_CONFIGURATION

public static final String ENDPOINT_CONFIGURATION

See Also:

Constant Field Values

ENDPOINT_ADDRESS

public static final String ENDPOINT_ADDRESS

See Also:

Constant Field Values

ENDPOINT_NAME

public static final String ENDPOINT_NAME

See Also:

Constant Field Values

ENDPOINT_DISPLAYED_NAME

public static final String ENDPOINT_DISPLAYED_NAME

See Also:

Constant Field Values

ENDPOINT_AUTHENTICATORS

public static final String ENDPOINT_AUTHENTICATORS

See Also:

Constant Field Values

ENDPOINT_REALM

public static final String ENDPOINT_REALM

See Also:

Constant Field Values

INITIALIZERS

public static final String INITIALIZERS

See Also:

Constant Field Values

UPDATE_INTERVAL

public static final String UPDATE_INTERVAL

See Also:

Constant Field Values

WORKSPACE_DIRECTORY

public static final String WORKSPACE_DIRECTORY

See Also:

Constant Field Values

MAIN_CREDENTIAL

public static final String MAIN_CREDENTIAL

See Also:

Constant Field Values

MAIN_TRUSTSTORE

public static final String MAIN_TRUSTSTORE

See Also:

Constant Field Values

REALMS

public static final String REALMS

See Also:

Constant Field Values

REALM_NAME

public static final String REALM_NAME

See Also:

Constant Field Values

REALM_DESCRIPTION

public static final String REALM_DESCRIPTION

See Also:

Constant Field Values

REALM_BLOCK_AFTER_UNSUCCESSFUL

public static final String REALM_BLOCK_AFTER_UNSUCCESSFUL

See Also:

Constant Field Values

REALM_BLOCK_FOR

public static final String REALM_BLOCK_FOR

See Also:

Constant Field Values

REALM_MAX_INACTIVITY

public static final String REALM_MAX_INACTIVITY

See Also:

Constant Field Values

REALM_REMEMBER_ME_FOR

public static final String REALM_REMEMBER_ME_FOR

See Also:

Constant Field Values

REALM_REMEMBER_ME_POLICY

public static final String REALM_REMEMBER_ME_POLICY

See Also:

Constant Field Values

AUTHENTICATORS

public static final String AUTHENTICATORS

See Also:

Constant Field Values

AUTHENTICATOR_NAME

public static final String AUTHENTICATOR_NAME

See Also:

Constant Field Values

AUTHENTICATOR_TYPE

public static final String AUTHENTICATOR_TYPE

See Also:

Constant Field Values

AUTHENTICATOR_CREDENTIAL

public static final String AUTHENTICATOR_CREDENTIAL

See Also:

Constant Field Values

AUTHENTICATOR_VERIFICATOR_CONFIG

public static final String AUTHENTICATOR_VERIFICATOR_CONFIG

See Also:

Constant Field Values

AUTHENTICATION_FLOW

public static final String AUTHENTICATION_FLOW

See Also:

Constant Field Values

AUTHENTICATION_FLOW_NAME

public static final String AUTHENTICATION_FLOW_NAME

See Also:

Constant Field Values

AUTHENTICATION_FLOW_POLICY

public static final String AUTHENTICATION_FLOW_POLICY

See Also:

Constant Field Values

AUTHENTICATION_FLOW_FIRST_FACTOR_AUTHENTICATORS

public static final String AUTHENTICATION_FLOW_FIRST_FACTOR_AUTHENTICATORS

See Also:

Constant Field Values

AUTHENTICATION_FLOW_SECOND_FACTOR_AUTHENTICATORS

public static final String AUTHENTICATION_FLOW_SECOND_FACTOR_AUTHENTICATORS

See Also:

Constant Field Values

RE_AUTHENTICATION_POLICY

public static final String RE_AUTHENTICATION_POLICY

See Also:

Constant Field Values

RE_AUTHENTICATION_GRACE_TIME

public static final String RE_AUTHENTICATION_GRACE_TIME

See Also:

Constant Field Values

RE_AUTHENTICATION_BLOCK_ON_NONE

public static final String RE_AUTHENTICATION_BLOCK_ON_NONE

See Also:

Constant Field Values

CREDENTIALS

public static final String CREDENTIALS

See Also:

Constant Field Values

CREDENTIAL_NAME

public static final String CREDENTIAL_NAME

See Also:

Constant Field Values

CREDENTIAL_TYPE

public static final String CREDENTIAL_TYPE

See Also:

Constant Field Values

CREDENTIAL_DESCRIPTION

public static final String CREDENTIAL_DESCRIPTION

See Also:

Constant Field Values

CREDENTIAL_CONFIGURATION

public static final String CREDENTIAL_CONFIGURATION

See Also:

Constant Field Values

CREDENTIAL_REQS

public static final String CREDENTIAL_REQS

See Also:

Constant Field Values

CREDENTIAL_REQ_NAME

public static final String CREDENTIAL_REQ_NAME

See Also:

Constant Field Values

CREDENTIAL_REQ_DESCRIPTION

public static final String CREDENTIAL_REQ_DESCRIPTION

See Also:

Constant Field Values

CREDENTIAL_REQ_CONTENTS

public static final String CREDENTIAL_REQ_CONTENTS

See Also:

Constant Field Values

INITIAL_ADMIN_USER

public static final String INITIAL_ADMIN_USER

See Also:

Constant Field Values

INITIAL_ADMIN_PASSWORD

public static final String INITIAL_ADMIN_PASSWORD

See Also:

Constant Field Values

INITIAL_ADMIN_USER_OUTDATED

public static final String INITIAL_ADMIN_USER_OUTDATED

See Also:

Constant Field Values

TRANSLATION_PROFILES

public static final String TRANSLATION_PROFILES

See Also:

Constant Field Values

EMAIL_CONFIRMATION_REQUEST_LIMIT_OLD

public static final String EMAIL_CONFIRMATION_REQUEST_LIMIT_OLD

See Also:

Constant Field Values

EMAIL_CONFIRMATION_REQUEST_LIMIT

public static final String EMAIL_CONFIRMATION_REQUEST_LIMIT

See Also:

Constant Field Values

CONFIRMATION_DEFAULT_RETURN_URL

public static final String CONFIRMATION_DEFAULT_RETURN_URL

See Also:

Constant Field Values

CONFIRMATION_AUTO_REDIRECT

public static final String CONFIRMATION_AUTO_REDIRECT

See Also:

Constant Field Values

ACCOUNT_REMOVED_NOTIFICATION

public static final String ACCOUNT_REMOVED_NOTIFICATION

See Also:

Constant Field Values

ACCOUNT_DISABLED_NOTIFICATION

public static final String ACCOUNT_DISABLED_NOTIFICATION

See Also:

Constant Field Values

ACCOUNT_ACTIVATED_NOTIFICATION

public static final String ACCOUNT_ACTIVATED_NOTIFICATION

See Also:

Constant Field Values

MOBILE_CONFIRMATION_REQUEST_LIMIT

public static final String MOBILE_CONFIRMATION_REQUEST_LIMIT

See Also:

Constant Field Values

AUTHZ_CACHE_MS

public static final String AUTHZ_CACHE_MS

See Also:

Constant Field Values

MAX_REMOTE_AUTHN_TIME_S

public static final String MAX_REMOTE_AUTHN_TIME_S

See Also:

Constant Field Values

SCRIPTS

public static final String SCRIPTS

See Also:

Constant Field Values

SCRIPT_FILE

public static final String SCRIPT_FILE

See Also:

Constant Field Values

SCRIPT_TYPE

public static final String SCRIPT_TYPE

See Also:

Constant Field Values

SCRIPT_TRIGGER

public static final String SCRIPT_TRIGGER

See Also:

Constant Field Values

EXTERNAL_NOTIFICATION_PFX

public static final String EXTERNAL_NOTIFICATION_PFX

See Also:

Constant Field Values

EXTERNAL_NOTIFICATION_NAME

public static final String EXTERNAL_NOTIFICATION_NAME

See Also:

Constant Field Values

EXTERNAL_NOTIFICATION_SUPPORTS_TEMPLATES

public static final String EXTERNAL_NOTIFICATION_SUPPORTS_TEMPLATES

See Also:

Constant Field Values

EXTERNAL_NOTIFICATION_FILE

public static final String EXTERNAL_NOTIFICATION_FILE

See Also:

Constant Field Values

ENABLE_LOW_LEVEL_EVENTS

public static final String ENABLE_LOW_LEVEL_EVENTS

See Also:

Constant Field Values

RESTRICT_FILE_SYSTEM_ACCESS

public static final String RESTRICT_FILE_SYSTEM_ACCESS

See Also:

Constant Field Values

FILE_SIZE_LIMIT

public static final String FILE_SIZE_LIMIT

See Also:

Constant Field Values

MAX_CONCURRENT_PASSWORD_CHECKS

public static final String MAX_CONCURRENT_PASSWORD_CHECKS

See Also:

Constant Field Values

EXTENSION_PFX

public static final String EXTENSION_PFX

See Also:

Constant Field Values

defaults

public static final Map<String,eu.unicore.util.configuration.PropertyMD> defaults

SUPPORTED_LOCALES

public static final Map<String,Locale> SUPPORTED_LOCALES

Constructor Detail

UnityServerConfiguration

@Autowired
public UnityServerConfiguration(org.springframework.core.env.Environment env,
                                ConfigurationLocationProvider locProvider)
                         throws eu.unicore.util.configuration.ConfigurationException,
                                IOException

Throws:

eu.unicore.util.configuration.ConfigurationException

IOException

Method Detail

isLocaleSupported

public boolean isLocaleSupported(Locale toSearch)

safeLocaleDecode

public static Locale safeLocaleDecode(String inputRaw)

getJettyProperties

public UnityHttpServerConfiguration getJettyProperties()

getDefaultLocale

public Locale getDefaultLocale()

getEnabledLocales

public Map<String,Locale> getEnabledLocales()

getPKIConfiguration

public UnityPKIConfiguration getPKIConfiguration()

getFileSizeLimit

public int getFileSizeLimit()

getEndpointAuth

public List<String> getEndpointAuth(String endpointKey)

getConfiguredTheme

public String getConfiguredTheme(String themeConfigKey,
                                 String defaultTheme)

Returns either a theme configured with the key given as argument or the default theme if the specific one is not defined. If neither is available returns default theme.

Parameters:

themeConfigKey -

Returns:

configuration theme

getContentInitializersConfiguration

public List<ScriptConfiguration> getContentInitializersConfiguration()

getSortedListKeys

public List<String> getSortedListKeys(String listPrefix)

Returns:

list of keys which have a common prefix 'listPrefix'. Values have only the suffix.

getProperties

public Properties getProperties()

getEmailConfirmationRequestLimit

public int getEmailConfirmationRequestLimit()

getMaxConcurrentPasswordChecks

public int getMaxConcurrentPasswordChecks()