SnmpEndpointBuilderFactory.SnmpEndpointBuilder (Camel

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

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

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, bridgeErrorHandler, bridgeErrorHandler, 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

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

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

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
lazyStartProducer, lazyStartProducer

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

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

- Method Detail
  - advanced
```
default SnmpEndpointBuilderFactory.AdvancedSnmpEndpointBuilder advanced()
```
    Specified by:
    
    advanced in interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    advanced in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
  - oids
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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
    
    Specified by:
    
    oids in interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    oids in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    oids - the value to set
    
    Returns:
    
    the dsl builder
  - oids
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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
    
    Specified by:
    
    oids in interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    oids in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    oids - the value to set
    
    Returns:
    
    the dsl builder
  - protocol
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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
    
    Specified by:
    
    protocol in interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    protocol in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    protocol - the value to set
    
    Returns:
    
    the dsl builder
  - retries
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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
    
    Specified by:
    
    retries in interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    retries in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    retries - the value to set
    
    Returns:
    
    the dsl builder
  - retries
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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
    
    Specified by:
    
    retries in interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    retries in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    retries - the value to set
    
    Returns:
    
    the dsl builder
  - snmpCommunity
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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
    
    Specified by:
    
    snmpCommunity in interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    snmpCommunity in interface SnmpEndpointBuilderFactory.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 interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    snmpContextEngineId in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    snmpContextEngineId - the value to set
    
    Returns:
    
    the dsl builder
  - snmpContextName
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder snmpContextName(String 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 interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    snmpContextName in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    snmpContextName - the value to set
    
    Returns:
    
    the dsl builder
  - snmpVersion
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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
    
    Specified by:
    
    snmpVersion in interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    snmpVersion in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    snmpVersion - the value to set
    
    Returns:
    
    the dsl builder
  - snmpVersion
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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
    
    Specified by:
    
    snmpVersion in interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    snmpVersion in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    snmpVersion - the value to set
    
    Returns:
    
    the dsl builder
  - timeout
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder timeout(int 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 interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    timeout in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    timeout - the value to set
    
    Returns:
    
    the dsl builder
  - timeout
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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
    
    Specified by:
    
    timeout in interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    timeout in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    timeout - the value to set
    
    Returns:
    
    the dsl builder
  - type
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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
    
    Specified by:
    
    type in interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    type in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    type - the value to set
    
    Returns:
    
    the dsl builder
  - type
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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
    
    Specified by:
    
    type in interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    type in interface SnmpEndpointBuilderFactory.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 interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    authenticationPassphrase in interface SnmpEndpointBuilderFactory.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 interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    authenticationProtocol in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    authenticationProtocol - the value to set
    
    Returns:
    
    the dsl builder
  - privacyPassphrase
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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
    
    Specified by:
    
    privacyPassphrase in interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    privacyPassphrase in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    privacyPassphrase - the value to set
    
    Returns:
    
    the dsl builder
  - privacyProtocol
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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
    
    Specified by:
    
    privacyProtocol in interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    privacyProtocol in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    privacyProtocol - the value to set
    
    Returns:
    
    the dsl builder
  - securityLevel
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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
    
    Specified by:
    
    securityLevel in interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    securityLevel in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    securityLevel - the value to set
    
    Returns:
    
    the dsl builder
  - securityLevel
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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
    
    Specified by:
    
    securityLevel in interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    securityLevel in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    securityLevel - the value to set
    
    Returns:
    
    the dsl builder
  - securityName
```
default SnmpEndpointBuilderFactory.SnmpEndpointBuilder 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
    
    Specified by:
    
    securityName in interface SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder
    
    Specified by:
    
    securityName in interface SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder
    
    Parameters:
    
    securityName - the value to set
    
    Returns:
    
    the dsl builder

Interface SnmpEndpointBuilderFactory.SnmpEndpointBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SnmpEndpointBuilderFactory.SnmpEndpointConsumerBuilder

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

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SnmpEndpointBuilderFactory.SnmpEndpointProducerBuilder

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

authenticationPassphrase

authenticationProtocol

privacyPassphrase

privacyProtocol

securityLevel

securityLevel

securityName