Interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
SnmpEndpointBuilderFactory.SnmpEndpointBuilder
- Enclosing interface:
SnmpEndpointBuilderFactory
public static interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the SNMP component.
-
Method Summary
Modifier and TypeMethodDescriptionadvanced()
authenticationPassphrase
(String authenticationPassphrase) The authentication passphrase.authenticationProtocol
(String authenticationProtocol) Authentication protocol to use if security level is set to enable authentication The possible values are: MD5, SHA1.backoffErrorThreshold
(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffErrorThreshold
(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffMultiplier
(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.backoffMultiplier
(String backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.delay
(long delay) Sets update rate in seconds.Sets update rate in seconds.greedy
(boolean greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.initialDelay
(long initialDelay) Milliseconds before the first poll starts.initialDelay
(String initialDelay) Milliseconds before the first poll starts.Defines which values you are interested in.oids
(org.apache.camel.component.snmp.OIDList oids) Defines which values you are interested in.privacyPassphrase
(String privacyPassphrase) The privacy passphrase.privacyProtocol
(String privacyProtocol) The privacy protocol ID to be associated with this user.Here you can select which protocol to use.repeatCount
(long repeatCount) Specifies a maximum limit of number of fires.repeatCount
(String repeatCount) Specifies a maximum limit of number of fires.retries
(int retries) Defines how often a retry is made before canceling the request.Defines how often a retry is made before canceling the request.runLoggingLevel
(String runLoggingLevel) The consumer logs a start/complete log line when it polls.runLoggingLevel
(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.scheduledExecutorService
(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.scheduledExecutorService
(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.To use a cron scheduler from either camel-spring or camel-quartz component.To use a cron scheduler from either camel-spring or camel-quartz component.schedulerProperties
(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.schedulerProperties
(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.securityLevel
(int securityLevel) Sets the security level for this target.securityLevel
(String securityLevel) Sets the security level for this target.securityName
(String securityName) Sets the security name to be used with this target.sendEmptyMessageWhenIdle
(boolean sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.sendEmptyMessageWhenIdle
(String sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.snmpCommunity
(String snmpCommunity) Sets the community octet string for the snmp request.snmpContextEngineId
(String snmpContextEngineId) Sets the context engine ID field of the scoped PDU.snmpContextName
(String snmpContextName) Sets the context name field of this scoped PDU.snmpVersion
(int snmpVersion) Sets the snmp version for the request.snmpVersion
(String snmpVersion) Sets the snmp version for the request.startScheduler
(boolean startScheduler) Whether the scheduler should be auto started.startScheduler
(String startScheduler) Whether the scheduler should be auto started.timeout
(int timeout) Sets the timeout value for the request in millis.Sets the timeout value for the request in millis.Time unit for initialDelay and delay options.Time unit for initialDelay and delay options.treeList
(boolean treeList) Sets the flag whether the scoped PDU will be displayed as the list if it has child elements in its tree.Sets the flag whether the scoped PDU will be displayed as the list if it has child elements in its tree.Which operation to perform such as poll, trap, etc.type
(org.apache.camel.component.snmp.SnmpActionType type) Which operation to perform such as poll, trap, etc.useFixedDelay
(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.useFixedDelay
(String useFixedDelay) Controls if fixed delay or fixed rate is used.Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
-
Method Details
-
advanced
-
oids
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder oids(org.apache.camel.component.snmp.OIDList oids) Defines which values you are interested in. Please have a look at the Wikipedia to get a better understanding. You may provide a single OID or a coma separated list of OIDs. Example: oids=1.3.6.1.2.1.1.3.0,1.3.6.1.2.1.25.3.2.1.5.1,1.3.6.1.2.1.25.3.5.1.1.1,1.3.6.1.2.1.43.5.1.1.11.1. The option is a: <code>org.apache.camel.component.snmp.OIDList</code> type. Group: common- Parameters:
oids
- the value to set- Returns:
- the dsl builder
-
oids
Defines which values you are interested in. Please have a look at the Wikipedia to get a better understanding. You may provide a single OID or a coma separated list of OIDs. Example: oids=1.3.6.1.2.1.1.3.0,1.3.6.1.2.1.25.3.2.1.5.1,1.3.6.1.2.1.25.3.5.1.1.1,1.3.6.1.2.1.43.5.1.1.11.1. The option will be converted to a <code>org.apache.camel.component.snmp.OIDList</code> type. Group: common- Parameters:
oids
- the value to set- Returns:
- the dsl builder
-
protocol
Here you can select which protocol to use. You can use either udp or tcp. The option is a: <code>java.lang.String</code> type. Default: udp Group: common- Parameters:
protocol
- the value to set- Returns:
- the dsl builder
-
retries
Defines how often a retry is made before canceling the request. The option is a: <code>int</code> type. Default: 2 Group: common- Parameters:
retries
- the value to set- Returns:
- the dsl builder
-
retries
Defines how often a retry is made before canceling the request. The option will be converted to a <code>int</code> type. Default: 2 Group: common- Parameters:
retries
- the value to set- Returns:
- the dsl builder
-
snmpCommunity
Sets the community octet string for the snmp request. The option is a: <code>java.lang.String</code> type. Default: public Group: common- Parameters:
snmpCommunity
- the value to set- Returns:
- the dsl builder
-
snmpContextEngineId
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder snmpContextEngineId(String snmpContextEngineId) Sets the context engine ID field of the scoped PDU. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
snmpContextEngineId
- the value to set- Returns:
- the dsl builder
-
snmpContextName
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder snmpContextName(String snmpContextName) Sets the context name field of this scoped PDU. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
snmpContextName
- the value to set- Returns:
- the dsl builder
-
snmpVersion
Sets the snmp version for the request. The value 0 means SNMPv1, 1 means SNMPv2c, and the value 3 means SNMPv3. The option is a: <code>int</code> type. Default: 0 Group: common- Parameters:
snmpVersion
- the value to set- Returns:
- the dsl builder
-
snmpVersion
Sets the snmp version for the request. The value 0 means SNMPv1, 1 means SNMPv2c, and the value 3 means SNMPv3. The option will be converted to a <code>int</code> type. Default: 0 Group: common- Parameters:
snmpVersion
- the value to set- Returns:
- the dsl builder
-
timeout
Sets the timeout value for the request in millis. The option is a: <code>int</code> type. Default: 1500 Group: common- Parameters:
timeout
- the value to set- Returns:
- the dsl builder
-
timeout
Sets the timeout value for the request in millis. The option will be converted to a <code>int</code> type. Default: 1500 Group: common- Parameters:
timeout
- the value to set- Returns:
- the dsl builder
-
type
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder type(org.apache.camel.component.snmp.SnmpActionType type) Which operation to perform such as poll, trap, etc. The option is a: <code>org.apache.camel.component.snmp.SnmpActionType</code> type. Group: common- Parameters:
type
- the value to set- Returns:
- the dsl builder
-
type
Which operation to perform such as poll, trap, etc. The option will be converted to a <code>org.apache.camel.component.snmp.SnmpActionType</code> type. Group: common- Parameters:
type
- the value to set- Returns:
- the dsl builder
-
delay
Sets update rate in seconds. The option is a: <code>long</code> type. Default: 60000 Group: consumer- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
delay
Sets update rate in seconds. The option will be converted to a <code>long</code> type. Default: 60000 Group: consumer- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
treeList
Sets the flag whether the scoped PDU will be displayed as the list if it has child elements in its tree. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
treeList
- the value to set- Returns:
- the dsl builder
-
treeList
Sets the flag whether the scoped PDU will be displayed as the list if it has child elements in its tree. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
treeList
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
backoffIdleThreshold
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
backoffIdleThreshold
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
backoffMultiplier
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder backoffMultiplier(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
backoffMultiplier
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder backoffMultiplier(String backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
greedy
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: <code>boolean</code> type. Default: false Group: scheduler- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
greedy
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a <code>boolean</code> type. Default: false Group: scheduler- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
initialDelay
Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
initialDelay
Milliseconds before the first poll starts. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduler- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
repeatCount
Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: <code>long</code> type. Default: 0 Group: scheduler- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
repeatCount
Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a <code>long</code> type. Default: 0 Group: scheduler- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
runLoggingLevel
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
runLoggingLevel
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder runLoggingLevel(String runLoggingLevel) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
scheduledExecutorService
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
scheduledExecutorService
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder scheduledExecutorService(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
scheduler
To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: <code>java.lang.Object</code> type. Default: none Group: scheduler- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
scheduler
To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a <code>java.lang.Object</code> type. Default: none Group: scheduler- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
schedulerProperties
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder schedulerProperties(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler- Parameters:
key
- the option keyvalue
- the option value- Returns:
- the dsl builder
-
schedulerProperties
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler- Parameters:
values
- the values- Returns:
- the dsl builder
-
startScheduler
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder startScheduler(boolean startScheduler) Whether the scheduler should be auto started. The option is a: <code>boolean</code> type. Default: true Group: scheduler- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
startScheduler
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder startScheduler(String startScheduler) Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
timeUnit
Time unit for initialDelay and delay options. The option is a: <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
timeUnit
Time unit for initialDelay and delay options. The option will be converted to a <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
useFixedDelay
Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: <code>boolean</code> type. Default: true Group: scheduler- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-
useFixedDelay
Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-
authenticationPassphrase
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder authenticationPassphrase(String authenticationPassphrase) The authentication passphrase. If not null, authenticationProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
authenticationPassphrase
- the value to set- Returns:
- the dsl builder
-
authenticationProtocol
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder authenticationProtocol(String authenticationProtocol) Authentication protocol to use if security level is set to enable authentication The possible values are: MD5, SHA1. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
authenticationProtocol
- the value to set- Returns:
- the dsl builder
-
privacyPassphrase
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder privacyPassphrase(String privacyPassphrase) The privacy passphrase. If not null, privacyProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
privacyPassphrase
- the value to set- Returns:
- the dsl builder
-
privacyProtocol
default SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder privacyProtocol(String privacyProtocol) The privacy protocol ID to be associated with this user. If set to null, this user only supports unencrypted messages. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
privacyProtocol
- the value to set- Returns:
- the dsl builder
-
securityLevel
Sets the security level for this target. The supplied security level must be supported by the security model dependent information associated with the security name set for this target. The value 1 means: No authentication and no encryption. Anyone can create and read messages with this security level The value 2 means: Authentication and no encryption. Only the one with the right authentication key can create messages with this security level, but anyone can read the contents of the message. The value 3 means: Authentication and encryption. Only the one with the right authentication key can create messages with this security level, and only the one with the right encryption/decryption key can read the contents of the message. The option is a: <code>int</code> type. Default: 3 Group: security- Parameters:
securityLevel
- the value to set- Returns:
- the dsl builder
-
securityLevel
Sets the security level for this target. The supplied security level must be supported by the security model dependent information associated with the security name set for this target. The value 1 means: No authentication and no encryption. Anyone can create and read messages with this security level The value 2 means: Authentication and no encryption. Only the one with the right authentication key can create messages with this security level, but anyone can read the contents of the message. The value 3 means: Authentication and encryption. Only the one with the right authentication key can create messages with this security level, and only the one with the right encryption/decryption key can read the contents of the message. The option will be converted to a <code>int</code> type. Default: 3 Group: security- Parameters:
securityLevel
- the value to set- Returns:
- the dsl builder
-
securityName
Sets the security name to be used with this target. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
securityName
- the value to set- Returns:
- the dsl builder
-