Package org.cristalise.kernel

Enum Class SystemProperties

java.lang.Object
java.lang.Enum<SystemProperties>
org.cristalise.kernel.SystemProperties
All Implemented Interfaces:
Serializable, Comparable<SystemProperties>, Constable, SystemPropertyOperations
public enum SystemProperties extends Enum<SystemProperties> implements SystemPropertyOperations
Defines all SystemProperties that are supported in the kernel to configure the behavior of the application. Due to the limitation of javadoc, the actual usable string cannot be shown easily, therefore replace underscores with dots to get the actual System Property: 
   Module_ImportAgent_enableRoleCreation => Module.ImportAgent.enableRoleCreation
See Also:

  • Enum Constant Details

    • Activity_validateOutcome

      public static final SystemProperties Activity_validateOutcome
      Enables OutcomeValidation during database transaction (aka server-side validation). Default value is 'false', because Outcomes are validated in client code (e.g. during restapi call). Such a validation can be enabled using BuiltInVertexProperties.VALIDATE_OUTCOME Activity property as well.

    • BulkErase_force

      public static final SystemProperties BulkErase_force
      If true continue Erase even if an error. Default value is false - UNIMPLEMENTED

    • BulkErase_limit

      public static final SystemProperties BulkErase_limit
      Defines the paging size used during BulkErase predefined step. Defaul is 0, which means there is no limit in deleting Items

    • BulkImport_fileExtension

      public static final SystemProperties BulkImport_fileExtension
      Defines file extension to be used by the BulkImport predefined step. Default value is empty string

    • BulkImport_rootDirectory

      public static final SystemProperties BulkImport_rootDirectory
      Defines root directory used by the BulkImport predefined step. No default value

    • BulkImport_useDirectories

      public static final SystemProperties BulkImport_useDirectories
      Defines if BulkImport predefined step is based on directory structure or not. Default value is 'false'

    • ClusterStorage

      public static final SystemProperties ClusterStorage
      Ordered list of implementation of the ClusterStorage interface that Cristal will use for storage of Item local objects. Precedence is left to right. If package name is not supplied, org.cristalise.storage is implied. No default value.

    • ClusterStorage_cacheSpec

      public static final SystemProperties ClusterStorage_cacheSpec
      Specifies the Google Guava cache behavior used in ClusterStorageManager. Default is value is 'expireAfterAccess = 600s, recordStats'

    • CreateItemFromDescription_Cache_enable

      public static final SystemProperties CreateItemFromDescription_Cache_enable
      Enable the experimental cache in CreateItemFromDescription predefined step to speed up item creation. Default is false.

    • DataHelper_$name

      public static final SystemProperties DataHelper_$name
      Define the java classname that implements the DataHelper interface. No default value.

    • Dependency_addStateMachineURN

      public static final SystemProperties Dependency_addStateMachineURN
      Add or not a new Item Property 'StaeMachineURN' during CreateItemFromDescription. Default value is false.

    • Dependency_addWorkflowURN

      public static final SystemProperties Dependency_addWorkflowURN
      Add or not a new Item Property 'WorkflowURN' during CreateItemFromDescription. Default value is false.

    • Dependency_checkMemberUniqueness

      public static final SystemProperties Dependency_checkMemberUniqueness
      Enables or disables Dependency collection to contain the same Item many times. Default value is true.

    • Erase_force

      public static final SystemProperties Erase_force
      If true continue Erase even if an error during deleting BiDirectional references. Default value is false.

    • Export_replaceActivitySlotDefUUIDWithName

      public static final SystemProperties Export_replaceActivitySlotDefUUIDWithName
      Replace UUID with Activity name while exporting CompositeActivityDef. Default value is 'false'

    • Gateway_clusteredVertx

      public static final SystemProperties Gateway_clusteredVertx
      Initialise the clustered version of vertx. Default value is 'true'.

    • ItemServer_name

      public static final SystemProperties ItemServer_name
      The name of the Server Item. default is 'localhost', although kernel code overrides that with InetAddress.getLocalHost().getHostName().

    • ItemServer_Telnet_host

      public static final SystemProperties ItemServer_Telnet_host
      Define the host for vert.x shall service using telnet. Default value is 'localhost'

    • ItemServer_Telnet_port

      public static final SystemProperties ItemServer_Telnet_port
      Define the port for vert.x shall service using telnet. Default value is 0, used to disable the service.

    • ItemVerticle_ebAddress

      public static final SystemProperties ItemVerticle_ebAddress
      Specifies the address name of the vertx event bus. Default value is 'cristalise-items'

    • ItemVerticle_includeDebugInfo

      public static final SystemProperties ItemVerticle_includeDebugInfo
      If the ServiceException thrown in ItemVerticle includes debug information or not. Default value is 'true'

    • ItemVerticle_instances

      public static final SystemProperties ItemVerticle_instances
      The number of deployed ItemVerticle instances. Default value is 8

    • ItemVerticle_requestTimeoutSeconds

      public static final SystemProperties ItemVerticle_requestTimeoutSeconds
      The number of seconds before a request to an Item times out. Default value is 10

    • Lifecycle_Sign_agentNameField

      public static final SystemProperties Lifecycle_Sign_agentNameField
      Defines the name of the field in the Outcome containing the name of the Agent. It is used in the Sign predefined step. Default is 'AgentName'

    • Lifecycle_Sign_passwordField

      public static final SystemProperties Lifecycle_Sign_passwordField
      Defines the name of the field in the Outcome containing the password of the Agent. It is used in the Sign predefined step. Default is 'Password'

    • Lifecycle_Sign_signedFlagField

      public static final SystemProperties Lifecycle_Sign_signedFlagField
      Defines the name of the field in the Outcome containing the password of the Agent. It is used in the Sign predefined step. Default is 'Password'

    • LocalChangeVerticle_publishLocalMessage

      public static final SystemProperties LocalChangeVerticle_publishLocalMessage
      LocalChangeVerticle shall publish instead of send vert.x events the the local addresses. Default value is 'true'.

    • LocalObjectLoader_lookupUseProperties

      public static final SystemProperties LocalObjectLoader_lookupUseProperties
      Enforce LocalObjectLoader to use original (but slow) ItemProperty based search in lookup tree instead of subtree based search which is faster. Default value is 'false'.

    • Lookup

      public static final SystemProperties Lookup
      Define the java classname that implements the Lookup interface. No default value.

    • Module_ImportAgent_enableRoleCreation

      public static final SystemProperties Module_ImportAgent_enableRoleCreation
      Create Role(s) defined in ImportAgent even if it is not fully specified. Default value is false.

    • Module_reset

      public static final SystemProperties Module_reset
      Forces Bootstrap to overwrite existing resources imported from all modules. If true the resource is updated to the version stored in the jar to overwrite changes by someone other than Bootstrap (i.e. using dynamic editing through UI. Default value is 'false'.

    • Module_$Namespace_reset

      public static final SystemProperties Module_$Namespace_reset
      Forces Bootstrap to overwrite existing resources imported from the given module (see apiNote of $Namespace). If true the resource is updated to the version stored in the jar to overwrite changes by someone other than Bootstrap (i.e. using dynamic editing through UI. Default value is 'false'.

    • Module_Versioning_strict

      public static final SystemProperties Module_Versioning_strict
      If true generates error if the resource Item is referenced without version number, otherwise use version 0. Default value is false.

    • Outcome_Validation_useDOM

      public static final SystemProperties Outcome_Validation_useDOM
      Enable to use DOM instead of string during Outcome.validate(). Default value is 'false'. It was added to investigate strange Apache Xerces xml corruption issue. Default value 'false' is required since the migration to java 17 and the xerces dependency update on pom.xml

    • OutcomeInit_$name

      public static final SystemProperties OutcomeInit_$name
      Specifies an OutcomeInitiator implementation to use to create new empty Outcomes. Will be invoked from Job.getOutcome() for Activities with an 'OutcomeInit' property set to the given name. Default is null.

    • OutcomeInit_jobUseViewpoint

      public static final SystemProperties OutcomeInit_jobUseViewpoint
      Use last Outcome instance instead of OutcomeInitiator. Default value is false.

    • Resource_moduleUseFileNameWithVersion

      public static final SystemProperties Resource_moduleUseFileNameWithVersion
      Comma separated list of modules namespaces, that use file names with version. Default value is empty string.

    • Resource_useOldImportFormat

      public static final SystemProperties Resource_useOldImportFormat
      Enables to use the deprecated module resource format when exporting the DescriptionObject. Default value is 'false'.

    • ResourceImportHandler_$typeCode

      public static final SystemProperties ResourceImportHandler_$typeCode
      Specifies a custom ResourceImportHandler implementation, allowing modules to define their own resource types, or override the import of the core ones. The type code can be any string, but by convention a short upper-case string is used. The core types are EA (Elementary Activity), CA (Composite Activity), OD (Outcome Description - Schema), SC (Script) and SM (State Machine)

    • RoutingScript_enforceStringReturnValue

      public static final SystemProperties RoutingScript_enforceStringReturnValue
      Throws an exception when the RoutingScript does not return of the Script is not a String type. Default value is 'false', which means the Object.toString() value is returned.

    • Script_EngineOverride_$lang

      public static final SystemProperties Script_EngineOverride_$lang
      Override the javax.script engine for the given scripting language. Used to override Javascript in Java8+ with Rhino

    • Shiro_iniFile

      public static final SystemProperties Shiro_iniFile
      Configuration of the shiro.ini file, normally it is in the config directory. No default value.

    • StateMachine_Composite_default

      public static final SystemProperties StateMachine_Composite_default
      Defines the default StateMachine for CompositeActivity. Default value is 'CompositeActivity'.

    • StateMachine_Elementary_default

      public static final SystemProperties StateMachine_Elementary_default
      Defines the default StateMachine for ElementaryActivities. Default value is 'Default'.

    • StateMachine_enableErrorHandling

      public static final SystemProperties StateMachine_enableErrorHandling
      Use error handling (error transition) defined in StateMachine. Default value is false.

    • StateMachine_Predefined_default

      public static final SystemProperties StateMachine_Predefined_default
      Defines the default StateMachine for PredefinedSteps. Default value is 'PredefinedStep'.

    • SystemProperties_keywordsToRedact

      public static final SystemProperties SystemProperties_keywordsToRedact
      Specifies the comma separated list of field names in SystemProperties and Outcomes for which the value should be redacted when printed or stored for security reasons. Default is 'password,pwd'.

    • TcpBridge_host

      public static final SystemProperties TcpBridge_host
      Host of the machine to connect through vert.x tcp-ip bridge, No default value

    • TcpBridge_port

      public static final SystemProperties TcpBridge_port
      Port of the machine to connect through vert.x tcp-ip bridge, Default value is 7000

    • UserCode_roleOverride

      public static final SystemProperties UserCode_roleOverride
      Defines the default role to be used for UserCode. It also used as a prefix for every configuration property eg: UserCode.StateMachine.startTransition. Default value is 'UserCode'.

    • $UserCodeRole_agent

      public static final SystemProperties $UserCodeRole_agent
      Specifies the Agent name associated with the UserCode role. No default value.

    • $UserCodeRole_password

      public static final SystemProperties $UserCodeRole_password
      Specifies the password of the Agent associated with the UserCode role. Default value is 'uc'.

    • $UserCodeRole_permissions

      public static final SystemProperties $UserCodeRole_permissions
      Specifies the permissions, i.e. comma separated WildcardPermission strings, of the Agent associated with the UserCode role. Default value is 'uc'.

    • $UserCodeRole_StateMachine_startTransition

      public static final SystemProperties $UserCodeRole_StateMachine_startTransition
      Override the default mapping for Start transition of UserCode. It is always prefixed like this: eg: UserCode.StateMachine.startTransition

    • $UserCodeRole_StateMachine_completeTransition

      public static final SystemProperties $UserCodeRole_StateMachine_completeTransition
      Override the default mapping for Complete transition of UserCode. It is always prefixed like this: eg: UserCode.StateMachine.completeTransition

    • $UserCodeRole_StateMachine_errorTransition

      public static final SystemProperties $UserCodeRole_StateMachine_errorTransition
      Override the default mapping for Error transition of UserCode. It is always prefixed like this: eg: UserCode.StateMachine.errorTransition

    • $UserCodeRole_StateMachine_name

      public static final SystemProperties $UserCodeRole_StateMachine_name
      Specifies the StateMachine Name required for the UserCode implementation. Default value is 'Default' because standard implementation is based in the built-in StateMachine.

    • $UserCodeRole_StateMachine_version

      public static final SystemProperties $UserCodeRole_StateMachine_version
      Specifies the StateMachine version required for the UserCode implementation. Default value is '0'.

    • $UserCodeRole_StateMachine_namespace

      public static final SystemProperties $UserCodeRole_StateMachine_namespace
      Specifies the namespace (i.e. the module) from which the StateMachine required for the UserCode implementation can be loaded. No default value.

    • $UserCodeRole_StateMachine_bootfile

      public static final SystemProperties $UserCodeRole_StateMachine_bootfile
      Specifies the file path to of the StateMachine XML file used in the jar. This will be used to find the StateMachine required for the UserCode implementation can be loaded. No default value.

    • XMLStorage_root

      public static final SystemProperties XMLStorage_root
      If using XMLClusterStorage, this defined the root directory of XML file storage No default value.

  • Method Details

    • values

      public static SystemProperties[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SystemProperties valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<SystemProperties>