Skip to content

Commit b0f62b9

Browse files
benmussonbenmusson
authored
Merge pull request #401 from mussonindustrial/8.1/snmp/chore/refactor-to-agents
(8.1) refactor into `agent` specific naming/packages
2 parents 5eac73e + 6165d8d commit b0f62b9

32 files changed

+256
-257
lines changed

modules/snmp/common/src/main/resources/com/mussonindustrial/embr/snmp/configuration/records/SnmpV1DeviceRecord.properties renamed to modules/snmp/common/src/main/resources/com/mussonindustrial/embr/snmp/agents/configuration/records/SnmpAgentV1DeviceRecord.properties

File renamed without changes.

modules/snmp/common/src/main/resources/com/mussonindustrial/embr/snmp/configuration/records/SnmpV2cDeviceRecord.properties renamed to modules/snmp/common/src/main/resources/com/mussonindustrial/embr/snmp/agents/configuration/records/SnmpAgentV2cDeviceRecord.properties

File renamed without changes.

modules/snmp/common/src/main/resources/com/mussonindustrial/embr/snmp/configuration/records/SnmpV3DeviceRecord.properties renamed to modules/snmp/common/src/main/resources/com/mussonindustrial/embr/snmp/agents/configuration/records/SnmpAgentV3DeviceRecord.properties

File renamed without changes.

‎modules/snmp/common/src/main/resources/localization.properties‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
device.SnmpV1Device.DisplayName=SNMPv1 Driver
2-
device.SnmpV1Device.Description=Connect to devices that implement SNMPv1.
3-
device.SnmpV2cDevice.DisplayName=SNMPv2c Driver
4-
device.SnmpV2cDevice.Description=Connect to devices that implement SNMPv2c.
5-
device.SnmpV3Device.DisplayName=SNMPv3 Driver
6-
device.SnmpV3Device.Description=Connect to devices that implement SNMPv3.
1+
device.SnmpAgentV1.DisplayName=SNMPv1 Agent Driver
2+
device.SnmpAgentV1.Description=Connect to SNMP Agents via SNMPv1.
3+
device.SnmpAgentV2c.DisplayName=SNMPv2c Agent Driver
4+
device.SnmpAgentV2c.Description=Connect to SNMP Agents via SNMPv2c.
5+
device.SnmpAgentV3.DisplayName=SNMPv3 Agent Driver
6+
device.SnmpAgentV3.Description=Connect to SNMP Agents via SNMPv3.

‎modules/snmp/gateway/src/main/kotlin/com/mussonindustrial/embr/snmp/SnmpGatewayContext.kt‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ import com.inductiveautomation.ignition.gateway.model.TelemetryManager
77
import com.mussonindustrial.embr.common.logging.getLoggerEx
88
import com.mussonindustrial.embr.gateway.EmbrGatewayContext
99
import com.mussonindustrial.embr.gateway.EmbrGatewayContextImpl
10-
import com.mussonindustrial.embr.snmp.configuration.records.SnmpV1DeviceRecord
11-
import com.mussonindustrial.embr.snmp.configuration.records.SnmpV2cDeviceRecord
12-
import com.mussonindustrial.embr.snmp.configuration.records.SnmpV3DeviceRecord
13-
import com.mussonindustrial.embr.snmp.configuration.types.SnmpV1DeviceType
14-
import com.mussonindustrial.embr.snmp.configuration.types.SnmpV2cDeviceType
15-
import com.mussonindustrial.embr.snmp.configuration.types.SnmpV3DeviceType
10+
import com.mussonindustrial.embr.snmp.agents.configuration.records.SnmpAgentV1DeviceRecord
11+
import com.mussonindustrial.embr.snmp.agents.configuration.records.SnmpAgentV2cDeviceRecord
12+
import com.mussonindustrial.embr.snmp.agents.configuration.records.SnmpAgentV3DeviceRecord
13+
import com.mussonindustrial.embr.snmp.agents.configuration.types.SnmpAgentV1DeviceType
14+
import com.mussonindustrial.embr.snmp.agents.configuration.types.SnmpAgentV2cDeviceType
15+
import com.mussonindustrial.embr.snmp.agents.configuration.types.SnmpAgentV3DeviceType
1616
import java.util.concurrent.ThreadFactory
1717
import java.util.concurrent.atomic.AtomicInteger
1818
import org.snmp4j.SNMP4JSettings
@@ -39,9 +39,13 @@ class SnmpGatewayContext(private val context: GatewayContext) :
3939
SNMP4JSettings.setEnterpriseID(PRIVATE_ENTERPRISE_NUMBER)
4040
}
4141

42-
val deviceTypes = listOf(SnmpV1DeviceType, SnmpV2cDeviceType, SnmpV3DeviceType)
42+
val deviceTypes = listOf(SnmpAgentV1DeviceType, SnmpAgentV2cDeviceType, SnmpAgentV3DeviceType)
4343
private val records =
44-
listOf(SnmpV1DeviceRecord.META, SnmpV2cDeviceRecord.META, SnmpV3DeviceRecord.META)
44+
listOf(
45+
SnmpAgentV1DeviceRecord.META,
46+
SnmpAgentV2cDeviceRecord.META,
47+
SnmpAgentV3DeviceRecord.META,
48+
)
4549

4650
val securityProtocols: SecurityProtocols =
4751
SecurityProtocols.getInstance().apply {

modules/snmp/gateway/src/main/kotlin/com/mussonindustrial/embr/snmp/configuration/records/SnmpV1DeviceRecord.kt renamed to modules/snmp/gateway/src/main/kotlin/com/mussonindustrial/embr/snmp/agents/configuration/records/SnmpAgentV1DeviceRecord.kt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
package com.mussonindustrial.embr.snmp.configuration.records
1+
package com.mussonindustrial.embr.snmp.agents.configuration.records
22

33
import com.inductiveautomation.ignition.gateway.localdb.persistence.*
44
import com.inductiveautomation.ignition.gateway.opcua.server.api.DeviceSettingsRecord
5-
import com.mussonindustrial.embr.snmp.configuration.settings.SnmpV1DeviceSettings
5+
import com.mussonindustrial.embr.snmp.agents.configuration.settings.SnmpAgentV1DeviceSettings
66
import simpleorm.dataset.SFieldFlags
77

8-
class SnmpV1DeviceRecord : SnmpV1DeviceSettings, PersistentRecord() {
8+
class SnmpAgentV1DeviceRecord : SnmpAgentV1DeviceSettings, PersistentRecord() {
99

1010
companion object {
11-
val META = RecordMeta(SnmpV1DeviceRecord::class.java, "EmbrSnmpV1DeviceSettings")
11+
val META = RecordMeta(SnmpAgentV1DeviceRecord::class.java, "EmbrSnmpAgentV1DeviceSettings")
1212

1313
val DEVICE_SETTINGS_ID = LongField(META, "DeviceSettingsId", SFieldFlags.SPRIMARY_KEY)
1414
val DEVICE_SETTINGS =
@@ -18,7 +18,7 @@ class SnmpV1DeviceRecord : SnmpV1DeviceSettings, PersistentRecord() {
1818
val ADDRESS = StringField(META, "Address", SFieldFlags.SMANDATORY)
1919
val TIMEOUT = IntField(META, "Timeout", SFieldFlags.SMANDATORY).apply { default = 1000 }
2020
val CATEGORY_CONNECTIVITY =
21-
Category("SnmpV1DeviceRecord.Connectivity", 1001).apply {
21+
Category("SnmpAgentV1DeviceRecord.Connectivity", 1001).apply {
2222
include(ADDRESS)
2323
include(TIMEOUT)
2424
}
@@ -27,7 +27,7 @@ class SnmpV1DeviceRecord : SnmpV1DeviceSettings, PersistentRecord() {
2727
StringField(META, "CommunityRead", SFieldFlags.SMANDATORY).apply { default = "public" }
2828
val COMMUNITY_WRITE = StringField(META, "CommunityWrite").apply { default = "private" }
2929
val CATEGORY_COMMUNITY =
30-
Category("SnmpV1DeviceRecord.Community", 1002).apply {
30+
Category("SnmpAgentV1DeviceRecord.Community", 1002).apply {
3131
include(COMMUNITY_READ)
3232
include(COMMUNITY_WRITE)
3333
}
@@ -39,7 +39,7 @@ class SnmpV1DeviceRecord : SnmpV1DeviceSettings, PersistentRecord() {
3939
default = "1.3.6.1.2.1.1.2.0"
4040
}
4141
val CATEGORY_HEALTHCHECK =
42-
Category("SnmpV1DeviceRecord.Healthcheck", 1003, true).apply {
42+
Category("SnmpAgentV1DeviceRecord.Healthcheck", 1003, true).apply {
4343
include(HEALTHCHECK_FREQUENCY)
4444
include(HEALTHCHECK_OID)
4545
}

modules/snmp/gateway/src/main/kotlin/com/mussonindustrial/embr/snmp/configuration/records/SnmpV2cDeviceRecord.kt renamed to modules/snmp/gateway/src/main/kotlin/com/mussonindustrial/embr/snmp/agents/configuration/records/SnmpAgentV2cDeviceRecord.kt

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
package com.mussonindustrial.embr.snmp.configuration.records
1+
package com.mussonindustrial.embr.snmp.agents.configuration.records
22

33
import com.inductiveautomation.ignition.gateway.localdb.persistence.*
44
import com.inductiveautomation.ignition.gateway.opcua.server.api.DeviceSettingsRecord
5-
import com.mussonindustrial.embr.snmp.configuration.settings.SnmpV2cDeviceSettings
5+
import com.mussonindustrial.embr.snmp.agents.configuration.settings.SnmpAgentV2CDeviceSettings
66
import simpleorm.dataset.SFieldFlags
77

8-
class SnmpV2cDeviceRecord : SnmpV2cDeviceSettings, PersistentRecord() {
8+
class SnmpAgentV2cDeviceRecord : SnmpAgentV2CDeviceSettings, PersistentRecord() {
99

1010
companion object {
11-
val META = RecordMeta(SnmpV2cDeviceRecord::class.java, "EmbrSnmpV2cDeviceSettings")
11+
val META =
12+
RecordMeta(SnmpAgentV2cDeviceRecord::class.java, "EmbrSnmpAgentV2cDeviceSettings")
1213

1314
val DEVICE_SETTINGS_ID = LongField(META, "DeviceSettingsId", SFieldFlags.SPRIMARY_KEY)
1415
val DEVICE_SETTINGS =
@@ -18,7 +19,7 @@ class SnmpV2cDeviceRecord : SnmpV2cDeviceSettings, PersistentRecord() {
1819
val ADDRESS = StringField(META, "Address", SFieldFlags.SMANDATORY)
1920
val TIMEOUT = IntField(META, "Timeout", SFieldFlags.SMANDATORY).apply { default = 1000 }
2021
val CATEGORY_CONNECTIVITY =
21-
Category("SnmpV2cDeviceRecord.Connectivity", 1001).apply {
22+
Category("SnmpAgentV2cDeviceRecord.Connectivity", 1001).apply {
2223
include(ADDRESS)
2324
include(TIMEOUT)
2425
}
@@ -27,7 +28,7 @@ class SnmpV2cDeviceRecord : SnmpV2cDeviceSettings, PersistentRecord() {
2728
StringField(META, "CommunityRead", SFieldFlags.SMANDATORY).apply { default = "public" }
2829
val COMMUNITY_WRITE = StringField(META, "CommunityWrite").apply { default = "private" }
2930
val CATEGORY_COMMUNITY =
30-
Category("SnmpV2cDeviceRecord.Community", 1002).apply {
31+
Category("SnmpAgentV2cDeviceRecord.Community", 1002).apply {
3132
include(COMMUNITY_READ)
3233
include(COMMUNITY_WRITE)
3334
}
@@ -39,7 +40,7 @@ class SnmpV2cDeviceRecord : SnmpV2cDeviceSettings, PersistentRecord() {
3940
default = "1.3.6.1.2.1.1.2.0"
4041
}
4142
val CATEGORY_HEALTHCHECK =
42-
Category("SnmpV2cDeviceRecord.Healthcheck", 1003, true).apply {
43+
Category("SnmpAgentV2cDeviceRecord.Healthcheck", 1003, true).apply {
4344
include(HEALTHCHECK_FREQUENCY)
4445
include(HEALTHCHECK_OID)
4546
}

modules/snmp/gateway/src/main/kotlin/com/mussonindustrial/embr/snmp/configuration/records/SnmpV3DeviceRecord.kt renamed to modules/snmp/gateway/src/main/kotlin/com/mussonindustrial/embr/snmp/agents/configuration/records/SnmpAgentV3DeviceRecord.kt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
package com.mussonindustrial.embr.snmp.configuration.records
1+
package com.mussonindustrial.embr.snmp.agents.configuration.records
22

33
import com.inductiveautomation.ignition.gateway.localdb.persistence.*
44
import com.inductiveautomation.ignition.gateway.opcua.server.api.DeviceSettingsRecord
55
import com.inductiveautomation.ignition.gateway.web.components.editors.PasswordEditorSource
6-
import com.mussonindustrial.embr.snmp.configuration.protocols.AuthenticationProtocol
7-
import com.mussonindustrial.embr.snmp.configuration.protocols.PrivacyProtocol
8-
import com.mussonindustrial.embr.snmp.configuration.settings.SnmpV3DeviceSettings
6+
import com.mussonindustrial.embr.snmp.agents.configuration.settings.SnmpAgentV3DeviceSettings
7+
import com.mussonindustrial.embr.snmp.protocols.AuthenticationProtocol
8+
import com.mussonindustrial.embr.snmp.protocols.PrivacyProtocol
99
import simpleorm.dataset.SFieldFlags
1010

11-
class SnmpV3DeviceRecord : SnmpV3DeviceSettings, PersistentRecord() {
11+
class SnmpAgentV3DeviceRecord : SnmpAgentV3DeviceSettings, PersistentRecord() {
1212

1313
companion object {
14-
val META = RecordMeta(SnmpV3DeviceRecord::class.java, "EmbrSnmpV3DeviceSettings")
14+
val META = RecordMeta(SnmpAgentV3DeviceRecord::class.java, "EmbrSnmpAgentV3DeviceSettings")
1515

1616
val DEVICE_SETTINGS_ID = LongField(META, "DeviceSettingsId", SFieldFlags.SPRIMARY_KEY)
1717
val DEVICE_SETTINGS =
@@ -21,7 +21,7 @@ class SnmpV3DeviceRecord : SnmpV3DeviceSettings, PersistentRecord() {
2121
val ADDRESS = StringField(META, "Address", SFieldFlags.SMANDATORY)
2222
val TIMEOUT = IntField(META, "Timeout", SFieldFlags.SMANDATORY).apply { default = 1000 }
2323
val CATEGORY_CONNECTIVITY =
24-
Category("SnmpV3DeviceRecord.Connectivity", 1001).apply {
24+
Category("SnmpAgentV3DeviceRecord.Connectivity", 1001).apply {
2525
include(ADDRESS)
2626
include(TIMEOUT)
2727
}
@@ -39,7 +39,7 @@ class SnmpV3DeviceRecord : SnmpV3DeviceSettings, PersistentRecord() {
3939
formMeta.editorSource = PasswordEditorSource.getSharedInstance()
4040
}
4141
val CATEGORY_AUTH =
42-
Category("SnmpV3DeviceRecord.Authentication", 1002).apply {
42+
Category("SnmpAgentV3DeviceRecord.Authentication", 1002).apply {
4343
include(AUTH_USERNAME)
4444
include(AUTH_PROTOCOL)
4545
include(AUTH_PASSWORD)
@@ -52,7 +52,7 @@ class SnmpV3DeviceRecord : SnmpV3DeviceSettings, PersistentRecord() {
5252
formMeta.editorSource = PasswordEditorSource.getSharedInstance()
5353
}
5454
val CATEGORY_PRIVACY =
55-
Category("SnmpV3DeviceRecord.Privacy", 1003).apply {
55+
Category("SnmpAgentV3DeviceRecord.Privacy", 1003).apply {
5656
include(PRIVACY_PROTOCOL)
5757
include(PRIVACY_PASSWORD)
5858
}

modules/snmp/gateway/src/main/kotlin/com/mussonindustrial/embr/snmp/configuration/settings/SnmpDeviceSettings.kt renamed to modules/snmp/gateway/src/main/kotlin/com/mussonindustrial/embr/snmp/agents/configuration/settings/SnmpAgentDeviceSettings.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
package com.mussonindustrial.embr.snmp.configuration.settings
1+
package com.mussonindustrial.embr.snmp.agents.configuration.settings
22

3-
interface SnmpDeviceSettings {
3+
interface SnmpAgentDeviceSettings {
44
val address: String
55
val timeout: Int
66
val healthcheckFrequency: Int?

‎modules/snmp/gateway/src/main/kotlin/com/mussonindustrial/embr/snmp/agents/configuration/settings/SnmpAgentV1DeviceSettings.kt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
package com.mussonindustrial.embr.snmp.agents.configuration.settings
2+
3+
interface SnmpAgentV1DeviceSettings : SnmpAgentDeviceSettings {
4+
val communityRead: String
5+
val communityWrite: String?
6+
}

0 commit comments

Comments
 (0)