org.apache.camel.component.snmp

Class SnmpEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.impl.ScheduledPollEndpoint

org.apache.camel.impl.DefaultPollingEndpoint

org.apache.camel.component.snmp.SnmpEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(scheme="snmp",
             title="SNMP",
             syntax="snmp:host:port",
             consumerOnly=true,
             label="monitoring")
public class SnmpEndpoint
extends org.apache.camel.impl.DefaultPollingEndpoint

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_COMMUNITY
static int	DEFAULT_SNMP_RETRIES
static int	DEFAULT_SNMP_TIMEOUT
static int	DEFAULT_SNMP_VERSION

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
SnmpEndpoint(String uri, SnmpComponent component) creates a snmp endpoint

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Exchange	createExchange(org.snmp4j.PDU pdu) creates an exchange for the given message
org.apache.camel.Exchange	createExchange(org.snmp4j.PDU pdu, org.snmp4j.CommandResponderEvent event) creates an exchange for the given message
org.apache.camel.Producer	createProducer()
protected void	doStart()
String	getAddress()
String	getAuthenticationPassphrase()
String	getAuthenticationProtocol()
long	getDelay()
OIDList	getOids()
String	getPrivacyPassphrase()
String	getPrivacyProtocol()
String	getProtocol()
int	getRetries()
int	getSecurityLevel()
String	getSecurityName()
String	getSnmpCommunity()
String	getSnmpContextEngineId()
String	getSnmpContextName()
int	getSnmpVersion()
int	getTimeout()
SnmpActionType	getType()
void	initiate() Deprecated. use ServiceSupport.start() instead
boolean	isSingleton()
void	setAddress(String address)
void	setAuthenticationPassphrase(String authenticationPassphrase)
void	setAuthenticationProtocol(String authenticationProtocol)
void	setDelay(long updateEvery) Sets update rate in seconds
void	setOids(OIDList oids)
void	setPrivacyPassphrase(String privacyPassphrase)
void	setPrivacyProtocol(String privacyProtocol)
void	setProtocol(String protocol)
void	setRetries(int retries)
void	setSecurityLevel(int securityLevel)
void	setSecurityName(String securityName)
void	setSnmpCommunity(String snmpCommunity)
void	setSnmpContextEngineId(String snmpContextEngineId)
void	setSnmpContextName(String snmpContextName)
void	setSnmpVersion(int snmpVersion)
void	setTimeout(int timeout)
void	setType(SnmpActionType type)
String	toString()

Methods inherited from class org.apache.camel.impl.ScheduledPollEndpoint

configurePollingConsumer, configureProperties, configureScheduledPollConsumerProperties, doStop, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getInitialDelay, getPollStrategy, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, initConsumerProperties, isGreedy, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setGreedy, setInitialDelay, setPollStrategy, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExchangePattern, getId, getPollingConsumerQueueSize, hashCode, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Field Detail

DEFAULT_COMMUNITY

public static final String DEFAULT_COMMUNITY

See Also:

Constant Field Values

DEFAULT_SNMP_VERSION

public static final int DEFAULT_SNMP_VERSION

See Also:

Constant Field Values

DEFAULT_SNMP_RETRIES

public static final int DEFAULT_SNMP_RETRIES

See Also:

Constant Field Values

DEFAULT_SNMP_TIMEOUT

public static final int DEFAULT_SNMP_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

SnmpEndpoint

public SnmpEndpoint(String uri,
            SnmpComponent component)

creates a snmp endpoint

Parameters:

uri - the endpoint uri

component - the component

Method Detail

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Specified by:

createConsumer in interface org.apache.camel.Endpoint

Overrides:

createConsumer in class org.apache.camel.impl.DefaultPollingEndpoint

Throws:

Exception

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Throws:

Exception

isSingleton

public boolean isSingleton()

createExchange

public org.apache.camel.Exchange createExchange(org.snmp4j.PDU pdu)

creates an exchange for the given message

Parameters:

pdu - the pdu

Returns:

an exchange

createExchange

public org.apache.camel.Exchange createExchange(org.snmp4j.PDU pdu,
                                       org.snmp4j.CommandResponderEvent event)

creates an exchange for the given message

Parameters:

pdu - the pdu

event - a snmp4j CommandResponderEvent

Returns:

an exchange

initiate

@Deprecated
public void initiate()
              throws Exception

Deprecated. use ServiceSupport.start() instead

creates and configures the endpoint

Throws:

Exception - if unable to setup connection

getDelay

public long getDelay()

Overrides:

getDelay in class org.apache.camel.impl.ScheduledPollEndpoint

setDelay

public void setDelay(long updateEvery)

Sets update rate in seconds

Overrides:

setDelay in class org.apache.camel.impl.ScheduledPollEndpoint

Parameters:

updateEvery - the update rate in seconds

getType

public SnmpActionType getType()

setType

public void setType(SnmpActionType type)

getOids

public OIDList getOids()

setOids

public void setOids(OIDList oids)

getAddress

public String getAddress()

setAddress

public void setAddress(String address)

getRetries

public int getRetries()

setRetries

public void setRetries(int retries)

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int timeout)

getSnmpVersion

public int getSnmpVersion()

setSnmpVersion

public void setSnmpVersion(int snmpVersion)

getSnmpCommunity

public String getSnmpCommunity()

setSnmpCommunity

public void setSnmpCommunity(String snmpCommunity)

getProtocol

public String getProtocol()

setProtocol

public void setProtocol(String protocol)

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class org.apache.camel.impl.ScheduledPollEndpoint

Throws:

Exception

getSecurityLevel

public int getSecurityLevel()

setSecurityLevel

public void setSecurityLevel(int securityLevel)

getSecurityName

public String getSecurityName()

setSecurityName

public void setSecurityName(String securityName)

getAuthenticationProtocol

public String getAuthenticationProtocol()

setAuthenticationProtocol

public void setAuthenticationProtocol(String authenticationProtocol)

getAuthenticationPassphrase

public String getAuthenticationPassphrase()

setAuthenticationPassphrase

public void setAuthenticationPassphrase(String authenticationPassphrase)

getPrivacyProtocol

public String getPrivacyProtocol()

setPrivacyProtocol

public void setPrivacyProtocol(String privacyProtocol)

getPrivacyPassphrase

public String getPrivacyPassphrase()

setPrivacyPassphrase

public void setPrivacyPassphrase(String privacyPassphrase)

getSnmpContextName

public String getSnmpContextName()

setSnmpContextName

public void setSnmpContextName(String snmpContextName)

getSnmpContextEngineId

public String getSnmpContextEngineId()

setSnmpContextEngineId

public void setSnmpContextEngineId(String snmpContextEngineId)

toString

public String toString()

Overrides:

toString in class org.apache.camel.impl.DefaultEndpoint