Class SystemPropertyHandler

java.lang.Object

de.xima.fc.handler.AMSApiHandler

de.xima.fc.handler.entity.GenericHandler

de.xima.fc.handler.entity.SystemPropertyHandler

All Implemented Interfaces:

IAPIHandler, IGenericHandler, ISystemPropertyHandler, Serializable

public class SystemPropertyHandler
extends GenericHandler
implements ISystemPropertyHandler

See Also:

• Serialized Form

Field Summary

Fields inherited from class GenericHandler

LOG

Constructor Summary

Constructors

Constructor	Description
SystemPropertyHandler()

Method Summary

Modifier and Type	Method	Description
boolean	getBooleanValue(UserContext uc, String key, boolean defaultValue)	Returns the boolean value of the system property with the given key if it exists.
SystemProperty	getByKey(UserContext uc, String key)	Retrieves a Property by a given key.
List<SystemProperty>	getByKeyPrefix(UserContext uc, String keyPrefix)	Retrives a List of SystemPropertys by a given key prefix.
List<SystemProperty>	getByKeys(UserContext uc, List<String> keys)	Retrives a List of SystemPropertys by a given List of keys.
IMfaSettings	getMfaSettings(UserContext uc)	Gets the Multi-Factor Authentication (MFA) settings for the system.
String	getStringValue(UserContext uc, String key, String defaultValue)	Returns the String value of the system property with the given key if it exists.

Methods inherited from class GenericHandler

create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, serializableList, update, update

Methods inherited from class AMSApiHandler

getName

Methods inherited from class Object

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

Methods inherited from interface IAPIHandler

getName

Methods inherited from interface IGenericHandler

create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, update, update

Constructor Details

SystemPropertyHandler

public SystemPropertyHandler()

Method Details

getBooleanValue

public boolean getBooleanValue(UserContext uc,
 String key,
 boolean defaultValue)

Description copied from interface: ISystemPropertyHandler

Returns the boolean value of the system property with the given key if it exists. If the system property does not exists the provided default value will be returned.

Specified by:

getBooleanValue in interface ISystemPropertyHandler

Parameters:

uc - user context for database transactions.

key - of the system property.

defaultValue - to return if no system property was found for the given key.

Returns:

the boolean value of the system property with the given key if it exists and the provided default value otherwise.

getByKey

public SystemProperty getByKey(UserContext uc,
 String key)

Description copied from interface: ISystemPropertyHandler

Retrieves a Property by a given key.

Specified by:

getByKey in interface ISystemPropertyHandler

Parameters:

uc - the UserContext to use

key - the system property key

Returns:

a SystemProperty

getByKeyPrefix

public List<SystemProperty> getByKeyPrefix(UserContext uc,
 String keyPrefix)

Description copied from interface: ISystemPropertyHandler

Retrives a List of SystemPropertys by a given key prefix.

Specified by:

getByKeyPrefix in interface ISystemPropertyHandler

Parameters:

uc - the UserContext to use

keyPrefix - a prefix for all keys to search for

Returns:

a List of SystemPropertys

getByKeys

public List<SystemProperty> getByKeys(UserContext uc,
 List<String> keys)

Description copied from interface: ISystemPropertyHandler

Retrives a List of SystemPropertys by a given List of keys.

Specified by:

getByKeys in interface ISystemPropertyHandler

Parameters:

uc - the UserContext to use

keys - a List of keys

Returns:

a List of SystemPropertys

getMfaSettings

public IMfaSettings getMfaSettings(UserContext uc)

Description copied from interface: ISystemPropertyHandler

Gets the Multi-Factor Authentication (MFA) settings for the system.

Specified by:

getMfaSettings in interface ISystemPropertyHandler

Parameters:

uc - the UserContext to use

Returns:

The MFA settings for the system.

getStringValue

public String getStringValue(UserContext uc,
 String key,
 String defaultValue)

Description copied from interface: ISystemPropertyHandler

Returns the String value of the system property with the given key if it exists. If the system property does not exists the provided default value will be returned.

Specified by:

getStringValue in interface ISystemPropertyHandler

Parameters:

uc - user context for database transactions.

key - of the system property.

defaultValue - to return if no system property was found for the given key.

Returns:

the String value of the system property with the given key if it exists and the provided default value otherwise.