Class SystemPropertyAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.entity.AEntityAPI<SystemProperty>

de.xima.fc.api.entity.SystemPropertyAPI

public class SystemPropertyAPI
extends AEntityAPI<SystemProperty>

Field Summary

Fields inherited from class AEntityAPI

entityClass

Constructor Summary

Constructors

Constructor	Description
SystemPropertyAPI()

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)	Method for determining a SystemPropertys by a given key.
List<SystemProperty>	getByKeyPrefix(UserContext uc, String keyPrefix)	Method for determining a List of SystemPropertys that have the given key prefix.
List<SystemProperty>	getByKeys(UserContext uc, List<String> keys)	Method for determining a List of SystemPropertys by a 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 AEntityAPI

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

Methods inherited from class ASubAPI

getHandlerProvider

Methods inherited from class Object

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

Constructor Details

SystemPropertyAPI

public SystemPropertyAPI()

Method Details

getBooleanValue

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

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.

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)

Method for determining a SystemPropertys by a given key.

Parameters:

uc - UserContext the user context in which the action is to be performed.

key - the system property key

Returns:

a SystemProperty

getByKeyPrefix

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

Method for determining a List of SystemPropertys that have the given key prefix.

Parameters:

uc - UserContext the user context in which the action is to be performed.

keyPrefix - the used key prefix

Returns:

a List of SystemPropertys

getByKeys

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

Method for determining a List of SystemPropertys by a List of keys.

Parameters:

uc - UserContext the user context in which the action is to be performed.

keys - a List of keys to search for

Returns:

a List of SystemPropertys

getMfaSettings

public IMfaSettings getMfaSettings(UserContext uc)

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

Parameters:

uc - the UserContext to use

Returns:

The MFA settings for the system.

Since:

8.4.0

getStringValue

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

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.

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.