SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

SnmpEndpointBuilderFactory.SnmpEndpointBuilder

Enclosing interface:

SnmpEndpointBuilderFactory
```
public static interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
```
Builder for endpoint producers for the SNMP component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default SnmpEndpointBuilderFactory.AdvancedSnmpEndpointProducerBuilder`	`advanced()`
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`authenticationPassphrase(String authenticationPassphrase)` The authentication passphrase.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`authenticationProtocol(String authenticationProtocol)` Authentication protocol to use if security level is set to enable authentication The possible values are: MD5, SHA1.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`lazyStartProducer(String lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`oids(Object oids)` Defines which values you are interested in.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`oids(String oids)` Defines which values you are interested in.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`privacyPassphrase(String privacyPassphrase)` The privacy passphrase.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`privacyProtocol(String privacyProtocol)` The privacy protocol ID to be associated with this user.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`protocol(String protocol)` Here you can select which protocol to use.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`retries(int retries)` Defines how often a retry is made before canceling the request.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`retries(String retries)` Defines how often a retry is made before canceling the request.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`securityLevel(int securityLevel)` Sets the security level for this target.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`securityLevel(String securityLevel)` Sets the security level for this target.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`securityName(String securityName)` Sets the security name to be used with this target.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`snmpCommunity(String snmpCommunity)` Sets the community octet string for the snmp request.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`snmpContextEngineId(String snmpContextEngineId)` Sets the context engine ID field of the scoped PDU.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`snmpContextName(String snmpContextName)` Sets the context name field of this scoped PDU.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`snmpVersion(int snmpVersion)` Sets the snmp version for the request.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`snmpVersion(String snmpVersion)` Sets the snmp version for the request.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`timeout(int timeout)` Sets the timeout value for the request in millis.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`timeout(String timeout)` Sets the timeout value for the request in millis.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`type(SnmpEndpointBuilderFactory.SnmpActionType type)` Which operation to perform such as poll, trap, etc.
`default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder`	`type(String type)` Which operation to perform such as poll, trap, etc.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve

- Method Detail
  - advanced
```
default SnmpEndpointBuilderFactory.AdvancedSnmpEndpointProducerBuilder advanced()
```
  - oids
```
default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder oids(Object 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
```
default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder oids(String 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
```
default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder protocol(String 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
```
default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder retries(int 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
```
default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder retries(String 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
```
default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder snmpCommunity(String 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.SnmpEndpointProducerBuilder 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.SnmpEndpointProducerBuilder 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
```
default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder snmpVersion(int 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
```
default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder snmpVersion(String 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
```
default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder timeout(int 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
```
default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder timeout(String 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.SnmpEndpointProducerBuilder type(SnmpEndpointBuilderFactory.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
```
default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder type(String 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
  - lazyStartProducer
```
default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder lazyStartProducer(boolean lazyStartProducer)
```
    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. The option is a: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - lazyStartProducer
```
default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder lazyStartProducer(String lazyStartProducer)
```
    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. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - authenticationPassphrase
```
default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder 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.SnmpEndpointProducerBuilder 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.SnmpEndpointProducerBuilder 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.SnmpEndpointProducerBuilder 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
```
default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder securityLevel(int 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
```
default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder securityLevel(String 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
```
default SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder securityName(String 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

Interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

Methods inherited from interface org.apache.camel.EndpointProducerResolver

Method Detail

advanced

oids

oids

protocol

retries

retries

snmpCommunity

snmpContextEngineId

snmpContextName

snmpVersion

snmpVersion

timeout

timeout

type

type

lazyStartProducer

lazyStartProducer

authenticationPassphrase

authenticationProtocol

privacyPassphrase

privacyProtocol

securityLevel

securityLevel

securityName