Package com.atlassian.crowd.manager.property

Class PropertyManagerGeneric

java.lang.Object

com.atlassian.crowd.manager.property.PropertyManagerGeneric

All Implemented Interfaces:

InternalPropertyManager, PropertyManager

@Transactional
public class PropertyManagerGeneric
extends Object
implements InternalPropertyManager

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_SCHEDULED_BACKUP_HOUR
static final int	DEFAULT_SCHEDULED_BACKUP_MINUTE
static final String	IMAGE_TOO_LARGE_ERROR_MESSAGE
static final String	LOGO_IMAGE_KEY
static final int	MAX_LOGO_SIZE_IN_BYTES
static final Set<LookAndFeelConstants.ImageType>	SUPPORTED_LOGO_TYPES

Constructor Summary

Constructors

Constructor	Description
PropertyManagerGeneric(PropertyDAO propertyDAO, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method	Description
void	generateDesEncryptionKey()	Generates and stores a DES key for DES encoded passwords.
AuditLogConfiguration	getAuditLogConfiguration()	Retrieves the audit log configuration
BackupConfiguration	getBackupConfiguration()
URI	getBaseUrl()
boolean	getBoolean(String property, boolean defaultValue)	Gets a boolean property.
Integer	getBuildNumber()	This method returns the current build number for Crowd from the datastore.
CookieConfiguration	getCookieConfiguration()
int	getCurrentLicenseResourceTotal()
String	getDeploymentTitle()
Key	getDesEncryptionKey()
String	getDomain()	Will return the Domain property from the datastore or null if the domain has not been set.
int	getInt(String property, int defaultValue)	Gets an integer property.
int	getIntOrThrowIllegalArgumentException(String property, int defaultValue)
Optional<ImageInfo>	getLogoImage()
Optional<LookAndFeelConfiguration>	getLookAndFeelConfiguration()
String	getNotificationEmail()
List<String>	getNotificationEmails()
Optional<String>	getOptionalProperty(String name)	Retrieves an arbitrary property by name.
Optional<Long>	getPrivateKeyCertificatePairToSign()
String	getProperty(String name)	Retrieves an arbitrary property by name.
protected Property	getPropertyObject(String name)
CrowdSpecificRememberMeSettings	getRememberMeConfiguration()	Retrieves remember me configuration
long	getSessionTime()
SMTPServer	getSMTPServer()
String	getSMTPTemplate()	Deprecated.
String	getString(String property, String defaultValue)	Gets a string property.
String	getTrustedProxyServers()	Retrieves a String that contains a list of proxy servers we trust to correctly set the X-Forwarded-For flag.
boolean	isCacheEnabled()
boolean	isGzipEnabled()
boolean	isIncludeIpAddressInValidationFactors()	Should the client IP address be included as a validation factor?
boolean	isSecureCookie()
boolean	isUseWebAvatars()	Should public services be used for user avatars?
boolean	isUsingDatabaseTokenStorage()	Will return true if the Crowd instance is using database token storage for authentication Token's otherwise assume we are using in-memory
void	removeLookAndFeelConfiguration()	Removes Look and Feel configuration
void	removeProperty(String name)	Will attempt to remove a property from the datastore
void	saveBackupConfiguration(BackupConfiguration config)	Saves backup configuration
void	setAuditLogConfiguration(AuditLogConfiguration newConfiguration)	Persists the audit log configuration
void	setBaseUrl(URI url)	Sets the base URL for this Crowd application instance
void	setBuildNumber(Integer buildNumber)	Will set the buildNumber for the current release of Crowd.
void	setCacheEnabled(boolean enabled)
void	setCookieConfiguration(CookieConfiguration cookieConfiguration)	Updates the configuration of Crowd's cookie-based SSO
void	setCurrentLicenseResourceTotal(int total)
void	setDeploymentTitle(String title)
void	setDomain(String domain)
void	setGzipEnabled(boolean gzip)
void	setIncludeIpAddressInValidationFactors(boolean includeIpAddressInValidationFactors)
void	setLookAndFeelConfiguration(LookAndFeelConfiguration lookAndFeelConfiguration, ImageInfo updatedLogoInfo)	Sets Look and Feel configuration
void	setNotificationEmail(String notificationEmail)
void	setNotificationEmails(List<String> serverAlertAddresses)	Sets notification emails.
void	setPrivateKeyCertificateToSign(long privateKeyCertificatePairId)	Sets ID of private key/certificate pair used to sign assertions in SAML
void	setProperty(String name, String value)	Sets an arbitrary property.
void	setRememberMeConfiguration(CrowdSpecificRememberMeSettings configuration)	Sets remember me configuration
void	setSecureCookie(boolean secure)
void	setSessionTime(long time)
void	setSMTPServer(SMTPServer server)
void	setSMTPTemplate(String template)	Deprecated.
void	setTrustedProxyServers(String proxyServers)	Persists a String containing a list of proxy servers we trust to correctly set the X-Forwarded-For flag.
void	setUseWebAvatars(boolean useWebAvatars)
void	setUsingDatabaseTokenStorage(boolean isUsingDatabaseTokenStorage)	Will set a property to state that this crowd instance is using database token storage, otherwise assume we are using in-memory

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_SCHEDULED_BACKUP_HOUR

public static final int DEFAULT_SCHEDULED_BACKUP_HOUR

See Also:

• Constant Field Values

DEFAULT_SCHEDULED_BACKUP_MINUTE

public static final int DEFAULT_SCHEDULED_BACKUP_MINUTE

See Also:

• Constant Field Values

SUPPORTED_LOGO_TYPES

public static final Set<LookAndFeelConstants.ImageType> SUPPORTED_LOGO_TYPES

MAX_LOGO_SIZE_IN_BYTES

public static final int MAX_LOGO_SIZE_IN_BYTES

See Also:

• Constant Field Values

LOGO_IMAGE_KEY

public static final String LOGO_IMAGE_KEY

See Also:

• Constant Field Values

IMAGE_TOO_LARGE_ERROR_MESSAGE

public static final String IMAGE_TOO_LARGE_ERROR_MESSAGE

See Also:

• Constant Field Values

Constructor Details

PropertyManagerGeneric

public PropertyManagerGeneric(PropertyDAO propertyDAO,
 com.atlassian.event.api.EventPublisher eventPublisher)

Method Details

getDeploymentTitle

public String getDeploymentTitle()
                          throws PropertyManagerException

Specified by:

getDeploymentTitle in interface PropertyManager

Returns:

deployment title.

Throws:

PropertyManagerException - property does not exist.

setDeploymentTitle

public void setDeploymentTitle(String title)

Specified by:

setDeploymentTitle in interface PropertyManager

Parameters:

title - deployment title.

getDomain

public String getDomain()

Description copied from interface: PropertyManager

Will return the Domain property from the datastore or null if the domain has not been set.

Specified by:

getDomain in interface PropertyManager

Returns:

domain or null

setDomain

public void setDomain(String domain)

Specified by:

setDomain in interface PropertyManager

Parameters:

domain - SSO cookie domain.

isSecureCookie

public boolean isSecureCookie()

Specified by:

isSecureCookie in interface PropertyManager

Returns:

true if the "secure" flag should be set on the SSO cookie.

setSecureCookie

public void setSecureCookie(boolean secure)

Specified by:

setSecureCookie in interface PropertyManager

Parameters:

secure - true if the "secure" flag should be set on the SSO cookie.

setCacheEnabled

public void setCacheEnabled(boolean enabled)

Specified by:

setCacheEnabled in interface PropertyManager

Parameters:

enabled - true if application authorisation caching should be used on the server-side.

isCacheEnabled

public boolean isCacheEnabled()

Specified by:

isCacheEnabled in interface PropertyManager

Returns:

true if application authorisation caching is used on the server-side.

getSessionTime

public long getSessionTime()

Specified by:

getSessionTime in interface PropertyManager

Returns:

number of minutes the session is valid.

setSessionTime

public void setSessionTime(long time)

Specified by:

setSessionTime in interface PropertyManager

Parameters:

time - number of minutes the session is valid.

getSMTPServer

public SMTPServer getSMTPServer()
                         throws PropertyManagerException

Specified by:

getSMTPServer in interface PropertyManager

Returns:

SMTP server config.

Throws:

PropertyManagerException - property does not exist.

setSMTPServer

public void setSMTPServer(SMTPServer server)

Specified by:

setSMTPServer in interface PropertyManager

Parameters:

server - SMTP server config.

getDesEncryptionKey

public Key getDesEncryptionKey()
                        throws PropertyManagerException

Specified by:

getDesEncryptionKey in interface PropertyManager

Returns:

DES key for DES encoded passwords.

Throws:

PropertyManagerException - property does not exist.

generateDesEncryptionKey

public void generateDesEncryptionKey()
                              throws PropertyManagerException

Description copied from interface: PropertyManager

Generates and stores a DES key for DES encoded passwords.

Specified by:

generateDesEncryptionKey in interface PropertyManager

Throws:

PropertyManagerException - DES algorithm does not exist.

setSMTPTemplate

@Deprecated
public void setSMTPTemplate(String template)

Deprecated.

Specified by:

setSMTPTemplate in interface PropertyManager

Parameters:

template - mail template.

getSMTPTemplate

@Deprecated
public String getSMTPTemplate()
                       throws PropertyManagerException

Deprecated.

Specified by:

getSMTPTemplate in interface PropertyManager

Returns:

mail template.

Throws:

PropertyManagerException - property does not exist.

setCurrentLicenseResourceTotal

public void setCurrentLicenseResourceTotal(int total)

Specified by:

setCurrentLicenseResourceTotal in interface PropertyManager

Parameters:

total - license resource total.

getCurrentLicenseResourceTotal

public int getCurrentLicenseResourceTotal()

Specified by:

getCurrentLicenseResourceTotal in interface PropertyManager

Returns:

license resource total.

setNotificationEmail

public void setNotificationEmail(String notificationEmail)

Specified by:

setNotificationEmail in interface PropertyManager

Parameters:

notificationEmail - notification email.

setNotificationEmails

public void setNotificationEmails(List<String> serverAlertAddresses)

Description copied from interface: InternalPropertyManager

Sets notification emails.

Specified by:

setNotificationEmails in interface InternalPropertyManager

Parameters:

serverAlertAddresses - list of notification emails.

getNotificationEmail

public String getNotificationEmail()
                            throws PropertyManagerException

Specified by:

getNotificationEmail in interface PropertyManager

Returns:

notification email.

Throws:

PropertyManagerException - property does not exist

getNotificationEmails

public List<String> getNotificationEmails()
                                   throws PropertyManagerException

Specified by:

getNotificationEmails in interface InternalPropertyManager

Returns:

List of notification emails.

Throws:

PropertyManagerException - property does not exist

isGzipEnabled

public boolean isGzipEnabled()
                      throws PropertyManagerException

Specified by:

isGzipEnabled in interface PropertyManager

Returns:

true if GZip compression should be used.

Throws:

PropertyManagerException - property does not exist.

setGzipEnabled

public void setGzipEnabled(boolean gzip)

Specified by:

setGzipEnabled in interface PropertyManager

Parameters:

gzip - true if GZip compression should be used.

getBuildNumber

public Integer getBuildNumber()
                       throws PropertyManagerException

Description copied from interface: PropertyManager

This method returns the current build number for Crowd from the datastore. This BuildNumber may not be the same as the build number in BuildUtils.BUILD_NUMBER since this number is for the current release of Crowd, while the number in the database may still be set to a previous version if the UpgradeManager has not been run.

Specified by:

getBuildNumber in interface PropertyManager

Returns:

an Integer representing the current build number in the database.

Throws:

PropertyManagerException - if we fail to find the buildNumber

setBuildNumber

public void setBuildNumber(Integer buildNumber)

Description copied from interface: PropertyManager

Will set the buildNumber for the current release of Crowd.

Specified by:

setBuildNumber in interface PropertyManager

Parameters:

buildNumber - the buildNumber to set in the database

getTrustedProxyServers

public String getTrustedProxyServers()
                              throws PropertyManagerException

Retrieves a String that contains a list of proxy servers we trust to correctly set the X-Forwarded-For flag. Internal format of this string is the responsibility of TrustedProxyManager.

Specified by:

getTrustedProxyServers in interface PropertyManager

Returns:

list of proxy servers we trust

Throws:

PropertyManagerException - If the list of proxy servers could not be found.

setTrustedProxyServers

public void setTrustedProxyServers(String proxyServers)

Persists a String containing a list of proxy servers we trust to correctly set the X-Forwarded-For flag. Internal format of this string is the responsibility of TrustedProxyManager.

Specified by:

setTrustedProxyServers in interface PropertyManager

Parameters:

proxyServers - proxy servers.

Throws:

org.springframework.dao.DataAccessException - If the list of proxy servers could not be saved.

setAuditLogConfiguration

public void setAuditLogConfiguration(AuditLogConfiguration newConfiguration)

Description copied from interface: PropertyManager

Persists the audit log configuration

Specified by:

setAuditLogConfiguration in interface PropertyManager

Parameters:

newConfiguration - new configuration

getAuditLogConfiguration

public AuditLogConfiguration getAuditLogConfiguration()

Description copied from interface: PropertyManager

Retrieves the audit log configuration

Specified by:

getAuditLogConfiguration in interface PropertyManager

Returns:

audit log configuration, default if not found

isUsingDatabaseTokenStorage

public boolean isUsingDatabaseTokenStorage()

Description copied from interface: PropertyManager

Will return true if the Crowd instance is using database token storage for authentication Token's otherwise assume we are using in-memory

Specified by:

isUsingDatabaseTokenStorage in interface PropertyManager

Returns:

true if database token storage is being used.

setUsingDatabaseTokenStorage

public void setUsingDatabaseTokenStorage(boolean isUsingDatabaseTokenStorage)

Description copied from interface: PropertyManager

Will set a property to state that this crowd instance is using database token storage, otherwise assume we are using in-memory

Specified by:

setUsingDatabaseTokenStorage in interface PropertyManager

Parameters:

isUsingDatabaseTokenStorage - true if you are switching to in-memory token storage

isIncludeIpAddressInValidationFactors

public boolean isIncludeIpAddressInValidationFactors()

Description copied from interface: PropertyManager

Should the client IP address be included as a validation factor?

Specified by:

isIncludeIpAddressInValidationFactors in interface PropertyManager

isUseWebAvatars

public boolean isUseWebAvatars()

Description copied from interface: PropertyManager

Should public services be used for user avatars?

Specified by:

isUseWebAvatars in interface PropertyManager

setUseWebAvatars

public void setUseWebAvatars(boolean useWebAvatars)

Specified by:

setUseWebAvatars in interface PropertyManager

getCookieConfiguration

public CookieConfiguration getCookieConfiguration()

Specified by:

getCookieConfiguration in interface PropertyManager

Returns:

the current configuration of Crowd's cookie-based SSO

setCookieConfiguration

public void setCookieConfiguration(CookieConfiguration cookieConfiguration)

Description copied from interface: PropertyManager

Updates the configuration of Crowd's cookie-based SSO

Specified by:

setCookieConfiguration in interface PropertyManager

Parameters:

cookieConfiguration - the configuration to set, will replace the existing configuration

setIncludeIpAddressInValidationFactors

public void setIncludeIpAddressInValidationFactors(boolean includeIpAddressInValidationFactors)

Specified by:

setIncludeIpAddressInValidationFactors in interface PropertyManager

setRememberMeConfiguration

public void setRememberMeConfiguration(CrowdSpecificRememberMeSettings configuration)

Description copied from interface: InternalPropertyManager

Sets remember me configuration

Specified by:

setRememberMeConfiguration in interface InternalPropertyManager

Parameters:

configuration - new configuration

getRememberMeConfiguration

public CrowdSpecificRememberMeSettings getRememberMeConfiguration()

Description copied from interface: InternalPropertyManager

Retrieves remember me configuration

Specified by:

getRememberMeConfiguration in interface InternalPropertyManager

Returns:

current configuration

removeProperty

public void removeProperty(String name)

Description copied from interface: PropertyManager

Will attempt to remove a property from the datastore

Specified by:

removeProperty in interface PropertyManager

Parameters:

name - the name of the property.

getPropertyObject

protected Property getPropertyObject(String name)
                              throws ObjectNotFoundException

Throws:

ObjectNotFoundException

getProperty

public String getProperty(String name)
                   throws ObjectNotFoundException

Description copied from interface: PropertyManager

Retrieves an arbitrary property by name.

Specified by:

getProperty in interface PropertyManager

Parameters:

name - name of property.

Returns:

value.

Throws:

ObjectNotFoundException - property does not exist.

getOptionalProperty

public Optional<String> getOptionalProperty(String name)

Description copied from interface: PropertyManager

Retrieves an arbitrary property by name.

Specified by:

getOptionalProperty in interface PropertyManager

Parameters:

name - name of property.

Returns:

value if found, none otherwise

setProperty

public void setProperty(String name,
 String value)

Description copied from interface: PropertyManager

Sets an arbitrary property.

Specified by:

setProperty in interface PropertyManager

Parameters:

name - name of property.

value - value.

getString

public String getString(String property,
 String defaultValue)

Description copied from interface: PropertyManager

Gets a string property. If the property is not defined, return the supplied default value.

Specified by:

getString in interface PropertyManager

Parameters:

property - a property name

defaultValue - the default value to use if the property does not exist

Returns:

the value of the property, or defaultValue if the property didn't exist

getBoolean

public boolean getBoolean(String property,
 boolean defaultValue)

Description copied from interface: PropertyManager

Gets a boolean property. If the property is not defined, return the supplied default value.

Specified by:

getBoolean in interface PropertyManager

Parameters:

property - a property name

defaultValue - the default value to use if the property does not exist

Returns:

the value of the property, or defaultValue if the property didn't exist

getInt

public int getInt(String property,
 int defaultValue)

Description copied from interface: PropertyManager

Gets an integer property. If the property is not defined, or does not contain a valid integer, return the supplied default value.

Specified by:

getInt in interface PropertyManager

Parameters:

property - a property name

defaultValue - the default value to use if the property does not exist or is invalid

Returns:

the value of the property, or defaultValue if the property didn't exist or was corrupted

getIntOrThrowIllegalArgumentException

public int getIntOrThrowIllegalArgumentException(String property,
 int defaultValue)

setBaseUrl

public void setBaseUrl(URI url)

Description copied from interface: PropertyManager

Sets the base URL for this Crowd application instance

Specified by:

setBaseUrl in interface PropertyManager

Parameters:

url - the base url to set, should be a proper absolute URL

getBaseUrl

public URI getBaseUrl()
               throws PropertyManagerException

Specified by:

getBaseUrl in interface PropertyManager

Returns:

the current base url for this Crowd application instance

Throws:

PropertyManagerException - if the property is not configured correctly

See Also:

• ApplicationProperties.getBaseUrl(com.atlassian.sal.api.UrlMode)

getPrivateKeyCertificatePairToSign

public Optional<Long> getPrivateKeyCertificatePairToSign()

Specified by:

getPrivateKeyCertificatePairToSign in interface PropertyManager

Returns:

ID of private key/certificate used to sign assertions in SAML if found, none otherwise

setPrivateKeyCertificateToSign

public void setPrivateKeyCertificateToSign(long privateKeyCertificatePairId)

Description copied from interface: PropertyManager

Sets ID of private key/certificate pair used to sign assertions in SAML

Specified by:

setPrivateKeyCertificateToSign in interface PropertyManager

Parameters:

privateKeyCertificatePairId - ID of private key/certificate pair to save

getBackupConfiguration

public BackupConfiguration getBackupConfiguration()

Specified by:

getBackupConfiguration in interface PropertyManager

Returns:

Backup configuration

saveBackupConfiguration

public void saveBackupConfiguration(BackupConfiguration config)

Description copied from interface: PropertyManager

Saves backup configuration

Specified by:

saveBackupConfiguration in interface PropertyManager

Parameters:

config - configuration of backup to save

getLookAndFeelConfiguration

@Nonnull
public Optional<LookAndFeelConfiguration> getLookAndFeelConfiguration()
                                                               throws PropertyManagerException

Specified by:

getLookAndFeelConfiguration in interface PropertyManager

Returns:

Look and Feel configuration if configured, none otherwise

Throws:

PropertyManagerException - if there was an error while fetching configuration

setLookAndFeelConfiguration

public void setLookAndFeelConfiguration(LookAndFeelConfiguration lookAndFeelConfiguration,
 ImageInfo updatedLogoInfo)
                                 throws PropertyManagerException

Description copied from interface: PropertyManager

Sets Look and Feel configuration

Specified by:

setLookAndFeelConfiguration in interface PropertyManager

Parameters:

lookAndFeelConfiguration - look and feel configuration

updatedLogoInfo - information about custom logo. If custom logo was already set and new value is not null then old logo will be overridden by new one.

Throws:

PropertyManagerException - if there was an error while saving configuration

removeLookAndFeelConfiguration

public void removeLookAndFeelConfiguration()
                                    throws PropertyManagerException

Description copied from interface: PropertyManager

Removes Look and Feel configuration

Specified by:

removeLookAndFeelConfiguration in interface PropertyManager

Throws:

PropertyManagerException - if there was an error while removing configuration

getLogoImage

public Optional<ImageInfo> getLogoImage()
                                 throws PropertyManagerException

Specified by:

getLogoImage in interface PropertyManager

Returns:

logo image if configured, none otherwise

Throws:

PropertyManagerException - if there was an error while fetching a logo