Skip to content

armgit / core

Public Imported from GitHub
0

100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps

First start on SNMP client

Michael Rademaker94614a3c4503
diff --git a/agent/src/main/java/org/openremote/agent/protocol/snmp/SNMPClientAgent.java b/agent/src/main/java/org/openremote/agent/protocol/snmp/SNMPClientAgent.java
new file mode 100644
index 000000000..9314abdb9
--- /dev/null
+++ b/agent/src/main/java/org/openremote/agent/protocol/snmp/SNMPClientAgent.java
@@ -0,0 +1,82 @@
+package org.openremote.agent.protocol.snmp;
+
+import org.openremote.agent.protocol.knx.KNXAgent;
+import org.openremote.model.asset.agent.Agent;
+import org.openremote.model.asset.agent.AgentDescriptor;
+import org.openremote.model.asset.agent.AgentLink;
+import org.openremote.model.value.AttributeDescriptor;
+import org.openremote.model.value.ValueDescriptor;
+
+import javax.persistence.Entity;
+import javax.validation.constraints.NotNull;
+import java.util.Optional;
+
+@Entity
+public class SNMPClientAgent extends Agent<SNMPClientAgent, SNMPClientProtocol, AgentLink.Default> {
+
+ public static class SNMPAgentLink extends AgentLink<SNMPClientAgent.SNMPAgentLink> {
+
+ @NotNull
+ protected String community;
+ @NotNull
+ protected String oid;
+
+ // For Hydrators
+ protected SNMPAgentLink() {}
+
+ public SNMPAgentLink(String id, String community, String oid) {
+ super(id);
+ this.community = community;
+ this.oid = oid;
+ }
+
+ public Optional<String> getCommunity() {
+ return Optional.ofNullable(community);
+ }
+
+ public SNMPClientAgent.SNMPAgentLink setCommunity(String community) {
+ this.community = community;
+ return this;
+ }
+
+ public Optional<String> getOID() {
+ return Optional.ofNullable(oid);
+ }
+
+ public SNMPClientAgent.SNMPAgentLink setOID(String oid) {
+ this.oid = oid;
+ return this;
+ }
+ }
+
+ public enum SNMP_VERSION
+ {
+ V1,
+ V2c,
+ V3
+ }
+
+ public static final ValueDescriptor<SNMP_VERSION> VALUE_SNMP_VERSION = new ValueDescriptor<>("sNMPVersion", SNMP_VERSION.class);
+
+ public static final AttributeDescriptor<SNMP_VERSION> SNMP_VERSION = new AttributeDescriptor<>("sNMPVersionValue", VALUE_SNMP_VERSION);
+
+
+ public static final AgentDescriptor<SNMPClientAgent, SNMPClientProtocol, AgentLink.Default> DESCRIPTOR = new AgentDescriptor<>(
+ SNMPClientAgent.class, SNMPClientProtocol.class, AgentLink.Default.class
+ );
+
+ /**
+ * For use by hydrators (i.e. JPA/Jackson)
+ */
+ protected SNMPClientAgent() {
+ }
+
+ public SNMPClientAgent(String name) {
+ super(name);
+ }
+
+ @Override
+ public SNMPClientProtocol getProtocolInstance() {
+ return new SNMPClientProtocol(this);
+ }
+}
diff --git a/agent/src/main/java/org/openremote/agent/protocol/snmp/SNMPClientProtocol.java b/agent/src/main/java/org/openremote/agent/protocol/snmp/SNMPClientProtocol.java
new file mode 100644
index 000000000..4a4c633cf
--- /dev/null
+++ b/agent/src/main/java/org/openremote/agent/protocol/snmp/SNMPClientProtocol.java
@@ -0,0 +1,85 @@
+package org.openremote.agent.protocol.snmp;
+
+import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.component.snmp.SnmpMessage;
+import org.openremote.agent.protocol.AbstractProtocol;
+import org.openremote.model.Container;
+import org.openremote.model.asset.agent.AgentLink;
+import org.openremote.model.attribute.Attribute;
+import org.openremote.model.attribute.AttributeEvent;
+import org.openremote.model.syslog.SyslogCategory;
+import org.snmp4j.PDU;
+
+import java.net.URI;
+import java.util.logging.Logger;
+
+import static org.openremote.model.syslog.SyslogCategory.PROTOCOL;
+
+public class SNMPClientProtocol extends AbstractProtocol<SNMPClientAgent, AgentLink.Default> {
+
+ public static final String PROTOCOL_DISPLAY_NAME = "SNMP Client";
+ protected static final Logger LOG = SyslogCategory.getLogger(PROTOCOL, SNMPClientProtocol.class);
+
+ public SNMPClientProtocol(SNMPClientAgent agent) {
+ super(agent);
+ }
+
+ @Override
+ public String getProtocolName() {
+ return PROTOCOL_DISPLAY_NAME;
+ }
+
+ @Override
+ protected void doStart(Container container) throws Exception {
+
+ String snmpHost = agent.getHost().orElseThrow(() -> {
+ String msg = "No SNMP host provided for protocol: " + this;
+ LOG.info(msg);
+ return new IllegalArgumentException(msg);
+ });
+
+ Integer snmpPort = agent.getPort().orElse(162);
+
+ String snmpUri = String.format("snmp:%s:%d?protocol=udp&type=TRAP", snmpHost, snmpPort);
+
+ messageBrokerContext.addRoutes(new RouteBuilder() {
+ @Override
+ public void configure() {
+ from(snmpUri)
+ .routeId(getProtocolName() + getAgent().getId())
+ .process(exchange -> {
+
+ // Since we are using Snmp, we get SnmpMessage object, we need to typecast from Message
+ SnmpMessage msg = (SnmpMessage) exchange.getIn();
+ PDU pdu = msg.getSnmpMessage();
+ pdu.getVariableBindings().forEach(variableBinding -> LOG.info(variableBinding.toValueString()));
+ });
+ }
+ });
+ }
+
+ @Override
+ protected void doStop(Container container) throws Exception {
+
+ }
+
+ @Override
+ protected void doLinkAttribute(String assetId, Attribute<?> attribute, AgentLink.Default agentLink) throws RuntimeException {
+
+ }
+
+ @Override
+ protected void doUnlinkAttribute(String assetId, Attribute<?> attribute, AgentLink.Default agentLink) {
+
+ }
+
+ @Override
+ protected void doLinkedAttributeWrite(Attribute<?> attribute, AgentLink.Default agentLink, AttributeEvent event, Object processedValue) {
+
+ }
+
+ @Override
+ public String getProtocolInstanceUri() {
+ return null;
+ }
+}
diff --git a/container/build.gradle b/container/build.gradle
index 21905a078..559d03f9e 100644
--- a/container/build.gradle
+++ b/container/build.gradle
@@ -43,6 +43,7 @@ dependencies {
compile "org.apache.camel:camel-core:$camelVersion"
compile "org.apache.camel:camel-jackson:$camelVersion"
+ compile "org.apache.camel:camel-snmp:$camelVersion"
compile("com.fasterxml.uuid:java-uuid-generator:$uuidGeneratorVersion") {
exclude group: "log4j"
diff --git a/container/src/main/java/org/openremote/container/message/MessageBrokerService.java b/container/src/main/java/org/openremote/container/message/MessageBrokerService.java
index dc4e20296..4c48dd208 100644
--- a/container/src/main/java/org/openremote/container/message/MessageBrokerService.java
+++ b/container/src/main/java/org/openremote/container/message/MessageBrokerService.java
@@ -21,6 +21,7 @@ package org.openremote.container.message;
import org.apache.camel.Processor;
import org.apache.camel.ProducerTemplate;
+import org.apache.camel.component.snmp.SnmpComponent;
import org.apache.camel.impl.DefaultStreamCachingStrategy;
import org.apache.camel.spi.*;
import org.apache.camel.util.StringHelper;
@@ -139,6 +140,7 @@ public class MessageBrokerService implements ContainerService {
);
context.addComponent(WebsocketComponent.NAME, websocketComponent);
+ context.addComponent("snmp", new SnmpComponent());
}
@Override