This page lists the configurations for the following services:

Mandatory configuration entries are marked with a * .
Configuration entries that do not apply directly, e. g. contains a placeholder or needs a different prefix, are marked with a v .
Apparently there can be several of these entries (with different values for the placeholders).

de.aristaflow.adept2.base.cluster.RegistryProviderConf

extends de.aristaflow.adept2.base.service.AbstractADEPT2Service
GlobalRegistryUris *
type: STRING
description: A list of URIs that refer to global registries running on the available cluster nodes. At most one of the URIs will be valid at a time.
Timeout
type: LONG
default: 120000
description: The time (in milliseconds) to wait for the service requests.

de.aristaflow.adept2.base.communication.communicationservices.AbstractNettyCommunicationService

extends de.aristaflow.adept2.base.service.AbstractAuthenticatedService
Host
type: STRING
default: ""
description: This configuration entry is used to set the address of the server. It can be either a host name or an IP address and optionally have a subnet mask in CIDR notation. The host name just needs to be in the corresponding subnet, it need not be a name of the current machine. Bt the current machine has to have a network interface with the host name or IP address or one that is in the specified subnet. This will be checked when starting. You can use 0.0.0.0 or * to listen on all available network interfaces. In this case you have to provide an external host name/IP address! If nothing is provided, the address of the default network interface of the current machine will be used.
Port
type: INT
default: 50001
description: This property is used to set the port where the socket should listen for incoming messages. The default port is '50001'.
ExternalHost
type: STRING
default: ""
description: This configuration entry is used to set the external host name/IP address of the server. This will be used in exported URIs with which clients connect to the server. It can be a host name or an IP address. No validity will be checked so make sure that clients can connect to this address and their requests will be forwarded appropriately to the server. If nothing is provided, the host name/IP address determined from the network interfaces will be used.
LogicalHost
type: STRING
default: null
description: This configuration entry is used to set the logical host name/IP address of the server. This identifies the server via name and will be used in exported URIs with which clients connect to the server. It separates the identification from the network routing. If this is not set, the configured external host, the host or the determined host will be used (in this priority). If this contains no port (in host notation), the actual server port will be appended to identify the correct JVM process on the server. You can use an arbitrary name (and port) as long as this name conforms to a path element of URI syntax (and does only contain one ':' separating the name from the logical port). Make sure each node has a unique logical name (at least via the logical port)!
NoLogicalHost
type: BOOLEAN
default: false
description: This configuration entry allows to disable the usage of a logical host. Setting this to true uses the old URIs using the host name for network routing and service identification. Use this for compatibility with old versions.
ClientTimeout
type: INT
default: 60000
description: The time in milliseconds [ms] the NettyClient waits for server responses. The default timeout is 60 seconds.
Version
type: STRING
default: 2.0.0
description: This property is used to set the version of the applications. The communication will check, if the version matches, to prohibit possible mismatches in the API.
SuppressServerStack
type: BOOLEAN
default: false
description: This property determines whether to suppress the stacks from exceptions occurring on the server side. The stack elements from the client will always be visible.
KeystorePath
type: STRING
default: ${arflow:arflow.datadir}
description: This property is used to set the certificate path that is used for the SSL encryption of the communication. The default value is the arflow.datadir.
KeystoreFile
type: STRING
default: cert.jks
description: This property is used to set the certificate file that is used for the SSL encryption of the communication.
KeystorePass
type: STRING
default: 0HoviMg4O3eeKW5kfmLJaI3x8vGG+bzEsjKRdYsIIoY7+8NsB+Dn2BjMhDvkhpOv9pHWuNtiKpOxKKmv9QjvRA+/jdCMZx6ebnZQNECdTiI6DuvyzuAYaZVPx3XefQS4J4lu60BlRg7ftxYr4FuMGwvEEqOOEacL8JOFXXV8IibJdeoS4elqiz5pOKwr2N04Z68BSYc27qTHsopzRA93beNuxEipZ2F/mB/bSe5ZFGQMYvxx6p57GyaE2o6hj/0j/GgUHJtKEWrYUu99lqxvax7Ym0LFnRjJzU8Z/cIQgh22pgYmSYweKKWAmKyrVrW4ypGwlin1ZSEGaB97cxCd5Q==
description: This property is used to set the certificate password that is needed for the SSL encryption.
UseSSL
type: BOOLEAN
default: false
description: This property is used to signal, whether SSL encryption should be used or not.
Client *
type: BOOLEAN
description: This property is used to signal, whether this service is used on client or on server side.
HostMapping
type: STRING
default: null
description: The mapping of host names/IP addresses used by the server and the corresponding host names/IP addresses which to use instead. This allows for instance to map the URIs provided by the server to a local URI using SSH port forwarding. The mapping is a list of string pairs whereas each pair is separated by '=', that is, [serverIP] = [actualIP]. The host names/IP addresses may have an appended port. If either side has a port, the other side also has to have a port, e. g. aristaflow-server.domain.local:47999 = localhost:4711. The left side is the name that will be used for the server, that is, the server has to have this name. Use ExternalHost to set a virtual name for the corresponding host.
ServerAcceptorPoolSize
type: INT
default: 0
description: The amount of threads used for accepting requests on server side. These forward to the processing threads. The default "0" means to use one thread more than the available processors. At least 2 threads will be used.
ServerProcessorPoolSize
type: INT
default: 40
description: The amount of threads used for processing and answering requests on server side. There will be at least 2 threads.
ClientPoolSize
type: INT
default: 0
description: The amount of threads used for sending requests on client side and forwarding the corresponding responses to the appropriate requesters. The default "0" means to use one thread more than the available processors. At least 2 threads will be used.
CachingRemItInitAliveTime
type: LONG
default: 80000
description: The time in milliseconds to keep the caching remote iterators alive after creating them and without accessing them. These caching remote iterators wrap all remote iteraters received via stub with late binding.
CachingRemItAliveTimeExtension
type: LONG
default: null
description: The time in milliseconds to extend the time caching remote iterators will be kept alive after each access. These caching remote iterators wrap all remote iteraters received via stub with late binding. If this extension time is not configured, the initial alive time will be used for extension.
restrictions: range: 0 to x
UseUnsafe
type: BOOLEAN
default: true
description: Whether to use unsafe operations, that are low-level operations bypassing some abstractions of the JVM.
ProxyAnnotationCacheSize
type: INT
default: ${arflow:confVar.ProxyAnnotationCacheSize}
description: The size of the cache to provide whether a specific class has a proxy annotation (ProxyAllow, ProxyCallback, ServerSideProxyAllow) or implements ServerSideProxy. Use 0 or a negative value to disable caching.
ProxyLazyMethodValidTime
type: LONG
default: ${arflow:confVar.ProxyLazyMethodValidTime}
description: The time in milliseconds the return value of a lazy method will be reused. Use 0 or a negative value to disable caching for a lazy method.
Instances.CommStackInterceptor v
type: STRING
default: ""
description: This is a global configuration, two instances are expected: StubInterceptor and SkeletonInterceptor. Either one can be skipped. When declaring one or both of them, also add the corresponding Implementations.
StubInterceptor.Implementation v
type: STRING
default: ""
description: This is a global configuration, add your own implementation class which either implements de.aristaflow.adept2.base.communication.CommStackInterceptor or extends de.aristaflow.adept2.base.communication.defaultimplementation.DefaultCommStackInterceptor. This class will be intercept all outgoing communication.
SkeletonInterceptor.Implementation v
type: STRING
default: ""
description: This is a global configuration, add your own implementation class which either implements de.aristaflow.adept2.base.communication.CommStackInterceptor or extends de.aristaflow.adept2.base.communication.defaultimplementation.DefaultCommStackInterceptor. This class will be intercept all incoming communication.

de.aristaflow.adept2.base.communication.communicationservices.AbstractWebServiceCommunicationService

extends de.aristaflow.adept2.base.service.AbstractAuthenticatedService

de.aristaflow.adept2.base.communication.communicationservices.NettyCommunicationService

extends de.aristaflow.adept2.base.communication.communicationservices.AbstractNettyCommunicationService

Declared in default configuration as: netty, nettys

de.aristaflow.adept2.base.communication.communicationservices.NettyOneConnCommunicationService

extends de.aristaflow.adept2.base.communication.communicationservices.AbstractNettyCommunicationService

Declared in default configuration as: nettyc, nettycs

de.aristaflow.adept2.base.communication.communicationservices.RestCommunicationService

extends de.aristaflow.adept2.base.communication.communicationservices.AbstractWebServiceCommunicationService

Declared in default configuration as: rest

ServletNamePrefix
type: STRING
default: AristaFlowREST
description: The prefix for the name of the web service servlets. This name is part of the URLs of the web services that are exported by the communication service.
WSDirectoryName
type: STRING
default: de/aristaflow/ilm/ws/rest/
description: The name of the directory that houses the SOAP web service classes. This directory is relative to the root of the resource of the AbstractWebServiceCommunicationService-class. Assume this class to be in a Jar-file then the default value of this configuration property represents the directory "de/aristaflow/ilm/ws/rest" in this Jar-file. It needs to end with a "/".
LogEntitySize
type: INT
default: -1
description: Whether to log requests and responses of the web service servlet. -1 disables logging, 0 logs the headers and a positive integer specifices the amount (in bytes) of the entity payload which to log. Log level will be FINE so configure the logger of this communication service appropriately.
EnableGzip
type: BOOLEAN
default: false
description: Whether to enable Gzip compression and uncompression for responses and requests if the client uses and accepts it. Note that compression will lead to logging of compressed payload.
Validate
type: BOOLEAN
default: false
description: Whether to validate the beans retrieved from the requests.
ValidationLocale
type: STRING
default: en
description: The locale which to use for the validation messages. Use the usual syntax of java.util.Locale#toLanguageTag e. g. "en-US-x-lvariant-WIN".
SuppressServerStack
type: BOOLEAN
default: true
description: This property determines whether to suppress the stacks from exceptions occurring on the server side. The stacks will always be logged (in case the logger has the right log level).
IteratorDefaultCount
type: INT
default: 50
description: The amount of elements contained in an iteration of an iterator (or other incremental data) in case no amount (count) is specified when retrieving data.
SseReconnectDelay
type: LONG
default: -1
description: The delay in milliseconds SSE connections should reconnect (seejavax.ws.rs.sse.OutboundSseEvent.Builder#reconnectDelay(long)). A negative value disables this feature.

de.aristaflow.adept2.base.communication.communicationservices.SoapCommunicationService

extends de.aristaflow.adept2.base.communication.communicationservices.AbstractWebServiceCommunicationService

Declared in default configuration as: soap

ServletNamePrefix
type: STRING
default: AristaFlowSOAP
description: The prefix for the name of the web service servlets. This name is part of the URLs of the web services that are exported by the communication service.
WSDirectoryName
type: STRING
default: de/aristaflow/ilm/ws/soap/
description: The name of the directory that houses the SOAP web service classes. This directory is relative to the root of the resource of the AbstractWebServiceCommunicationService-class. Assume this class to be in a Jar-file then the default value of this configuration property represents the directory "de/aristaflow/ilm/ws/soap/" in this Jar-file. It needs to end with a "/".

de.aristaflow.adept2.base.communication.communicationservices.WebServiceCommunicationService

extends de.aristaflow.adept2.base.service.AbstractAuthenticatedService

Declared in default configuration as: ws

ServletNamePrefix
type: STRING
default: AristaFlowWebService
description: The prefix for the name of the web service servlets. This name is part of the URLs of the web services that are exported by the communication service.
WSDirectoryName
type: STRING
default: de/aristaflow/adept2/xml1/
description: The name of the directory that houses the web service classes, WSDLs and XSDs. This directory is relative to the root of the resource of the WebServiceCommunicationService-class. Assume this class to be in a Jar-file then the default value of this configuration property represents the directory"de/aristaflow/adept2/xml1/" in this Jar-file.
ValidateRequests
type: BOOLEAN
default: true
description: Whether to validate the XML requests of all exported service instances and stubs against the corresponding XSD.
ValidateResponses
type: BOOLEAN
default: false
description: Whether to validate the XML responses of all exported service instances and stubs against the corresponding XSD.

de.aristaflow.adept2.base.configuration.LoggerManager

Logging.Instances.ConsoleLogger v
type: STRING
default: null
description: This is a global configuration and not specific to a LoggerManager. A list of instances for a console logger. All of these loggers will print to console. Note that the order of the log messages of different loggers may be arbitrary and even interleaved.
Logging.<ConsoleOrFileLoggerInstance>.Root v
type: STRING
default: ""
description: This is a global configuration and specific to a console or file logger instance. The package or class name which is the root of the logger. Usually loggers use the name of the interface of the service for this, i. e. provide the name of a package of a service or the service interface name to log all messages of a service.
Logging.<ConsoleOrFileLoggerInstance>.Level v
type: STRING
default: OFF
description: This is a global configuration and specific to a console or file logger instance. The log level a log message has to have at least to be logged. Log messages with a more critical log level will also be logged. See java.util.logging.Level for the valid values. Invalid values will lead to the logger being ignored.
restrictions: oneof: OFF, SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, ALL
Logging.<ConsoleOrFileLoggerInstance>.Filter.Root v
type: STRING
default: ""
description: This is a global configuration and specific to a console or file logger instance. The filter root is a class name or a package (prefix) which restricts logging to this package/class. The corresponding logger needs to be retrieved via <code>LogService.getClassSpecificJulLogger(Class)</code> whereas this class matches the configured class name or package (prefix). This will also filter the name of the log record source class. Only if this matches the configuration value, the log record will be published. All other log records will be ignored. This also applies to log messages from parent classes. If you want log messages from other classes for this root class, configure these classes via <ConsoleOrFileLoggerInstance>.Filter.Classes.
Logging.<ConsoleOrFileLoggerInstance>.Filter.Classes v
type: STRING
default: ""
description: This is a global configuration and specific to a console or file logger instance. The filter classes are a list of class names or packages/package prefixes. The wildcard '*' is allowed. The log filter checks for the source class of a log record. This class has to match one of the package or class of this list. You can use this to restrict a logger without a filter root ( Filter.Root) to specific classes. In this case the wildcard '*' makes no sense. With a rootfilter the filter classes extend logging to include more classes besides the root class. Note that in this case the filter root only logs if it matches the filter classes.
Logging.Instances.FileLogger v
type: STRING
default: null
description: This is a global configuration and not specific to a LoggerManager. A list of instances for file loggers. Each of these loggers will log to a distinct log file.
Logging.FileLogger.LogDirectory v
type: STRING
default: ${arflow:arflow.logdir}
description: This is a global configuration and not specific to a LoggerManager. The log directory to be used for file loggers. If this is set, this directory will be used for the log files of loggers instead of the global log directory.
Logging.<FileLoggerInstance>.FileSize v
type: INT
default: 20971520
description: This is a global configuration and specific to a file logger instance. The number of bytes which to write at most to a log file. Afterwards a new log file will be created or the oldest log file will be deleted.
Logging.<FileLoggerInstance>.FileCount v
type: INT
default: 5
description: This is a global configuration and specific to a file logger instance. The number of log files to have for a specific logger. If all of them have reached their maximum size, the oldest log file will be deleted.
Logging.<FileLoggerInstance>.CSVMode v
type: BOOLEAN
default: false
description: This is a global configuration and specific to a file logger instance. Whether a file log should be written in CSV form. This allows to easily view the log file in a spreadsheet program. Usually, you should also activate CSV logging for the corresponding service to get request specific log information. See de.aristaflow.adept2.base.service.ADEPT2Service.CSVLogging.

de.aristaflow.adept2.base.dbaccess.defaultimplementation.AbstractJDBCDataSource

extends de.aristaflow.adept2.base.service.AbstractADEPT2Service
MaxStatementLength
type: INT
default: 2000000
description: The maximum length for SQL statements. This limit is not enforced, but should be respected when dynamically creating statements. This limit however should only be relevant for unusually long statements.
MaxParameterCount
type: INT
default: 2000
description: The maximum number of parameters in prepared statements. This limit is not enforced, but should be respected when dynamically creating statements.
MaxInOperatorParameterCount
type: INT
default: 1000
description: The maximum number of parameters within the IN-operator. This limit is not enforced, but should be respected when dynamically creating statements.
MetaUpdateAllowed
type: BOOLEAN
default: false
description: Whether this data source is allowed to perform a meta data update, if appropriate. That is, this data source updates sequences, stored procedures and other metadata that is required for implementing the JDBCDataSource interface completely. Since this adds and changes existing data (sequences, stored procedures, ...) and also creates new tables, it can be disabled. This is especially useful for data sources accessing foreign databases, for instance databases providing events. These should not be changed, however, with the meta data updates missing, some functions of this data source may fail at runtime, for instance, sequences or meta data changes like changing primary keys.
LockTablePollTime
type: LONG
default: 250
description: The time in milliseconds when to poll for a table lock. This is only relevant for DBMS which do not support locking a table with a timeout.
MaxSequenceCount
type: LONG
default: 10000
description: The amount of IDs (entries) in a sequence table before that table is cleared. A higher value causes less but longer clearing runs. This only applies to simulated sequences.

de.aristaflow.adept2.base.dbaccess.defaultimplementation.AppServerJDBCDataSource

extends de.aristaflow.adept2.base.dbaccess.defaultimplementation.AbstractJDBCDataSource
DataSource
type: STRING
default: null
description: The injected data source (instead of a JNDI look-up). If an object of type DataSource is provided, this will be preferred to the configured JNDI name.
DataSourceName
type: STRING
default: null
description: The logical name of a data source for JNDI look-up. This only applies if no valid DataSource has been injected into the configuration.
DBAccessProvider
type: STRING
default: null
description: The explicitly configured DB access provider class. If present, this will be used instead of an automatically detected one based on the datasource name.

de.aristaflow.adept2.base.dbaccess.defaultimplementation.BasicJDBCDataSource

extends de.aristaflow.adept2.base.dbaccess.defaultimplementation.AbstractJDBCDataSource
LibDirectory
type: STRING
default: ${arflow:arflow.libdir}
description: The name of the directory providing the JDBC libraries. This is actually the directory containing a directory named 'jdbc4' which in turn contains the JDBC drivers.
Driver *
type: STRING
description:
DBAccessProvider
type: STRING
default: null
description: The name of the used implementation of 'de.aristaflow.adept2.base.dbaccess.DBAccessProvider' to encapsulate vendor-specific stuff. Usually, this class is automatically detected using driver and URL to ask the DBMS.
ConnectionURL *
type: STRING
description:
UserName
type: STRING
default: ""
description:
Password
type: STRING
default: ""
description:

de.aristaflow.adept2.base.dbaccess.defaultimplementation.PoolingJDBCDataSource

extends de.aristaflow.adept2.base.dbaccess.defaultimplementation.BasicJDBCDataSource
MaxConnections
type: INT
default: 20
description: The maximum number of concurrent connections to the database that are allowed by this data source.
MaxLeaseTime
type: INT
default: 300
description: The period of time in seconds that a borrower is guaranteed to have the right to use a connection before the pool may decide to reclaim it. A connection will be reclaimed if both MaxLeaseTime and AbandonedTimeout expire.
AbandonedTimeout
type: INT
default: 300
description: The duration in seconds after which the pool considers a connection as abandoned by the borrower if no method is called on the connection or any of the created statements and result sets. A connection will be reclaimed if both MaxLeaseTime and AbandonedTimeout expire.
PoolExhaustionNotificationThreshold
type: INT
default: 0
description: If the number of available slots in the pool drops below this threshold, a warning will be logged. A value of 0 or less will deactivate this feature.
PoolExhaustionNotificationRatio
type: FLOAT
default: 0
description: If the ratio of available to total slots in the pool drops below this value, a warning will be logged. A value of 0 or less will deactivate this feature.
PoolRecoveryNotification
type: BOOLEAN
default: false
description: This flag determines if an info message will be logged to signal when the pool is back above the configuration exhaustion threshold and ratio.
CachePreparedStatements
type: BOOLEAN
default: true
description: Whether to cache prepared and callable statements within a connection.
UnwrapAllowed
type: BOOLEAN
default: false
description: Whether the connection, statement and result set guards should allow for unwrapping (java.sql.Wrapper). Note that using unwrapped objects may be problematic, for instance closing an unwrapped connection.
ValidTimeout
type: INT
default: 900
description: The timeout in seconds, for checking the validity of a connection. 0 means waiting forever, which is usually not recommended.
restrictions: range: 0 to x

de.aristaflow.adept2.base.javadoc.DefaultJavadocService

extends de.aristaflow.adept2.base.service.AbstractAuthenticatedService

Declared in default configuration as: JavadocService

ServletName
type: STRING
default: AristaFlowJavadoc
description: The prefix for the name of the servlet providing javadoc.

de.aristaflow.adept2.base.mailservice.simplemailservice.BaseMailService

extends de.aristaflow.adept2.base.service.AbstractADEPT2Service
From *
type: STRING
description: The sender used for sending mails.
Host *
type: STRING
description: The host name of the SMTP server.
Port
type: INT
default: 25
description: The port for of the SMTP server.
UseTLS
type: BOOLEAN
default: false
description: Whether TLS should be used for the connection to the SMTP server.
UseSSL
type: BOOLEAN
default: false
description: Whether SSL should be used for the connection to the SMTP server.
Overtrustful
type: BOOLEAN
default: false
description: Whether every certificate will be trusted.
User
type: STRING
default: ""
description: The user name for the SMTP server.
Password
type: STRING
default: ""
description: The password for the SMTP server.
ErrorRetries
type: INT
default: 3
description: The number of retries that will be started.
ErrorRetryWaitTime
type: LONG
default: 300
description: The time in seconds that will be waited before the next retry.
RedirectMailsTo
type: STRING
default: null
description: A list of mail addresses, all mails will be redirected to, instead of using the real mail addresses. This simplifies testing.
ConnectionTimeout
type: LONG
default: 30000
description: The socket connection timeout in milliseconds. Use 0to wait indefinitely.
Timeout
type: LONG
default: 30000
description: The socket read timeout in milliseconds. Use 0 to wait indefinitely.
WriteTimeout
type: LONG
default: 0
description: The socket write timeout in milliseconds. Use 0 to wait indefinitely.

de.aristaflow.adept2.base.mailservice.simplemailservice.ExtendedMailService

extends de.aristaflow.adept2.base.mailservice.simplemailservice.BaseMailService
RecipientSeparator
type: STRING
default: ;
description: The separator used for the recipients.
GlobalCC
type: STRING
default: ""
description: The gloabl cc recipients.
GlobalBCC
type: STRING
default: ""
description: The global bcc recipients.
GlobalHeader
type: STRING
default: ""
description: The global header.
GlobalFooter
type: STRING
default: ""
description: The global footer.

de.aristaflow.adept2.base.registry.AbstractRegistry

extends de.aristaflow.adept2.base.service.AbstractAuthenticatedService
Components.<ComponentTypeName> v
type: STRING
default: ""
description: The value is the name of an interface or class that represents a component type. Such a configuration entry declares a component type having this interface and the designated component type name, e.g. "Components.C = InterfaceClass1" declares a component type "C" having the interface "InterfaceClass1".
Instances.<ComponentTypeName> v
type: STRING
default: ""
description: A comma-separated list of arbitrary names, declaring each name as name of an instance of the corresponding component type, e.g. "Instances.C = I1, I2, I3" declares the instances"I1", "I2" and "I3" of the component type "C".
<InstanceName>.Implementation v
type: STRING
default: ""
description: The value is the name of a class that implements or extends the interface of the component type and will be available under the designated instance name, e.g. "I1.Implementation = ImplementationClass1" declares the instance "I1" as being an instance of "ImplementationClass1" which implements "InterfaceClass1". The implementation class needs to have an appropriate constructor.
This can also be an object instance which allows for injecting instances into the configuration. In this case the InstantiationMode has to be "SINGLETON". Instead of calling the constructor, the registry tries to find and call the optional method "initPlatform" with the same parameters as the constructor would have.
<InstanceOrComponentTypeName>.InstantiationMode v
type: STRING
default: SINGLETON
description: Specifies how to instantiate the implementation of a componentinstance. This can be either a singleton, several instances or no instance at all, i. e. the component instance is disabled. For instance "I1.InstantiationMode = MULTIPLE" will create several object instances of "ImplementationClass1".
restrictions: oneof: SINGLETON, MULTIPLE, OFF
<InstanceName>.ConfigFile v
type: STRING
default: ""
description: The value specifies a file that contains the configuration for the designated instance. This does only contain the configuration provided to the instance but not the meta configuration that is used by the registry to create and manage the instance. The instance configuration can also be part of the configuration file of the registry. In this case all configuration values for the instance need the corresponding name as prefix.
<InstanceName>..RuntimeConfiguration.File v
type: STRING
default: ""
description: The file (path) of a configuration file that stores and provides the runtime configuration of the designated instance.
<InstanceName>..RuntimeConfiguration.JDBCDataSource v
type: STRING
default: ""
description: The simple name of an instance of a JDBC data source. This instance will be used to store and provide the runtime configuration of the designated instance. This is used instead of a runtime configuration file(File).

de.aristaflow.adept2.base.registry.CsvLoggerManager

extends de.aristaflow.adept2.base.configuration.LoggerManager

de.aristaflow.adept2.base.registry.InstanceToInstanceRegistry

extends de.aristaflow.adept2.base.registry.PluginRegistry
<InstanceName>.<UsedComponentType> v
type: STRING
default: ""
description: The simple instance name of the used component type that will be returned if the designated instance requests an instance of the used component type. This allows to declare usage relations for component instances. The using instance may also be the anonymous instance, that is, its name corresponds to its component type name.

de.aristaflow.adept2.base.registry.LocalSecurityManager

extends de.aristaflow.adept2.base.service.AbstractADEPT2Service
LSMKeyModulus
type: STRING
default: ${arflow:confVar.LSMKeyModulus}
description: The modulus of the public/private key pair of the local security manager.
LSMKeyPublicExponent
type: STRING
default: ${arflow:confVar.LSMKeyPublicExponent}
description: The exponent of the public key of the local security manager.
LSMKeyPrivateExponent
type: STRING
default: ${arflow:confVar.LSMKeyPrivateExponent}
description: The exponent of the private key of the local security manager.
ServiceAuthUserName
type: STRING
default: ${arflow:confVar.SystemUserName}
description:
ServiceAuthOrgPosID
type: STRING
default: ${arflow:confVar.SystemOrgPosId}
description:
ServiceAuthPassword
type: STRING
default: ${arflow:confVar.SystemUserPassword}
description:
LocalSystemAgentPassword
type: STRING
default: ${arflow:confVar.SystemUserPassword}
description: The password of the local system user to be used for services authenticating against this security manager as system agent locally. This is only relevant if not using JAAS locally.
UseJAAS
type: BOOLEAN
default: false
description: Whether to use JAAS for authentication. This is done locally and the subject is afterwards sent to the global security manager. This allows for Single Sign-On. Note that the JAAS configuration has to be set appropriately in the local JVMs. The application name for the JAAS configuration is the complete name of this class (de.aristaflow.adept2.base.registry.LocalSecurityManager).
SupportNetAuth
type: BOOLEAN
default: false
description: Whether to support network-based authentication. If so, the required network addresses will be determined in the constructor and if there are problems, the security manager will not be instantiated. If the support is deactivated, the network-based authentication methods will not work and throw an AuthenticationException. When activating the support, make sure that the local JVM can determine its host name/IP address.
NetLocalAddress v
type: STRING
default: <InetAddress.getLocalHost()>
description: The name or address of the network device of the local machine which to use for network-based authentication (see SupportNetAuth).
DelayBadAuthentication
type: BOOLEAN
default: true
description: Whether to to apply a delay when an authentication failed. This prevents brute force attacks. If a delay applies, further configuration entries apply.
UndelayedTries
type: INT
default: 2
description: The number of authentication tries that do not lead to a delay. Setting this to a high number increases the risk of brute force attacks. This will only apply if the delay is activated.
ThreadBasedDelay
type: BOOLEAN
default: true
description: Whether the delay for wrong authentication tries is based on threads, that is the authentication thread will be delayed. Note that this is more secure but it works locally and only if the very same thread is used for each related authentication try. Otherwise the delay will be based on the agent name. But this only works in case an agent name is provided.

de.aristaflow.adept2.base.registry.LocalServiceRegistry

extends de.aristaflow.adept2.base.registry.InstanceToInstanceRegistry
MultiThreadedServiceStartPoolSize
type: INT
default: 0
description: The amount of threads that will be used for theconcurrent service start. The value '0' means, that the services are started sequentially. For a server at least 20 threads are needed, for a client at least 10 threads are needed.
AutoStartServices
type: STRING
default: null
description: The (simple) names of the services to start when starting the registry.
Components.ModelFactoryRegistry *
type: STRING
description: a required sub-registry for the server registry
<InstanceName>.ExportVia v
type: STRING
default: ""
description: The LocalServiceRegistry considers declared component instances to extend ADEPT2Service. These can be exported so that their API can be used from other JVMs. ExportVia declares a list of comma-separated instances of communication services which are used to export the specifiedservice. That is, all communication services in the list will be asked to export the service.

de.aristaflow.adept2.base.registry.PluginRegistry

extends de.aristaflow.adept2.base.registry.AbstractRegistry
Instances.<ComponentTypeName> v
type: STRING
default: ""
description: The PluginRegistry extends the semantic of the comma-separated list as follows:
The first declared instance is the default instacne of the corresponding component type.
If the list is empty, an implicit (default) instance will exist having the same name as the component type, e. g. "C.C". This is called the anonymous instance.
One element of the list but not the first one can be "*". This enablesdynamic and runtime instances for this component type. Dynamic plugins are declared by separate configuration files being somewhere in the classpath ofthis PluginRegistry. The name of the configuration files are the name of the corresponding component/plugin type. The configurations contain the same information as a plugin configuration read by this PluginRegistry.
<InstanceOrComponentTypeName>.PluginTypes v
type: STRING
default: ""
description: A list of comma-separated component type names that declares these component types as plugin types for the specified component instance or component type. This means, the component instance or all instances of thiscomponent type are able to load load and use plugins of the listed component types. For instance "I1.PluginTypes = PT1, PT2, PT3" declares "I1" as able to load and use instances of the component types "PT1", "PT2" and "PT3". This can also be "C.PluginTypes = PT1, PT2, PT3"
<ComponentTypeName>.PluginClassPath v
type: STRING
default: ""
description: A classpath (separated by ";") which is the classpath of the specified plugin type. This classpaths is used to search for runtime plugin instances (or rather their configurations).
<InstanceName>.ClassPath v
type: STRING
default: ""
description: A classpath (separated by ";") which is the classpath of the specified runtime plugin instance.

de.aristaflow.adept2.base.registry.ServiceRegistry

extends de.aristaflow.adept2.base.registry.LocalServiceRegistry
Components.GlobalRegistry *
type: STRING
description: a required sub-registry
GlobalRegistry.PublishService
type: BOOLEAN
default: false
description: The global registry must not be published! This is validated when checking the configuration
Components.CommunicationService *
type: STRING
description: a communication service that must be configured in this registry
GlobalStubProxyAnnotationCacheSize
type: INT
default: ${arflow:confVar.ProxyAnnotationCacheSize}
description: The size of the cache for stubs with late binding containing whether a specific class has a proxy annotation (ProxyAllow, ProxyCallback, ServerSideProxyAllow) or implements ServerSideProxy. Use 0 or a negative value to disable caching.
GlobalStubProxyLazyMethodValidTime
type: LONG
default: ${arflow:confVar.ProxyLazyMethodValidTime}
description: The time in milliseconds the return value of a lazy method will be reused. Use 0 or a negative value to disable caching for a lazy method.
GlobalStubCachingRemItInitAliveTime
type: LONG
default: 80000
description: The time in milliseconds to keep the caching remote iterators alive after creating them and without accessing them. These caching remote iterators wrap all remote iteraters received via stub with late binding.
GlobalStubCachingRemItAliveTimeExtension
type: LONG
default: null
description: The time in milliseconds to extend the time caching remote iterators will be kept alive after each access. These caching remote iterators wrap all remote iteraters received via stub with late binding. If this extension time is not configured, the initial alive time will be used for extension.
restrictions: range: 0 to x
<InstanceName>.ServiceURI v
type: STRING
default: ""
description: The URI with which a service instance is available on a remote server. This URI depends on the used communication service. The same communication service instance needs to be available locally so that the remote service can be reached.
<InstanceName>.PublishService v
type: BOOLEAN
default: false
description: Whether the designated service instance is to be published at the global registry. The global registry resembles a DNS service that provides the URIs of remote services of which the concrete URI is unknown. The global registry allows to retrive these services. Obviously the global registry itself cannot be published; users need to know the URI of the global registry.

de.aristaflow.adept2.base.service.AbstractADEPT2Service

CSVLogging
type: BOOLEAN
default: false
description: Specifies if the extensive CSV logging for debugging or performance tuning is to be used. Since this has a serious performance impact, it should not be used in production environments.

de.aristaflow.adept2.base.service.AbstractAuthenticatedService

extends de.aristaflow.adept2.base.service.AbstractADEPT2Service
ServiceAuthUserName
type: STRING
default: ${arflow:confVar.SystemUserName}
description: The user name with which this service authenticates at the global security manager.
ServiceAuthOrgPosID
type: LONG
default: -9223372036854775808
description: The ID of the organisational position with which this service authenticates at the global security manager. This is only required for the system agent and agents that occupy several org positions. If it is required, the organisational position can also be specified via its name (ServiceAuthOrgPosName)
ServiceAuthOrgPosName
type: STRING
default: null
description: The case-sensitive name of the organisational position with which this service authenticates at the global security manager. This is only required for agents that occupy several org positions. If it is required, the organisational position can also be specified via its ID (ServiceAuthOrgPosID)
ServiceAuthPassword
type: STRING
default: ${arflow:confVar.SystemUserPassword}
description: The encrypted password with which this service authenticates at the global security manager.
EarlyServiceAuthUserName
type: STRING
default: ${arflow:confVar.EarlySystemUserName}
description: The user name with which this service authenticates at the local security manager in case this service is started before the global security manager.
EarlyServiceAuthOrgPosID
type: LONG
default: -9223372036854775808
description: The ID of the organisational position with which this service authenticates at the local security manager in case this service is started before the global security manager. This is only required for the system agent and agents that occupy several org positions. If it is required, the organisational position can also be specified via its name(EarlyServiceAuthOrgPosName)
EarlyServiceAuthOrgPosName
type: LONG
default: -9223372036854775808
description: The case-sensitive name of the organisational position with which this service authenticates at the local security manager in case this service is started before the global security manager. This is only required for agents that occupy several org positions. If it is required, the organisational position can also be specified via its ID (EarlyServiceAuthOrgPosID)
EarlyServiceAuthPassword
type: STRING
default: ${arflow:confVar.EarlySystemUserPassword}
description: The encrypted password with which this service authenticates at the local security manager in case this service is started before the global security manager.

de.aristaflow.adept2.base.service.AbstractConfigurableAuthenticatedService

extends de.aristaflow.adept2.base.service.AbstractAuthenticatedService

de.aristaflow.adept2.base.service.AbstractConfigurableService

extends de.aristaflow.adept2.base.service.AbstractADEPT2Service

de.aristaflow.adept2.base.service.AbstractNonPrivilegedService

extends de.aristaflow.adept2.base.service.AbstractADEPT2Service
ServiceAuthUserName
type: STRING
default: ${arflow:confVar.SystemUserName}
description: The user name with which this service authenticates at the global security manager.
ServiceAuthOrgPosID
type: LONG
default: -9223372036854775808
description: The ID of the organisational position with which this service authenticates at the global security manager. This is only required for the system agent and agents that occupy several org positions. If it is required, the organisational position can also be specified via its name (ServiceAuthOrgPosName)
ServiceAuthOrgPosName
type: STRING
default: null
description: The case-sensitive name of the organisational position with which this service authenticates at the global security manager. This is only required for agents that occupy several org positions. If it is required, the organisational position can also be specified via its ID (ServiceAuthOrgPosID)
ServiceAuthPassword
type: STRING
default: ${arflow:confVar.SystemUserPassword}
description: The encrypted password with which this service authenticates at the global security manager.

de.aristaflow.adept2.base.servletcontainer.defaultimplementation.JettyServletService

extends de.aristaflow.adept2.base.service.AbstractADEPT2Service

Declared in default configuration as: ServletService

ThreadCount
type: INT
default: 100
description: The amount of concurrent web service requests the servlet container can handle.
Host
type: STRING
default: ""
description: This configuration entry is used to set the address of the server. It can be either a host name or an IP address and optionally have a subnet mask in CIDR notation. The host name just needs to be in the corresponding subnet, it need not be a name of the current machine. Bt the current machine has to have a network interface with the host name or IP address or one that is in the specified subnet. This will be checked when starting. You can use 0.0.0.0 or * to listen on all available network interfaces. In this case you have to provide an external host name/IP address! If nothing is provided, the address of the default network interface of the current machine will be used.
Port
type: INT
default: 0
description: This property is used to set the port where the socket should listen for incoming messages. The default port is '80'.
ExternalHost
type: STRING
default: ""
description: This configuration entry is used to set the external host name/IP address of the server. This will be used in exported URIs with which clients connect to the server. It can be a host name or an IP address. No validity will be checked so make sure that clients can connect to this address and their requests will be forwarded appropriately to the server. If nothing is provided, the host name/IP address determined from the network interfaces will be used.
ExternalPort
type: INT
default: 0
description: This configuration entry is used to set the external port of the server. This will be used in exported URIs with which clients connect to the server, e. g. the port of a proxy which forwards to this server. No validity will be checked so make sure that clients can connect to this port and their requests will be forwarded appropriately to the server. If nothing is provided, the port of Jetty will be used directly.
ExternalProtocol
type: STRING
default: ""
description: This configuration entry is used to set the external protocol of the server. This will be used in exported URIs with which clients connect to the server, e. g. the protocol of a proxy which forwards to this server. No validity will be checked so make sure that clients can connect to this address and their requests will be forwarded appropriately to the server. If nothing is provided, the protocol of Jetty will be used directly.
KeystorePath
type: STRING
default: ${arflow:arflow.datadir}
description: This property is used to set the certificate path that is used for the SSL encryption of the servlet container.
KeystoreFile
type: STRING
default: cert.jks
description: This property is used to set the certificate file that is used for the SSL encryption of the servlet container.
KeystorePass
type: STRING
default: 0HoviMg4O3eeKW5kfmLJaI3x8vGG+bzEsjKRdYsIIoY7+8NsB+Dn2BjMhDvkhpOv9pHWuNtiKpOxKKmv9QjvRA+/jdCMZx6ebnZQNECdTiI6DuvyzuAYaZVPx3XefQS4J4lu60BlRg7ftxYr4FuMGwvEEqOOEacL8JOFXXV8IibJdeoS4elqiz5pOKwr2N04Z68BSYc27qTHsopzRA93beNuxEipZ2F/mB/bSe5ZFGQMYvxx6p57GyaE2o6hj/0j/GgUHJtKEWrYUu99lqxvax7Ym0LFnRjJzU8Z/cIQgh22pgYmSYweKKWAmKyrVrW4ypGwlin1ZSEGaB97cxCd5Q==
description: This property is used to set the certificate password that is needed for the SSL encryption.
UseSSL
type: BOOLEAN
default: false
description: This property is used to signal, whether SSL encryption should be used or not. This performs a name check of the HTTPS requests, so the used SSL certificate has to contain the names (wildcards allowed) and/or IP addresses with which the servlet service will receieve requests.
LogHTTPChannel
type: BOOLEAN
default: false
description: Whether request and response handling should be logged. Different notifications logged with different levels. So configure your logger appropriately.
Enabling this has significant impact on performance.

de.aristaflow.adept2.core.automaticclient.AutomaticClient

extends de.aristaflow.adept2.base.service.AbstractNonPrivilegedService

Declared in default configuration as: AutomaticClient

PoolSize
type: INT
default: 5
description: The amount of executor threads for starting and the amount of threads for resuming items. At least 1 will be used.
UseOneWorkExecutor
type: BOOLEAN
default: true
description: Whether to use the one-work executor which prevents duplicate worklist item handling. Set this to false to get the old and deprecated behaviour. This will be removed in a future version.
QueueLimitPoolStatistics
type: INT
default: -1
description: The total amount of tasks being the threshold for logging pool statistics. The default is to use core and max pool size.
MinLogLevelPoolStatistics
type: STRING
default: ALL
description: The log level which need to be reached for logging pool statistics. Pool statistics logs with a lower log level will be ignored.
KeepAliveTime
type: LONG
default: 60000
description: The time span in milliseconds idle threads wait for new work in a pool instead of being removed.
PingWLM
type: LONG
default: 5000
description: The time span in milliseconds after which the worklist manager is pinged to check whether it is still available. If not, reconnecting will be tried in the same time span.
ReconnectWLM
type: LONG
default: 300000
description: The time span in milliseconds after which reconnecting to the worklist manager is forced if no push update was received yet.
ReconnectLogLevel
type: STRING
default: INFO
description: The log level to log that no push update was received yet.
CreateWorklistSilentCount
type: INT
default: 10
description: The number of retries for creating (retrieving) a client worklist before logging the exception as critical.
CreateWorklistRetryDelay
type: LONG
default: 20000
description: The time in milliseconds to wait before retrying to create (retrieve) a client worklist.
WorkerPriority
type: INT
default: 3
description: The priority of the worker threads. The worklist handler thread responsible for worklist updates will have a priority higher by 2.
WorkerStackSize
type: LONG
default: 0
description: The stack size of the worker threads in KiB. This has to be chosen with care. Since there are a lot of threads this should be as low as possible to avoid OutOfMemoryError. However setting it too low may lead to StackOverflowError. 0 uses the default stack size of the JVM.
RunningActivityLimit
type: INT
default: 100
description: The amount of worklist items for activities that are executed concurrently. Since resumed items have a scheduled start time, they may lead to a temporary violation of this limit.
UpdateInterval
type: LONG
default: 1000
description: The interval for pushed updates in ms.
AutomaticallyResume
type: BOOLEAN
default: true
description: Whether the automatic client should automatically resume the appropriate activities if supported by its runtime manager. This creates a second thread pool.
ResumingNeeded
type: BOOLEAN
default: false
description: Whether a resuming runtime manager is crucial for running this automatic client. If so, the automatic client will not start if it does not have an appropriate runtime manager. This configuration will only make sense if the automatic client should automatically resume.
ResumeOnly
type: BOOLEAN
default: false
description: Whether the automatic client should just resume items but not start new items. This allows to drain the work of this automatic client.
ResumeWithoutTime
type: BOOLEAN
default: false
description: Whether the automatic client resumes all suspended worklist items that have no resume time set. Do not use this flag in case there are several automatic clients using the same user credentials.
DataDirectory
type: STRING
default: ${arflow:arflow.datadir}
description: The directory where to store the file containing the persisted resume times.
RuntimeManagerAvailabilityPollRate
type: LONG
default: 15000
description: The rate (in milliseconds) at which to poll the availability of the runtime manager. This is required to ensure that the user of the automatic client is logged on at the runtime manager.

de.aristaflow.adept2.core.checks.processmodel.DefaultProcessCheckService

extends de.aristaflow.adept2.base.service.AbstractAuthenticatedService

Declared in default configuration as: ProcessChecks

BasicModellingChecks
type: STRING
default: ""
description:

de.aristaflow.adept2.core.checks.processmodel.activity.AllExecutableComponentChecks

extends de.aristaflow.adept2.base.service.AbstractAuthenticatedService

Declared in default configuration as: AllExecutableComponentChecks

de.aristaflow.adept2.core.client.MultiplexingClientService

extends de.aristaflow.adept2.base.service.AbstractAuthenticatedService
ExecutorPoolSize
type: INT
default: 10
description: The amount of threads used for the shared executor service.
ScheduledExecutorPoolSize
type: INT
default: 5
description: The amount of threads used for the shared scheduled executor service.
ServiceAvailabilityPoolSize
type: INT
default: 3
description: The amount of threads used of threads used for checking the availability of services and notifying registered listeners.
ServiceAvailabilityPollRate
type: LONG
default: 20000
description: The rate in milliseconds services are polled for whether they are available.

de.aristaflow.adept2.core.client.implementation.DefaultADEPT2ClientService

extends de.aristaflow.adept2.core.client.implementation.RuntimeLessClientService

Declared in default configuration as: ClientService

RemItInitAliveTime
type: LONG
default: 80000
description: The time in milliseconds to keep a remote iterator alive after creating it and without accessing it.
RemItAliveTimeExtension
type: LONG
default: null
description: The time in milliseconds to extend the time a remote iterator will be kept alive after each access. If this is not configured, the initial alive time will be used for extension.
restrictions: range: 0 to x

de.aristaflow.adept2.core.client.implementation.RAPADEPT2ClientService

extends de.aristaflow.adept2.core.client.MultiplexingClientService

de.aristaflow.adept2.core.client.implementation.RuntimeLessClientService

extends de.aristaflow.adept2.base.service.AbstractADEPT2Service
SynchronousAgentChangedNotification
type: BOOLEAN
default: false
description: Whether active agent changes are notified synchronously by the thread indicating the active agent change. Otherwise a separate executor service will forward the change to registered listeners.
SynchronousSelectionChangedNotification
type: BOOLEAN
default: false
description: Whether selection changes are notified synchronously by the thread indicating the selection change. Otherwise a separate executor service will forward the change to registered listeners.
ExecutorPoolSize
type: INT
default: 5
description: The amount of threads used for the shared executor service.
ScheduledExecutorPoolSize
type: INT
default: 5
description: The amount of threads used for the shared scheduled executor service.
ServiceAvailabilityPoolSize
type: INT
default: 3
description: The amount of threads used of threads used for checking the availability of services and notifying registered listeners.
ServiceAvailabilityPollRate
type: LONG
default: 20000
description: The rate in milliseconds services are polled for whether they are available.

de.aristaflow.adept2.core.common.LocalNotificationService

extends de.aristaflow.adept2.base.service.AbstractADEPT2Service
NotifierPoolSize
type: INT
default: 10
description: The amount of executor threads for sending notifications to registered listeners.

de.aristaflow.adept2.core.eventmanager.common.AbstractEventManager

extends de.aristaflow.adept2.base.service.AbstractNonPrivilegedService
LibDirectory
type: STRING
default: ${arflow:arflow.libdir}
description: The name of the directory providing the JDBC libraries. This is actually the directory containing a directory named 'jdbc4' which in turn contains the JDBC drivers.
ServiceTypesForEvents
type: STRING
default: ""
description: The type names of services that are required for the configured or dynamically added event sources and/or handlers. This ensures that these services are available while shutting down the event manager.
AddEventSourceRetryCount
type: INT
default: 10
description: The number of retries for adding an event source.
AddEventSourceRetryDelay
type: LONG
default: 20000
description: The time in milliseconds to wait before retrying to add an event source.
MinPoolSize
type: INT
default: 5
description: The minimal number of executor threads for polling events. At least 1 will be used. The same amount will also be used for adding event sources.
UseOneWorkExecutor
type: BOOLEAN
default: true
description: Whether to use the one-work executor which prevents duplicate worklist item handling. Set this to false to get the old and deprecated behaviour. This will be removed in a future version.
QueueLimitPoolStatistics
type: INT
default: -1
description: The total amount of tasks being the threshold for logging pool statistics. The default is to use core and max pool size.
MinLogLevelPoolStatistics
type: STRING
default: ALL
description: The log level which need to be reached for logging pool statistics. Pool statistics logs with a lower log level will be ignored.
PingWLM
type: INT
default: 5000
description: The time span in milliseconds after which the worklist manager is pinged to check whether it is still available. If not, reconnecting will be tried in the same time span.
ReconnectWLM
type: LONG
default: 600000
description: The time span in milliseconds after which reconnecting to the worklist manager is forced if no push update was received yet.
ReconnectLogLevel
type: STRING
default: INFO
description: The log level to log that no push update was received yet.
CreateWorklistSilentCount
type: INT
default: 10
description: The number of retries for creating (retrieving) a client worklist before logging the exception as critical.
CreateWorklistRetryDelay
type: LONG
default: 20000
description: The time in milliseconds to wait before retrying to create (retrieve) a client worklist.
PollerPriority
type: INT
default: 3
description: The priority of the worker threads. The worklist handler thread responsible for worklist updates will have a priority higher by 2.
HandlerMinPoolSize
type: INT
default: 5
description: The minimal number of executor threads for handling events concurrently by various sources.
HandlerPriority
type: INT
default: 5
description: The priority of the event handling threads used by various sources.
HandlerQueueLimit
type: INT
default: 25
description: The number of tasks in the executor queue that are allowed before warnings will be logged.
UpdateInterval
type: LONG
default: 1000
description: The interval for pushed updates in ms.
ResumeOnly
type: BOOLEAN
default: false
description: Whether the automatic client should just resume items but not start new items. This allows to drain the work of this automatic client.

de.aristaflow.adept2.core.eventmanager.common.DefaultEventManager

extends de.aristaflow.adept2.core.eventmanager.common.AbstractEventManager

Declared in default configuration as: EventManager

de.aristaflow.adept2.core.eventmanager.fileevents.FileEventActivityHandler

Declared in default configuration as: FileActHandler

IsCritical
type: BOOLEAN
default: true
description: Whether the event handler is critical and problems handling the event should abort all handling of the current event.
<ParameterName> v
type: STRING
default: ""
description: This is the name of an output parameter. Depending on the name, the corresponding value will be stored in the output parameter, i. e. file name, modification date or file content (or reference (URI)).
restrictions: oneof: Filename, ModifiedDate, File

de.aristaflow.adept2.core.eventmanager.fileevents.FileMarkHandler

Declared in default configuration as: FileMarkHandler

IsCritical
type: BOOLEAN
default: true
description: Whether the event handler is critical and problems handling the event should abort all handling of the current event.
HandleConsumed
type: BOOLEAN
default: true
description: Whether this handler should also handle files of which the corresponding file event has been consumed.
DeleteFile
type: BOOLEAN
default: false
description: Whether to delete files from file events. Note that the file does not exist any more afterwards. Therefore you will usually have to store the complete file within the activity/process instance; a URI is not sufficient.
RenameFile
type: BOOLEAN
default: false
description: Whether to rename files from file events. Note that the file does not exist any more afterwards. Therefore you will usually have to store the complete file within the activity/process instance; a URI is not sufficient.
The MarkInstanceStartEventHandler is an exception since this creates a file reference after renaming.
TargetName
type: STRING
default: null
description: The name or a pattern of the name the file should be renamed to or a pattern the names of the lock files. The pattern may contain a '*' which will be replaced by the current file name when renaming as well as for the lock files.
AddFile
type: BOOLEAN
default: false
description: Whether to add a lock file for files from file events. If using this, provide an appropriate file name pattern via 'TargetName' and make sure, that the corresponding eventsource ignores these lock files.
MoveFile
type: BOOLEAN
default: false
description: Whether to move files (or directories) from file events to a different directory so that the event source does not find them again. Note that the file does not exist any more afterwards. Therefore you will usually have to store the complete file within the activity/process instance; a URI is not sufficient.
The MarkInstanceStartEventHandler is an exception since this creates a file reference after moving.
TargetFolder
type: STRING
default: null
description: The name of the target folder in case the files (or directories) of file events should be moved. This only applies if the files from file events should be moved.
ReplaceExisting
type: BOOLEAN
default: false
description: Whether to replace an existing target file or a file in the target folder. This applies to renaming and moving. Do not use this in case you only provide a reference (URI) to the activity/process instance. Otherwise the file content you expect may be overwritten by a different file having the same file name.
MarkLockFile
type: STRING
default: false
description: Whether the lock file should be marked instead of the data file.

de.aristaflow.adept2.core.eventmanager.fileevents.InstanceStartEventHandler

Declared in default configuration as: FileInstHandler

IsCritical
type: BOOLEAN
default: true
description: Whether the event handler is critical and problems handling the event should abort all handling of the current event.
ProcessType *
type: STRING
description: The process type of which to start the "latest" template as soon as the event occurs.
<ParameterName> v
type: STRING
default: ""
description: This is the name of an input parameter of the (latest template of the) designated process type. Depending on the name, the corresponding value will be stored in the input parameter, i. e. file name, modification date, file content (or reference (URI)) or lock file content (or reference (URI)).
restrictions: oneof: Filename, ModifiedDate, File, LockFile

de.aristaflow.adept2.core.eventmanager.fileevents.MarkInstanceStartEventHandler

extends de.aristaflow.adept2.core.eventmanager.fileevents.FileMarkHandler

Declared in default configuration as: FileMarkInstHandler

ProcessType *
type: STRING
description: The process type of which to start the "latest" template as soon as the event occurs.

de.aristaflow.adept2.core.eventmanager.mailevents.ClientCredentialsAccessTokenProvider

Declared in default configuration as: OAuth2AccessTokenProvider

TokenEndpoint *
type: STRING
description: The HTTP-based endpoint used to acquire the OAuth 2.0 token.
ClientId *
type: STRING
description: The client ID identifiers the requesting application; similar to a user name.
ClientSecret *
type: STRING
description: The client secret authenticating the requesting application; similar to a user's password.
Scope
type: STRING
default: null
description: An optional scope for the access token.
ClientTimeoutSeconds
type: LONG
default: 10
description: The time in seconds for establishing a connection with the server.
RequestTimeoutSeconds
type: LONG
default: 15
description: The time in seconds for the whole HTTP call.

de.aristaflow.adept2.core.eventmanager.mailevents.InstanceStartEventHandler

Declared in default configuration as: MailInstHandler

IsCritical
type: BOOLEAN
default: true
description: Whether the event handler is critical and problems handling the event should abort all handling of the current event.
FileStorePath
type: STRING
default: null
description: File system path for storing mails, e.g. in case URI parameters are used for storing the message. If this is not set, temporary files will be created.
ProcessType *
type: STRING
description: The process type of which to start the "latest" template as soon as the event occurs.
<ParameterName> v
type: STRING
default: ""
description: Use these names for the input parameters of the template which to start. This handler will then write the corresponding input parameter. Each name corresponds to the related property of the mail. Respect the data type.
restrictions: oneof: Subject (STRING), From (STRING), To (STRING or USERDEFINED(subtable) or USERDEFINED(java.util.List<URI>)), CC (STRING or USERDEFINED(subtable) or USERDEFINED(java.util.List<URI>)), BCC (STRING or USERDEFINED(subtable) or USERDEFINED(java.util.List<URI>)), Sent Date (DATE), Body (STRING), Message (URI or USERDEFINED), Attachments (USERDEFINED(subtable) or USERDEFINED(java.util.List<URI>))

de.aristaflow.adept2.core.eventmanager.mailevents.MailEventActivityHandler

Declared in default configuration as: MailActHandler

IsCritical
type: BOOLEAN
default: true
description: Whether the event handler is critical and problems handling the event should abort all handling of the current event.
FileStorePath
type: STRING
default: null
description: File system path for storing mails, e.g. in case URI parameters are used for storing the message. If this is not set, temporary files will be created.
MailEvent.Field v
type: STRING
default: ""
description: This is a configuration value at an output parameter of the corresponding activity. The name refers to the field of the mail which to store as value of the corresponding output parameter.
restrictions: oneof: Subject, From, To, Sent Date, Body, Message, Attachments
MailEvent.Regex v
type: STRING
default: ""
description: This is a configuration value at an output parameter of the corresponding activity. The regular expression against which the content of the mail will be matched. The matching group will then be stored as value of the corresponding output parameter.
MailEvent.Group v
type: LONG
default: ""
description: This is a configuration value at an output parameter of the corresponding activity. The matching group of the regular expression ("MailEvent.Regex") which will be stored as value of the corresponding output parameter.

de.aristaflow.adept2.core.eventmanager.mailevents.MailFlagHandler

Declared in default configuration as: MailFlagHandler

IsCritical
type: BOOLEAN
default: true
description: Whether the event handler is critical and problems handling the event should abort all handling of the current event.
HandleConsumed
type: BOOLEAN
default: true
description: Whether this handler should also handle (set flags, move, expunge) messages of which the corresponding mail event has been consumed.
ChangeFlagAnswered
type: BOOLEAN
default: false
description: Whether to change the answered flag of the messages from mail events.
SetFlagAnswered
type: BOOLEAN
default: false
description: How to set the answered flag of messages from mail events. This only applies if the corresponding flag should be changed.
ChangeFlagDeleted
type: BOOLEAN
default: false
description: Whether to change the deleted flag of the messages from mail events.
SetFlagDeleted
type: BOOLEAN
default: false
description: How to set the deleted flag of messages from mail events. This only applies if the corresponding flag should be changed.
ChangeFlagDraft
type: BOOLEAN
default: false
description: Whether to change the draft flag of the messages from mail events.
SetFlagDraft
type: BOOLEAN
default: false
description: How to set the draft flag of messages from mail events. This only applies if the corresponding flag should be changed.
ChangeFlagFlagged
type: BOOLEAN
default: false
description: Whether to change the flagged flag of the messages from mail events.
SetFlagFlagged
type: BOOLEAN
default: false
description: How to set the flagged flag of messages from mail events. This only applies if the corresponding flag should be changed.
ChangeFlagRecent
type: BOOLEAN
default: false
description: Whether to change the recent flag of the messages from mail events.
SetFlagRecent
type: BOOLEAN
default: false
description: How to set the recent flag of messages from mail events. This only applies if the corresponding flag should be changed.
ChangeFlagSeen
type: BOOLEAN
default: false
description: Whether to change the seen flag of the messages from mail events.
SetFlagSeen
type: BOOLEAN
default: false
description: How to set the seen flag of messages from mail events. This only applies if the corresponding flag should be changed.
ChangeFlagUser
type: BOOLEAN
default: false
description: Whether to change the user flag of the messages from mail events.
SetFlagUser
type: BOOLEAN
default: false
description: How to set the user flag of messages from mail events. This only applies if the corresponding flag should be changed.
TargetFolder
type: STRING
default: null
description: The name of the target folder in case the messages of mail events should be moved.
Expunge
type: BOOLEAN
default: false
description: Whether the folder of messages from mail events should be expunged. This really deletes messages that have deleted flag set. Therefore if you want do delete a handled message finally, set the deleted flag and expunge the folder.

de.aristaflow.adept2.core.jmx.MBeanService

extends de.aristaflow.adept2.base.service.AbstractAuthenticatedService

Declared in default configuration as: MBeanService

de.aristaflow.adept2.core.mailservice.basemailservice.BaseMailService

extends de.aristaflow.adept2.base.service.AbstractAuthenticatedService

de.aristaflow.adept2.core.registry.AuthenticatedInjectedService

extends de.aristaflow.adept2.core.registry.InitialisedInjectedService
ServiceAuthUserName
type: STRING
default: ${arflow:confVar.SystemUserName}
description:
ServiceAuthOrgPosID
type: LONG
default: -9223372036854775808
description:
ServiceAuthPassword
type: STRING
default: ${arflow:confVar.SystemUserPassword}
description:

de.aristaflow.adept2.core.registry.BootstrapRegistry

extends de.aristaflow.adept2.base.registry.ServiceRegistry
Components.ClientService *
type: STRING
description: A required service to provide clients convenient access to platform services.
This.ClusterName
type: STRING
default: null
description: The name for the cluster of this bootstrapped platform.
This.InstanceName *
type: STRING
description: The name for the bootstrapped platform.
This.URI
type: STRING
default: ""
description: The URI to identify the bootstrapped platform.
SecurityManager
type: STRING
default: OrgModelManager
description: The security manager (instance of organisational model manager) to use for authentication in the platform.
TerminationThreadDumpIntervalSeconds
type: INT
default: 0
description: If set to a value greater than 0, then a thread dump will be performed in the given interval in seconds, until the shutdown was succcessful.
restrictions: range: 0 to x
TerminationSystemExitSeconds
type: INT
default: 0
description: If set to a value greater than 0, then a System.exit call will be issued after the given time in seconds, if the shutdown was not successful.
restrictions: range: 0 to x

de.aristaflow.adept2.core.registry.InitialisedInjectedService

CSVLogging
type: BOOLEAN
default: false
description: Specifies if the extensive CSV logging for debugging or performance tuning is to be used. Since this has a serious performance impact, it should not be used in production environments.

de.aristaflow.adept2.core.registry.twophase.TwoPhaseBootstrap

extends de.aristaflow.adept2.core.registry.BootstrapRegistry

de.aristaflow.adept2.core.runtimemanager.commonimplementation.DefaultLocalActivityStateListener

extends de.aristaflow.adept2.core.common.LocalNotificationService

Declared in default configuration as: ActivityStateListener

de.aristaflow.adept2.core.runtimemanager.defaultimplementation.DefaultRuntimeManager

extends de.aristaflow.adept2.base.service.AbstractConfigurableAuthenticatedService

Declared in default configuration as: RuntimeManager

DataDirectory
type: STRING
default: ${arflow:arflow.datadir}
description: The directory where to store the activity terminations that failed to submit to the execution manager. If this is null or the empty string, activity termination calls will not be persisted.
InitialisationTimeout
type: LONG
default: 10000
description: The amount of time in milliseconds to wait until the component has been initialised.
TerminationTimeout
type: LONG
default: 900000
description: The total amount of time in milliseconds to wait until a component reacts after a termination request. If the component does not terminate, the next escalation level will be reached.For instance not responding to a suspend leads to a close, not responding to an abort leads to stopping the threads. The total time is distributed equally among the different supported escalation levels.
ForceRuntimeManagerThreadGroupTerminaton
type: BOOLEAN
default: false
description: Whether to force the termination of the thread group of the runtime manager. This will stop all threads created by any component executor thread that did not explicitly have a different thread group. This is only relevant in case the termination of the component thread group is not forced.
ForceComponentThreadGroupTerminaton
type: BOOLEAN
default: false
description: Whether to force the termination of the thread group after a component executor has finished. This will stop all threads created by the component executor thread.
RemItInitAliveTime
type: LONG
default: 80000
description: The time in milliseconds to keep a remote iterator alive after creating it and without accessing it.
RemItAliveTimeExtension
type: LONG
default: null
description: The time in milliseconds to extend the time a remote iterator will be kept alive after each access. If this is not configured, the initial alive time will be used for extension.
restrictions: range: 0 to x
LibDirectory
type: STRING
default: ${arflow:arflow.libdir}
description: The (global) directory containing the JDBC drivers (actually the directory above a directory 'jdbc4' containing the JDBC drivers).
TerminationPoolSize
type: INT
default: 10
description: The amount of executor threads for terminating all currently running activities.
TerminationNotifierCorePoolSize
type: INT
default: 10
description: The minimum amount of executor threads for notifying registered termination listeners in the activity manager.
TerminationNotifierMaxPoolSize
type: INT
default: 20
description: The maximum amount of executor threads for notifying registered termination listeners in the activity manager.
SignallingPoolSize
type: INT
default: 10
description: The amount of executor threads for internal application signalling.

de.aristaflow.adept2.core.runtimemanager.gui.AbstractGUIManager

extends de.aristaflow.adept2.base.service.AbstractADEPT2Service
TerminationTimeout
type: LONG
default: 900000
description: The total amount of time in milliseconds to wait until a component reacts after a termination request. If the component does not terminate, the next escalation level will be reached.For instance not responding to a suspend leads to a close, not responding to an abort leads to stopping the threads. The total time is distributed equally among the different supported escalation levels.

de.aristaflow.adept2.core.runtimemanager.registry.LoaderLessRegistry

extends de.aristaflow.adept2.core.runtimemanager.registry.RuntimeRegistry

de.aristaflow.adept2.core.runtimemanager.registry.RuntimeRegistry

extends de.aristaflow.adept2.base.service.AbstractAuthenticatedService

Declared in default configuration as: RuntimeRegistry

LogActivityConfigurations
type: BOOLEAN
default: false
description: Whether to log the overriding activity configurations (default: false). They will be logged with FINE.
TestEnv.ImplementationClass *
type: STRING
description: The implementation class for the test execution environment.
TestEnv.ClassPath *
type: STRING
description: The (complete) classpath of the test execution environment as List<String>.
TestEnv.ClassLoaderUsage
type: STRING
default: NON_SHARED
description: The classloader usage of the test execution environment (default: NON_SHARED).
TestEnv.SystemComponent
type: STRING
default: null
description: The system component signature of the test execution environment (default:"").
TestEnv.GUIContextID
type: STRING
default: ""
description: The ID of the GUI context for the test execution environment (default:"").
TestEnv.ExecutionControlProperties
type: STRING
default: false, false, false
description: The execution control properties for the test execution environment (default: false, false, false).
TestEnv.SupportsViewOnly
type: BOOLEAN
default: false
description: Whether the test execution environment supports the view only mode (default: false).
TestEnv.IconID
type: STRING
default: ""
description: The icon for the test execution environment (default:"").
LibDirectory
type: STRING
default: ${arflow:arflow.libdir}
description: The directory providing the libraries for the executable components that are added to the classpath provided by the corresponding activity instance. Note that the libraries per executable component need to be in a subdirectory having the corresponding EC-name. If this property is not set, GlobalProperties.getLibDir() will be used. This will be injected into all activity configurations.
DataDirectory
type: STRING
default: ${arflow:arflow.datadir}
description: The (global) directory in which to store data. This will be injected into all activity configurations.
LogDirectory
type: STRING
default: ${arflow:arflow.logdir}/execComp
description: The log directory in which to store the log files of executable components. Note that the logs will be in subdirectories having the EC-name. Additionally, the log directory will be injected into all activity configurations.
LogFileSize
type: INT
default: 2097152
description: The maximum size for one log file of all executable components of the same EC-name.
LogFileCount
type: INT
default: 2
description: The amount of log files per executable component.
LogLevel
type: STRING
default: WARNING
description: The level for the logs in the executable component logs.
restrictions: oneof: OFF, SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, ALL
LogCSV
type: BOOLEAN
default: false
description: Specifies if the extensive CSV logging for debug purpose is to be used for all executable component logs. Since this has a serious performance impact, it should not be used in production environments.
SharedPackages
type: STRING
default: null
description: The names of the packages that need to be shared (including ther sub-packages) between an execution environment and the AristaFlow system. Such packages are loaded by the AristaFlow classloader. The names need to be separated by comma (List<String>).
ForbiddenClasses
type: STRING
default: null
description: The names of the classes that must not be shared (loaded by the AristaFlow classloader) although their package is shared. The names need to be separated by comma (List<String>).
SharedClasses
type: STRING
default: null
description: The names of the classes that need to be shared between an execution environment and the AristaFlow system. Such classes are loaded by the AristaFlow classloader. The names need to be separated by comma (List<String>).
SharedNativePackages
type: STRING
default: null
description: The names of the packages that need to be shared since the classes in the packages (and their sub-packages) access native libraries. The names need to be separated by comma (List<String>).
SharedNativeClasses
type: STRING
default: null
description: The names of the classes, that need to be shared since they access native libraries. These complement the shared packages. The class names need to be separated by comma (List<String>).
UseOpenClassloader
type: BOOLEAN
default: true
description: Whether to use the open classloader which is sharing most of its classes. It just tries to load classes from its own classpath before delegating to the parent classloader.
Activity[Test]Override.<ECName>$<OpName>$<AName>#.ImplementationClass v
type: STRING
default: null
description: Overrides the implementation class of a specific activity. Depending on the prefix ("ActivityOverride" or "ActivityTestOverride") this applies to normal or test execution.
Activity[Test]Override.<ECName>$<OpName>$<AName>#.ClassPath v
type: STRING
default: null
description: Overrides the classpath of a specific activity. Depending on the prefix ("ActivityOverride" or "ActivityTestOverride") this applies to normal or test execution.
Example:
ActivityOverride.EC\ Name$Op\ Name$Act\ Name#.ClassPath = ${arflow:arflow.libdir}/../../myClassPath1/classes;${arflow:arflow.libdir}/../../myClassPath2/myJarFile.jar
Activity[Test]Override.<ECName>$<OpName>$<AName>#.ClassLoaderUsage v
type: STRING
default: null
description: Overrides the classloader usage of a specific activity. Depending on the prefix ("ActivityOverride" or "ActivityTestOverride") this applies to normal or test execution.
restrictions: oneof: PLATFORM, SHARE_RUNTIME_MANAGER, SHARE_ACTIVITY_INSTANCES, NON_SHARED, SHARE_EXECUTABLE_COMPONENT, SHARE_IMPLEMENTATION_CLASS
Activity[Test]Override.<ECName>$<OpName>$<AName>#.SystemComponent v
type: STRING
default: null
description: Overrides the system component attribute of a specific activity. Since the attribute is a signature, the overriding configuration value is a list of bytes, e. g. "92, 124, 57, -120, 20, 74, 1, -127, 22, 87, 37, 38, 75". Depending on the prefix ("ActivityOverride" or "ActivityTestOverride") this applies to normal or test execution.
Activity[Test]Override.<ECName>$<OpName>$<AName>#.GUIContextID v
type: STRING
default: null
description: Overrides the GUI context ID of a specific activity. Depending on the prefix ("ActivityOverride" or "ActivityTestOverride") this applies to normal or test execution.
Activity[Test]Override.<ECName>$<OpName>$<AName>#.ExecutionControlProperties v
type: STRING
default: null
description: Overrides the execution control properties of a specific activity. This is a list of 3 boolean values, e. g. "true, false, false". The first isfor suspensible, the second for resettable and the third for closable. Depending on the prefix ("ActivityOverride" or "ActivityTestOverride") this applies to normal or test execution.
Activity[Test]Override.<ECName>$<OpName>$<AName>#.SupportsViewOnly v
type: BOOLEAN
default: null
description: Overrides whether a specific activity supports view only mode. Depending on the prefix ("ActivityOverride" or "ActivityTestOverride") this applies to normal or test execution.
Activity[Test]Override.<ECName>$<OpName>$<AName>#.IconID v
type: STRING
default: null
description: Overrides the icon ID of a specific activity. This has to be a valid UUID. Depending on the prefix ("ActivityOverride" or "ActivityTestOverride") this applies to normal or test execution.
Activity[Test]Configuration.$<ECName>{$<OpName>{$<AName>}}#.<ConfEntryName> v
type: STRING
default: null
description: Each configuration entry of the activity can be overridden by entries in the configuration of the runtime registry. Overriding may take place for normal and test ("ActivityConfiguration...") or the test configuration only ("ActivityTestConfiguration..."). The overriding configuration entry may apply to all activities of a specific EC, all activities of a specific operation or a specific activity. This depends on the qualification of the configuration entry, e. g. "...ECName#...", "...ECName$OpName#..." or "...ECName$OpName$AName#...". You need to escape spaces ("\ ") in the EC, operation, activity and configuration entry names.

Configurations of this pattern only apply to activities without a configuration name!

Examples:
ActivityConfiguration.$de.aristaflow.mail.SendMail#.MailFrom = me@testmail.com
sets the sending address of all activities of the EC "de.aristaflow.mail.SendMail" without configuration name to "me@testmail.com".

ActivityConfiguration.$de.aristaflow.mail.SendMail$Send\ Mail$Send\ Mail#.MailFrom = me@testmail.com
sets the sending address only of the activities with the name "Send Mail" of the operation "Send Mail" of the EC "de.aristaflow.mail.SendMail" to "me@testmail.com".

ActivityTestConfiguration.$de.aristaflow.mail.SendMail#.MailFrom = test@testmail.com
sets the sending address of all activities of the EC "de.aristaflow.mail.SendMail" without configuration name for the test execution to "test@testmail.com".
Activity[Test]Configuration.<ConfName>{$<ECName>{$<OpName>{$<AName>}}}#.<ConfKey> v
type: STRING
default: null
description: Each configuration entry of the activity can be overridden by entries in the configuration of the runtime registry. Overriding may take place for normal and test ("ActivityConfiguration...") or the test configuration only ("ActivityTestConfiguration..."). The overriding configuration entry may apply to all activities of with a specific configuration name, a specific EC, all activities of a specific operation or a specific activity. This depends on the qualification of the configuration entry, e. g. "...ConfName#...","...ConfName$ECName#...", "...ConfName$ECName$OpName#..." or "...ConfName$ECName$OpName$AName#...". You need to escape spaces ("\ ") in configuration, EC, operation, activity and configuration entry names.

Configurations of this pattern only apply to activities with the designated configuration name!

Examples:
ActivityConfiguration.Mail#.MailFrom = me@testmail.com
sets the sending address of all activities with configuration name "Mail" to "me@testmail.com".

ActivityConfiguration..Mail$de.aristaflow.mail.SendMail$Send\ Mail$Send\ Mail#.MailFrom = me@testmail.com
sets the sending address only of the activities with the name "Send Mail" of the operation "Send Mail" of the EC "de.aristaflow.mail.SendMail" and the configuration name "Mail" to "me@testmail.com".

ActivityTestConfiguration.Mail#.MailFrom = me@testmail.com
sets the sending address of all activities with configuration name "Mail" for the test execution to "test@testmail.com".

de.aristaflow.adept2.extensions.filerodatasource.defaultimplementation.FileroDataSourceService

extends de.aristaflow.adept2.base.service.AbstractADEPT2Service

Declared in default configuration as: FileroDataSource

Endpoint *
type: STRING
description: The web service endpoint of the FILERO instance to use.
UserName *
type: STRING
description: The default user name with which to access FILERO. This is used when no user is provided when retrieving the FileroConnection.
Password *
type: STRING
description: The encrypted password for the default user with which to access FILERO when no user is provided when retrieving the FileroConnection.
ConnectionTimeout
type: INT
default: -2147483648
description: The time in seconds to wait for the connection to FILERO to be established.
RequestTimeout
type: INT
default: -2147483648
description: The time in seconds to wait for a reply from FILERO to a request.
SkipCertificateValidation
type: BOOLEAN
default: false
description: Whether to skip the SSL certificate validation, that is, the host certificate of the HTTPS connection to the FILERO server may be invalid (with respect to the system certificates). When not skipped (the default), verification requires the certificate or one of the certificate chain to be accepted by the system.
SkipHostNameVerification
type: BOOLEAN
default: false
description: Whether to skip the host name verification, that is, the actual host name of the HTTPS connection to the FILERO server does not need to match the host name of the corresponding SSL certificate.
MaxConnectionsPerUser
type: INT
default: 12
description: The maximum amount of connections allowed per user. This is a (licence) restriction of the FILERO server.
LoggedWebServiceOperations
type: STRING
default: null
description: A list of all FILERO web service operations to be logged. If this is not configured, all operations will be logged. If the configuration value is empty, no operation will be logged.

de.aristaflow.adept2.extensions.odoodatasource.defaultimplementation.OdooDataSourceService

extends de.aristaflow.adept2.base.service.AbstractADEPT2Service

Declared in default configuration as: OdooDataSource

URL *
type: STRING
description: The XML-RPC URL of the Odoo server.
Database *
type: STRING
description: The Odoo database name.
UserName *
type: STRING
description: The user with which to access Odoo.
Password *
type: STRING
description: The encrypted password for the user with which to access Odoo.
ConnReqTimeout
type: INT
default: -2147483648
description: The time in seconds to wait for the connection to Odoo to be established and to wait for a reply. The default is the system default of HttpURLConnection.
SkipCertificateValidation
type: BOOLEAN
default: false
description: Whether to skip the SSL certificate validation, that is, the host certificate of the HTTPS connection to the Odoo server may be invalid (with respect to the system certificates). When not skipped (the default), verification requires the certificate or one of the certificate chain to be accepted by the system.
SkipHostNameVerification
type: BOOLEAN
default: false
description: Whether to skip the host name verification, that is, the actual host name of the HTTPS connection to the Odoo server does not need to match the host name of the corresponding SSL certificate.
ValidationPeriod
type: INT
default: 900
description: The time in seconds for re-checking the validity of a connection before returning it. Connectios requested within this period since the last validation will not be validated (again).
restrictions: range: 0 to x

de.aristaflow.adept2.extensions.sqlsupport.eventhandler.DBEventActivityHandler

Declared in default configuration as: DBActHandler

IsCritical
type: BOOLEAN
default: true
description: Whether the event handler is critical and problems handling the event should abort all handling of the current event.
IsConsuming
type: BOOLEAN
default: false
description: Whether the event handler is is consuming and therefore additional handlers may not consume it again. Usually an activity handler does not consume.
ColumnIndex v
type: LONG
default: ""
description: This is a configuration value at an output parameter of the corresponding activity. This zero-based index refers to the column in the result set of which to store the value in the corresponding output parameter.
ColumnName v
type: STRING
default: ""
description: This is a configuration value at an output parameter of the corresponding activity. The name refers to the column in the result set of which to store the value in the corresponding output parameter.

de.aristaflow.adept2.extensions.sqlsupport.eventhandler.InstanceStartEventHandler

Declared in default configuration as: DBInstHandler

IsCritical
type: BOOLEAN
default: true
description: Whether the event handler is critical and problems handling the event should abort all handling of the current event.
ProcessType *
type: STRING
description: The process tye of which to start the "latest" template as soon as the event occurs.
IgnoreInputParameter
type: BOOLEAN
default: true
description: Whether the input parameters of the template to be started should be ignored. This will only work if either the template does not have any input parameters or only optional input parameters.
<ProcessTypeName>.InputParameter.<InputParameterName>. ColumnName v
type: STRING
default: ""
description: This specifies the name of the column of the corresponding result set of which to store the value in the corresponding input parameter of the (latest template of the) designated process type. Obviously there can be several of these configuration entries.
MarkHandledRows *
type: STRING
description: Determines if and how handled rows are marked as such. A new row can be inserted, columns of the row can be updated or the row can be deleted.
restrictions: oneof/i: None, Insert, Update, Delete
InsertRow.Table v
type: STRING
default: ""
description: The name of the table in which to insert a new row to indicate the handling of the event (caused by another row). This is always required.
InsertRow.<ColumName> v
type: STRING
default: ""
description: The name of the column for which to insert a new row in the appropriate table. The value of this configuration entry will be stored in this column in the new row. Obviously there can be several of these configuration entries.
UpdateRow.Table v
type: STRING
default: ""
description: The name of the table in which to update a row to indicate the handling of the event (caused by another row). This will only be required if the updated row is in a different table. The row causing the event can be updated without specifying the table name.
UpdateRow.<ColumName> v
type: STRING
default: ""
description: The name of the column in the result set which to update. The value of this configuration entry will be stored in this column. Obviously there can be several of these configuration entries.

de.aristaflow.adept2.extensions.sqlsupport.eventsource.sharing.SharingDBActEventSource

Declared in default configuration as: SharingDBActSource

MaxStatementLength
type: INT
default: 2000000
description: The maximum length of a statement created for this sharing event source.
MaxParameterCount
type: INT
default: 2000
description: The maximum amount of parameters in a prepared statement created for this sharing event source.
MaxInOperatorParameterCount
type: INT
default: 1000
description: The maximum amount of parameters directly in an IN-part in a prepared statement created for this sharing event source.

de.aristaflow.adept2.model.ModelFactoryRegistry

extends de.aristaflow.adept2.base.registry.InstanceToInstanceRegistry

Declared in default configuration as: ModelFactoryRegistry

Components.ProcessModelFactory *
type: STRING
description: the process model factory
Components.ActivityModelFactory *
type: STRING
description: the activity model factory
Components.ExecutionFactory *
type: STRING
description: The factory for execution model.
Components.FilterFactory *
type: STRING
description: The factory for filters on the models.
Components.GraphicalModelFactory *
type: STRING
description: The factory for elements of the graphical model like images.
Components.InitTabFactory *
type: STRING
description: The factory for elements of the init tab manager.
Components.ResourceModelFactory *
type: STRING
description: The resource model factory
Components.LocalisationFactory *
type: STRING
description: The factory for creating localised views on model elements.
Components.SystemDataFormatterFactory *
type: STRING
description: The factory for formatters of system data used in string attributes in model elements.
Components.WorklistModelFactory *
type: STRING
description: the worklist model factory
PluginData.Instances
type: STRING
default: ""
description: A comma-separated list of instance names for model viewer implementations, these are interfaces or classes using annotations de.aristaflow.adept2.model.common.viewer which allow to create proxy instancestransparently providing type-safe access to plugin data.

de.aristaflow.adept2.model.common.defaultimplementation.DefaultLocalisationFactory

CacheSize
type: INT
default: 20
description: The size of the cache to provide all interfaces of a specific class. This avoids redundant class hierarchy iterations. Use 0 or a negative value todisable caching.

de.aristaflow.adept2.model.events.sources.FilteredMailSource

FromFilter
type: STRING
default: null
description: Regular expression used on the mail addresses of the sender for filtering messages.
ToFilter
type: STRING
default: null
description: Regular expression used on the mail addresses of the recepients for filtering messages.
SubjectFilter
type: STRING
default: null
description: Regular expression used on the email subject for filtering messages.
BodyFilter
type: STRING
default: null
description: Regular expression used on the email body for filtering messages.
FlagAnsweredFilter
type: BOOLEAN
default: null
description: Whether only mails with the answered flag set to the configured value should cause an event.
FlagDeletedFilter
type: BOOLEAN
default: null
description: Whether only mails with the deleted flag set to the configured value should cause an event.
FlagDraftFilter
type: BOOLEAN
default: null
description: Whether only mails with the draft flag set to the configured value should cause an event.
FlagFlaggedFilter
type: BOOLEAN
default: null
description: Whether only mails with the flagged flag set to the configured value should cause an event.
FlagRecentFilter
type: BOOLEAN
default: null
description: Whether only mails with the recent flag set to the configured value should cause an event.
FlagSeenFilter
type: BOOLEAN
default: null
description: Whether only mails with the seen flag set to the configured value should cause an event.
FlagUserFilter
type: BOOLEAN
default: null
description: Whether only mails with the user flag set to the configured value should cause an event.

de.aristaflow.adept2.model.events.sources.MailSource

Protocol
type: STRING
default: ""
description: The protocol to use for this mail events, for instance pop3, imap, ...
Host
type: STRING
default: null
description: The host to connect to and from which to use as mail source.
Port
type: INT
default: -1
description: The port of the host to which to connect to.
Timeout
type: INT
default: 0
description: The timeout in milliseconds which to use for the connection. If the host does not respond before this time elapses, the current poll iteration is aborted but polling will continue.
UserName
type: STRING
default: null
description: The user name to connect to the host with.
Password
type: STRING
default: null
description: The password to connect to the host with.
Folder
type: STRING
default: INBOX
description: The name of the folder which causes an event when a new mail is received. If not specified the usual INBOX will be used.

de.aristaflow.adept2.model.events.sources.MemoryResultSetSource

Driver
type: STRING
default: null
description: The driver (class) name for the JDBC connection to use for the event source.
ConnectionURL
type: STRING
default: null
description: The URL for the JDBC connection to use for the event source. Provide the complete URL.
UserName
type: STRING
default: ""
description: The user name for the JDBC connection to use for the event source.
Password
type: STRING
default: null
description: The password of the user for the JDBC connection to use for the event source.
JDBCDataSource
type: STRING
default: null
description: The simple instance name of the JDBC data source. This will take precedence over the JDBC connection data. Make sure that the SELECT statement is suitable for the data source. If neither a data source nor a JDBC connect string is provdided, the default data source for the corresponding service will be used.
SelectStatement
type: STRING
default: null
description: The SELECT statement (may be complex) to execute against the database. This leads to the result set provided by this event.
MaxResults
type: INT
default: 1
description: How many results (rows) this source should add to the MemoryResultSet.

de.aristaflow.adept2.model.events.sources.PollingFileSource

SearchDirectoryPath
type: STRING
default: ""
description: The path of the directory which causes an event when a new file is inserted.
FilenameFilter
type: STRING
default: null
description: The regex to filter the filenames with.
SkipDirectories
type: STRING
default: false
description: Whether directories should be skipped. Do not use this together with 'SkipFiles'!
SkipFiles
type: STRING
default: false
description: Whether files should be skipped. Do not use this together with 'SkipDirectories'!
SkipLocked
type: STRING
default: false
description: Whether locked files should be skipped.
LockSuffix
type: STRING
default: .aflck
description: The suffix that is used to recognise lock files. This has to correspond to the file name for lock files configured for the event handler that marks files.
LockFileEvent
type: STRING
default: false
description: Whether a lock file event should occur, i.e. the lock file should be part of the event.
IsLockFile
type: STRING
default: false
description: Whether the event occurs due to a lock file or due to the data file itself.

de.aristaflow.adept2.model.events.sources.PollingMailSource

KeepConnection
type: BOOLEAN
default: false
description: Whether the mail storage should not be disconnected between polls.

de.aristaflow.adept2.model.events.sources.PollingSource

PollTime
type: LONG
default: 300000
description: The time in milliseconds this event source polls. This is a time span between two polls. If handling the previous event takes longer than this time span, the next poll will take place right after the handling has completed.
StartPoint
type: LONG
default: -1
description: The absolute time in milliseconds since midnight, January 1, 1970 UTC when the event should start polling regularly. Together with the poll time this defines the actual start time of polling. It starts when the time span elapses next time calculated from the fixed point. Use a time in the past, otherwise polling will really start at the specified time.

de.aristaflow.adept2.model.events.sources.ResultSetSource

Driver
type: STRING
default: null
description: The driver (class) name for the JDBC connection to use for the event source.
ConnectionURL
type: STRING
default: null
description: The URL for the JDBC connection to use for the event source. Provide the complete URL.
UserName
type: STRING
default: ""
description: The user name for the JDBC connection to use for the event source.
Password
type: STRING
default: null
description: The password of the user for the JDBC connection to use for the event source.
JDBCDataSource
type: STRING
default: null
description: The simple instance name of the JDBC data source. This will take precedence over the JDBC connection data. Make sure that the SELECT statement is suitable for the data source. If neither a data source nor a JDBC connect string is provdided, the default data source for the corresponding service will be used.
SelectStatement
type: STRING
default: null
description: The SELECT statement (may be complex) to execute against the database. This leads to the result set provided by this event.
NotifyEmptyOnly
type: BOOLEAN
default: false
description: Whether the event should be triggered when the result set is empty. Otherwise the event will be triggered as soon as the result yields at least one row.

de.aristaflow.adept2.model.events.sources.SharingSource

PollTime
type: LONG
default: 300000
description: The time in milliseconds this event source polls. If handling the previous event takes longer than this, the next poll will take place right after the handling has completed.

de.aristaflow.adept2.ui.guimanager.NullGUIManager

extends de.aristaflow.adept2.core.runtimemanager.gui.AbstractGUIManager

Declared in default configuration as: GUIManager

de.aristaflow.adept2.ui.guimanager.RemoteHTMLGUIManager

extends de.aristaflow.adept2.core.runtimemanager.gui.AbstractGUIManager

de.aristaflow.adept2.ui.htmlgui.httpservice.EmbdServContHTTPService

extends de.aristaflow.adept2.base.service.AbstractAuthenticatedService

de.aristaflow.adept2.ui.htmlgui.httpservice.NullHTTPService

extends de.aristaflow.adept2.base.service.AbstractADEPT2Service

Declared in default configuration as: HTTPService