Configuration
CleverBus contains two configuration files:
- applicationCore.cfg - file placed in core module, contains basic configuration parameters
- application.cfg - file placed in web-admin module, contains web and project specific parameters
Common recommendations for configuration:
- set email addresses of administrators (admin.mail) because CleverBus sends notifications to these addresses, for example when
- message processing failed
- if message waits for response from external system for more then defined interval
- set username and password to access (web) services - parameters ws.user a ws.password in application.cfg
- path to log folder (log.folder.path in application.cfg)
| Parameter | Default value | Description |
|---|---|---|
| asynch.countPartlyFailsBeforeFailed | 3 | Count of unsuccessful tries of message processing before message will be marked as completely FAILED Time interval between tries is defined by asynch.partlyFailedInterval. |
| asynch.repairRepeatTime | 300 | Max. interval in seconds how long can be message being processed, in other words how long can be in PROCESSING state. If message is still in processing then repair process (org.cleverbus.core.common.asynch.repair.RepairProcessingMsgRoute) will be started and the message state will be changed to PARTLY_FAILED. This parameter is not only for messages themselves but also for external calls and confirmations. |
| asynch.concurrentConsumers | 30 | Input asynchronous messages are waiting for processing in the priority queue. This parameter determines how many concurrent consumers (=threads) can take message from the queue and start processing. In other words this parameter detemines how many concurrent messages can be processed. For more informacetion see http://camel.apache.org/seda.html, parameter concurrentConsumers |
| asynch.partlyFailedRepeatTime | 60 | How often to run process (org.cleverbus.core.common.asynch.queue.PartlyFailedMessagesPoolRoute) for pooling PARTLY_FAILED messages (in seconds). This parameter is relevant to asynch.partlyFailedInterval. |
| asynch.partlyFailedInterval | 60 | Interval (in seconds) between two tries of PARTLY_FAILED messages. When this interval expires then can be message be processed again. This parameter is relevant to asynch.partlyFailedRepeatTime. |
| asynch.confirmation.failedLimit | 3 | Maximum count of confirmation fails when will finish further processing of confirmation, confirmation fails. |
| asynch.partlyFailedRepeatTime | 60 | How often to run process (org.cleverbus.core.common.asynch.confirm.ConfirmationsPoolRoute) for pooling failed confirmations (in seconds) This parameter is relevant to asynch.confirmation.interval . |
| asynch.confirmation.interval | 60 | Interval (in seconds) between two tries of failed confirmations. This parameter is relevant to asynch.confirmation.repeatTime . |
| asynch.waitForResponse.timeout | 3600 | Parameter was removed in version 0.4 because new similar functionality was added - Alerts. |
| asynch.externalCall.skipUriPattern | Regular expression that defines URIs which will be ignored by extcall component. Useful when you want to skip communication with an external system. | |
| asynch.postponedInterval | 5 | Interval (in seconds) after that can be postponed message processed again. |
| asynch.postponedIntervalWhenFailed | 300 | Interval (in seconds) after that postponed messages will fail. See Guaranteed message processing order functionality for more details. Since version 0.4 |
| Parameter | Default value | Description |
|---|---|---|
| mail.admin | Administrator email(s) If more emails, then separated them with semicolon if empty then email won't be sent. |
|
| mail.from | CleverBus integration platform | Email address FROM for sending emails |
| mail.smtp.server | localhost | SMTP server for sending emails |
| dir.temp | Directory for storing temporary files, related to DefaultFileRepository | |
| dir.fileRepository | File repository directory where files will be stored, related to DefaultFileRepository | |
| contextCall.localhostUri | http://localhost:8080 | URI of this localhost application, including port number. Related to external call in Admin GUI |
| disable.throttling | false | True for disabling throttling at all. See throttling component. |
| endpoints.includePattern | ^(spring-ws|servlet).*$ | Pattern for filtering endpoints URI - only whose URIs will match specified pattern will be returned, related to endpoints overview. |
| requestSaving.enable | false | True for enabling saving requests/responses for filtered endpoints URI. |
| requestSaving.endpointFilter | ^(spring-ws|servlet).*$ | Pattern for filtering endpoints URI which requests/response should be saved. |
| alerts.repeatTime | 300 | How often to run checking of alerts (in seconds) This parameter is enabled from 0.4 version. |
| Parameter | Default value | Description |
|---|---|---|
| db.driver | org.h2.Driver | Driver class name |
| db.url | jdbc:h2:mem:cleverBusDB | Database URL |
| db.username | sa | Database username |
| db.password | Database password | |
| ws.user | wsUser | Username for accessing web services (Spring security configuration in rootSecurity.xml). |
| ws.password | wsPassword | Password for accessing web services (Spring security configuration in rootSecurity.xml). |
| web.user | webUser | Username for accessing web admin (Spring security configuration in rootSecurity.xml). |
| web.password | webPassword | Password for accessing web admin (Spring security configuration in rootSecurity.xml). |
| monitoring.user | monUser | Username for accessing JavaMelody tool (Spring security configuration in rootSecurity.xml). |
| monitoring.password | monPassword | Password for accessing JavaMelody tool (Spring security configuration in rootSecurity.xml). |
| log.folder.path | ${log.folder}, value is from Maven profile | Path to folder with application logs, used in logs searching in admin GUI. |
| log.file.pattern | |
Defines format of log file names (include filter) which will be taking into logs searching in admin GUI. Since version 0.4 |
There is the following configuration files hierarchy that determines processing order:
applicationCore.cfg -> application.cfg -> application0.cfg
In other words parameters defined in last file (application0.cfg) have higher priority then those defined in applicationCore.cfg (where there are default values).
Throttling functionality is implemented by throttling component where you can find configuration description.
Alerts have own configuration files.
Since version 0.2
If there are many Spring beans with route definitions then startup time for loading ESB application can be quite long. This functionality enables to include only those Spring beans which should be initialized or exclude those Spring beans which we don't want to initialize.
It can be handy during development because it's possible via system properties to restrict set of Spring beans (=Camel routes) which will be initialized.
There are two handy classes for these purposes: org.cleverbus.common.spring.SystemIncludeRegexPatternTypeFilter and org.cleverbus.common.spring.SystemExcludeRegexPatternTypeFilter
Both type filters are handled by system or environment property. springIncludePattern for SystemIncludeRegexPatternTypeFilter class, springExcludePattern for SystemExcludeRegexPatternTypeFilter class. System property has higher priority.
Example of system property definition for exclude filter (excludes all Spring beans under org.cleverbusu.modules package and sub-packages):
-DspringExcludePattern=org\.cleverbus\.modules\..*
Example of Spring configuration with custom type filters:
<context:component-scan base-package="org.cleverbus.core, org.cleverbus.admin.routes, org.cleverbus.modules" use-default-filters="false">
<context:include-filter type="custom" expression="org.cleverbus.common.spring.SystemIncludeRegexPatternTypeFilter"/>
<context:exclude-filter type="custom" expression="org.cleverbus.common.spring.SystemExcludeRegexPatternTypeFilter"/>
</context:component-scan>Include filters are applied after exclude filters.
Since version 0.4
Configuration checker (org.cleverbus.core.conf.ConfigurationChecker) enables to check selected configuration parameters during application start:
- directCall.localhostUri - checks URI availability (must be explicitly enabled)
- endpoints.includePattern, requestSaving.endpointFilter - checks regular expressions
You can implement your own checking functionality by org.cleverbus.core.conf.ConfCheck (since version 1.1).
