Interface SnmpEndpointBuilderFactory.SnmpEndpointBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
,SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
,SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- Enclosing interface:
- SnmpEndpointBuilderFactory
public static interface SnmpEndpointBuilderFactory.SnmpEndpointBuilder
extends SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder, SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
Builder for endpoint 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.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.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.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.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.timeout
(int timeout) Sets the timeout value for the request in millis.Sets the timeout value for the request in millis.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.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
Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, delay, delay, greedy, greedy, initialDelay, initialDelay, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, startScheduler, startScheduler, timeUnit, timeUnit, treeList, treeList, useFixedDelay, useFixedDelay
-
Method Details
-
advanced
- Specified by:
advanced
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
advanced
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
-
oids
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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- Specified by:
oids
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
oids
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- 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- Specified by:
oids
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
oids
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- 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- Specified by:
protocol
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
protocol
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- 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- Specified by:
retries
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
retries
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- 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- Specified by:
retries
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
retries
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- 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- Specified by:
snmpCommunity
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
snmpCommunity
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- Parameters:
snmpCommunity
- the value to set- Returns:
- the dsl builder
-
snmpContextEngineId
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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- Specified by:
snmpContextEngineId
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
snmpContextEngineId
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- Parameters:
snmpContextEngineId
- the value to set- Returns:
- the dsl builder
-
snmpContextName
Sets the context name field of this scoped PDU. The option is a: <code>java.lang.String</code> type. Group: common- Specified by:
snmpContextName
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
snmpContextName
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- 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- Specified by:
snmpVersion
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
snmpVersion
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- 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- Specified by:
snmpVersion
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
snmpVersion
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- 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- Specified by:
timeout
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
timeout
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- 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- Specified by:
timeout
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
timeout
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- Parameters:
timeout
- the value to set- Returns:
- the dsl builder
-
type
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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- Specified by:
type
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
type
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- 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- Specified by:
type
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
type
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- Parameters:
type
- the value to set- Returns:
- the dsl builder
-
authenticationPassphrase
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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- Specified by:
authenticationPassphrase
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
authenticationPassphrase
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- Parameters:
authenticationPassphrase
- the value to set- Returns:
- the dsl builder
-
authenticationProtocol
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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- Specified by:
authenticationProtocol
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
authenticationProtocol
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- Parameters:
authenticationProtocol
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
privacyPassphrase
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
privacyPassphrase
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- Parameters:
privacyPassphrase
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
privacyProtocol
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
privacyProtocol
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- 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- Specified by:
securityLevel
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
securityLevel
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- 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- Specified by:
securityLevel
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
securityLevel
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- 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- Specified by:
securityName
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
- Specified by:
securityName
in interfaceSnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
- Parameters:
securityName
- the value to set- Returns:
- the dsl builder
-