Package com.avoka.fc.core.dao

Class DeploymentPropertyDao

java.lang.Object

com.avoka.core.dao.BaseDao

com.avoka.fc.core.dao.AbstractDao

com.avoka.fc.core.dao.DeploymentPropertyDao

public class DeploymentPropertyDao
extends AbstractDao

Provides a DAO for the DeploymentProperty entity.

See Also:

DeploymentProperty

Field Summary

Fields inherited from class com.avoka.core.dao.BaseDao

FETCH_LIMIT, STATEMENT_MAX_NO_PARAMETERS

Constructor Summary

Constructors

Constructor	Description
DeploymentPropertyDao()

Method Summary

Modifier and Type	Method	Description
Set<String>	getAllowedAttachmentFileNameExt()	Return set of allowed attachment file name extensions
String	getConfigSubDirectory(String subdirectory)	Return the specified sub folder under the configured root Journey Manager directory (defined in DeploymentProperty.PROPERTY_Config_Directory.
DeploymentProperty	getDeploymentPropertyForPK(Object id)	Return the deployment property with the specified OID
List<DeploymentProperty>	getDeploymentPropertyList(String keyword)	Return the list of deployment properties matching the specified search criteria
int	getGroovyScriptTimeout()	Return the GroovyScript execution timeout in milliseconds.
DeploymentProperty	getProperty(String name)	Return the deployment property with the given name.
DateFormat	getPropertyDateFormat(String name)	Return a DateFormat using the value of the deployment property with the given name
String	getPropertyValue(String name)	Return the current value of the deployment property with the given name.
boolean	getPropertyValueBoolean(String name)	Returns the value of the deployment property as a boolean value
int	getPropertyValueInt(String name)	Return the value of the deployment property as an int value
long	getPropertyValueLong(String name)	Return the value of the deployment property as a long value
boolean	hasProperty(String name)	Return whether a property exists for the given name
boolean	isDebugMode()	Return whether Journey Manager is currently in debug mode
boolean	isExceptionDebugLoggingEnabled()	Return true if Exception Debug Logging is enabled by default.
boolean	isFluentAPIUserPermissionCheckActive()	Return whether Fluent API user permission check flag is active or not
boolean	isGroovyLoggingEnabled()	Return true if Groovy Service Logging is enabled by default.
boolean	isInsightsEnabled()
boolean	isLCFormServersDeployed()	Deprecated. LC support has been removed
boolean	isLCFormServersLoadBalanced()	Deprecated. LC support has been removed
boolean	isServerRealTimeHeathMonitoring()	Return true if Server Real-Time Heath Monitoring is enabled.
void	loadDefaultProperties()	Load the default values of the system deployment properties.
void	refreshCache()	Clear the deployment property cache.
void	registerDeploymentProperty(String name, String type, String value, String description)	Register a new deployment property.

Methods inherited from class com.avoka.fc.core.dao.AbstractDao

andFilterClientExcludeNull, andFilterClientIncludeNull, andFilterClientOnly, isClientAccessAllowed, performQueryConfigCached

Methods inherited from class com.avoka.core.dao.BaseDao

addOrdering, addOrderingCaseInsensitive, addOrderingCaseSensitive, andQueryBetween, andQueryInExp, andQueryInExp, andQueryLikeIgnoreCaseExp, andQueryMatchDbExp, andQueryMatchExp, andQueryMatchIsNotNull, andQueryMatchIsNull, andQueryNoMatchExp, andQueryNotTrue, deleteObject, deleteObjects, findObject, getDataContext, getFetchLimit, getLogger, getObjectForPK, newObject, orQueryLikeIgnoreCaseExp, orQueryMatchExp, performNamedQuery, performNamedQuery, performNamedQuery, performNamedQuery, performNonSelectingQuery, performNonSelectingQuery, performNonSelectingQuery, performNonSelectingQuery, performQuery, performQuery, performQuery, registerNewObject, setCacheStrategy, setFetchLimit, setLocalCacheStrategy, setLocalCacheStrategy, setSharedCacheStrategy, toMap, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploymentPropertyDao

public DeploymentPropertyDao()

Method Detail

refreshCache

public void refreshCache()

Clear the deployment property cache.

getDeploymentPropertyForPK

public DeploymentProperty getDeploymentPropertyForPK(Object id)

Return the deployment property with the specified OID

Parameters:

id - the OID

Returns:

the matching deployment property, or null if not found

getDeploymentPropertyList

public List<DeploymentProperty> getDeploymentPropertyList(String keyword)

Return the list of deployment properties matching the specified search criteria

Parameters:

keyword - the search keyword

Returns:

the list of matching deployment properties

hasProperty

public boolean hasProperty(String name)

Return whether a property exists for the given name

Parameters:

name - the name of the property

Returns:

true if a property exists for the given name

getProperty

public DeploymentProperty getProperty(String name)

Return the deployment property with the given name.

Parameters:

name - the name of the deployment property

Returns:

the deployment property

getPropertyValue

public String getPropertyValue(String name)
                        throws ApplicationException

Return the current value of the deployment property with the given name.

Parameters:

name - the non-null name of the property

Returns:

the property value

Throws:

ApplicationException - if the specified property does not exist, or more than one value exists

getPropertyDateFormat

public DateFormat getPropertyDateFormat(String name)

Return a DateFormat using the value of the deployment property with the given name

Parameters:

name - the non-null name

Returns:

a DateFormat instance using the deployment property value as its pattern

getPropertyValueInt

public int getPropertyValueInt(String name)
                        throws ApplicationException

Return the value of the deployment property as an int value

Parameters:

name - the name of the deployment property

Returns:

the int value of the deployment property

Throws:

ApplicationException - if the specified property does not exist

NumberFormatException - if the deployment property value could not be converted to an int value

getPropertyValueLong

public long getPropertyValueLong(String name)
                          throws ApplicationException

Return the value of the deployment property as a long value

Parameters:

name - the name of the deployment property

Returns:

the long value of the deployment property

Throws:

ApplicationException - if the specified property does not exist

NumberFormatException - if the deployment property value could not be converted to a long value

getPropertyValueBoolean

public boolean getPropertyValueBoolean(String name)
                                throws ApplicationException

Returns the value of the deployment property as a boolean value

Parameters:

name - the name of the deployment property

Returns:

the boolean value of the deployment property (see Boolean.parseBoolean(String))

Throws:

ApplicationException - if the specified property does not exist

getConfigSubDirectory

public String getConfigSubDirectory(String subdirectory)

Return the specified sub folder under the configured root Journey Manager directory (defined in DeploymentProperty.PROPERTY_Config_Directory. This method will create the sub directory if it does not exist.

Parameters:

subdirectory - the sub folder name

Returns:

the full path of the sub folder

isDebugMode

public boolean isDebugMode()

Return whether Journey Manager is currently in debug mode

Returns:

true if the value of DeploymentProperty.PROPERTY_Debug_Mode is "1" or "true", ignoring capitalization

isGroovyLoggingEnabled

public boolean isGroovyLoggingEnabled()

Return true if Groovy Service Logging is enabled by default.

Returns:

true if Groovy Service Logging is enabled by default

Since:

4.2.0

getGroovyScriptTimeout

public int getGroovyScriptTimeout()

Return the GroovyScript execution timeout in milliseconds.

Returns:

the GroovyScript execution timeout in milliseconds

Since:

4.2.0

isInsightsEnabled

public boolean isInsightsEnabled()

Returns:

true if Insights analytics is enabled

Since:

4.3.3

isLCFormServersDeployed

public boolean isLCFormServersDeployed()

Deprecated.

LC support has been removed

Return true if Adobe LiveCycle Form Servers are deployed.

Returns:

false

Since:

4.0.0

isLCFormServersLoadBalanced

public boolean isLCFormServersLoadBalanced()

Deprecated.

LC support has been removed

Return true if Adobe LiveCycle Form Servers are Load Balanced.

Returns:

false

Since:

4.0.0

isServerRealTimeHeathMonitoring

public boolean isServerRealTimeHeathMonitoring()

Return true if Server Real-Time Heath Monitoring is enabled.

Returns:

true if Server Real-Time Heath Monitoring is enabled

Since:

4.0.0

isExceptionDebugLoggingEnabled

public boolean isExceptionDebugLoggingEnabled()

Return true if Exception Debug Logging is enabled by default.

Returns:

true if Exception Debug Logging is enabled by default

Since:

19.5.3

getAllowedAttachmentFileNameExt

public Set<String> getAllowedAttachmentFileNameExt()

Return set of allowed attachment file name extensions

Returns:

set of allowed attachment file name extensions

Since:

19.11.0

isFluentAPIUserPermissionCheckActive

public boolean isFluentAPIUserPermissionCheckActive()

Return whether Fluent API user permission check flag is active or not

Returns:

true if the value of DeploymentProperty.PROPERTY_Fluent_API_User_Permission_Check is true

Since:

21.11.0

loadDefaultProperties

public void loadDefaultProperties()

Load the default values of the system deployment properties. Current property values are not overwritten.

registerDeploymentProperty

public void registerDeploymentProperty(String name,
                                       String type,
                                       String value,
                                       String description)

Register a new deployment property. Note that if a deployment property with the given name already exists, no action is taken.

Parameters:

name - the name of the deployment property

type - the data type

value - the new value

description - the description