blob: 883ed01c78cef6cf241351bbb4eda3a12e412068 [file] [log] [blame]
// spring-boot-auto-configure options: START
:page-partial:
:doctitle: Camel Spring Boot Starter for nagios
== Spring Boot Auto-Configuration
When using nagios with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-nagios-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
----
The component supports 8 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *camel.component.nagios.autowired-enabled* | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | Boolean
| *camel.component.nagios.configuration* | To use a shared NagiosConfiguration. The option is a org.apache.camel.component.nagios.NagiosConfiguration type. | | NagiosConfiguration
| *camel.component.nagios.connection-timeout* | Connection timeout in millis. | 5000 | Integer
| *camel.component.nagios.enabled* | Whether to enable auto configuration of the nagios component. This is enabled by default. | | Boolean
| *camel.component.nagios.encryption* | To specify an encryption method. | | Encryption
| *camel.component.nagios.lazy-start-producer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | Boolean
| *camel.component.nagios.password* | Password to be authenticated when sending checks to Nagios. | | String
| *camel.component.nagios.timeout* | Sending timeout in millis. | 5000 | Integer
|===
// spring-boot-auto-configure options: END