20 | * {@code
21 | * - name: "example1"
22 | * device: "src/test/resources/configuration/cisco.yaml"
23 | * walk: "src/test/resources/configuration/example.txt"
24 | * ip: "127.0.0.1"
25 | * port: 10000
26 | * }
27 | *
28 | * You can find more example within the test resources of this project.
29 | *
28 | * {@code
29 | * - name: "example1"
30 | * device: "src/test/resources/configuration/cisco.yaml"
31 | * walk: "src/test/resources/configuration/example.txt"
32 | * ip: "127.0.0.1"
33 | * port: 10000
34 | * }
35 | *
36 | * You can find more example within the test resources of this project.
37 | *
38 | * An overflow can occur and will be considered in the minimum and maximum interval.
39 | *
40 | * @param currentValue the current value to modify
41 | * @param minimum {@link #minimum}
42 | * @param maximum {@link #maximum}
43 | * @param minimumStep {@link #minimumStep}
44 | * @param maximumStep {@link #maximumStep}
45 | * @return the modified variable value
46 | */
47 | protected int modify(final int currentValue, final int minimum, final int maximum, final int minimumStep, final int maximumStep) {
48 | int currentValidValue = currentValue;
49 | if (currentValue < minimum || currentValue > maximum) {
50 | currentValidValue = minimum;
51 | }
52 | int step = (int) (Math.round(Math.random() * (maximumStep - minimumStep)) + minimumStep);
53 |
54 | int stepUntilMaximum = maximum - currentValidValue;
55 | int newValue;
56 | if (Math.abs(step) > Math.abs(stepUntilMaximum)) {
57 | newValue = minimum + (step - stepUntilMaximum - 1);
58 | } else {
59 | newValue = currentValidValue + step;
60 | }
61 |
62 | if (newValue < minimum) {
63 | newValue = minimum;
64 | } else if (newValue > maximum) {
65 | newValue = maximum;
66 | }
67 |
68 | return newValue;
69 | }
70 |
71 | @Override
72 | public Integer32 modify(final Integer32 variable) {
73 | final int newValue = this.modify(variable.getValue(), minimum, maximum, minimumStep, maximumStep);
74 | log.trace("Counter32 variable {} will be tuned to {}", variable.getValue(), newValue);
75 | return new Integer32(newValue);
76 | }
77 | }
78 |
--------------------------------------------------------------------------------
/snmpman/src/main/java/com/oneandone/snmpman/configuration/modifier/ModifiedVariable.java:
--------------------------------------------------------------------------------
1 | package com.oneandone.snmpman.configuration.modifier;
2 |
3 | import lombok.extern.slf4j.Slf4j;
4 | import org.snmp4j.asn1.BERInputStream;
5 | import org.snmp4j.smi.OID;
6 | import org.snmp4j.smi.Variable;
7 |
8 | import java.io.IOException;
9 | import java.io.OutputStream;
10 | import java.util.Collections;
11 | import java.util.List;
12 |
13 | /**
14 | * A modified variable will change it's value on every value call.
15 | */
16 | @Slf4j
17 | public class ModifiedVariable implements Variable, Cloneable {
18 |
19 | /** The list of modifiers that modify the {@link #variable}. */
20 | private final List
28 | * A modified variable will dynamically change it's value on each value call.
29 | *
30 | * @param variable the initial variable to modify
31 | * @param modifiers the list of modifiers that should modify this variable
32 | */
33 | public ModifiedVariable(final Variable variable, final List
16 | * See also {@link com.oneandone.snmpman.configuration.modifier.VariableModifier}.
17 | *
18 | * @param
8 | * This method will return a new {@link TimeTicks} instance with the current timestamp.
9 | */
10 | public class TimeTicksModifier implements VariableModifier
4 | * In this context the so called modified variables are those which value change with every prompt.
5 | *
6 | * Every implementation of the {@link com.oneandone.snmpman.configuration.modifier.VariableModifier} can be used as a binding
7 | * modifier in a device configuration.
8 | *
9 | * @see com.oneandone.snmpman.configuration.Device
10 | */
11 | package com.oneandone.snmpman.configuration.modifier;
--------------------------------------------------------------------------------
/snmpman/src/main/java/com/oneandone/snmpman/configuration/package-info.java:
--------------------------------------------------------------------------------
1 | /** This package contains all classes as used for the configuration of the {@code Snmpman} application. */
2 | package com.oneandone.snmpman.configuration;
--------------------------------------------------------------------------------
/snmpman/src/main/java/com/oneandone/snmpman/configuration/type/ModifierProperties.java:
--------------------------------------------------------------------------------
1 | package com.oneandone.snmpman.configuration.type;
2 |
3 | import com.google.common.primitives.UnsignedLong;
4 |
5 | import java.util.Optional;
6 | import java.util.Properties;
7 |
8 | /** The modifier properties as used in {@link com.oneandone.snmpman.configuration.Device} for initialization. */
9 | public class ModifierProperties extends Properties {
10 |
11 | /**
12 | * Returns the integer value for the specified property {@code key}.
13 | *
14 | * @param key the property key
15 | * @return the integer value for the specified key or {@code null} if not existing.
16 | * @throws java.lang.ClassCastException thrown if the value for the specified key could not be casted
17 | */
18 | public Integer getInteger(final String key) {
19 | final Optional
13 | * The wildcard will be considered for matching request in the function {@link #matches(org.snmp4j.smi.OID)}.
14 | * Every sequence of {@code int} array chains can be considered for the wildcard character.
15 | *
16 | * Only one wildcard is allowed for the wildcard {@code OID}.
17 | */
18 | @EqualsAndHashCode
19 | public class WildcardOID {
20 |
21 | /** The wildcard OID pattern. */
22 | private static final Pattern WILDCARD_OID_PATTERN = Pattern.compile("((\\.)?[0-9]+(\\.[0-9]+)*)(\\.\\*)?((\\.[0-9]+)*)");
23 |
24 | /** The first part of the wildcard {@code OID} (before the "{@code *}" character). */
25 | private final OID startsWith;
26 |
27 | /** The second part of the wildcard {@code OID} (after the "{@code *}" character). Can be {@code null}. */
28 | private final OID endsWith;
29 |
30 | /**
31 | * Constructs a new instance of this class.
32 | *
33 | * @param oid the {@code OID} that potentially contains a wildcard
34 | * @throws NullPointerException if the specified {@code OID} is null
35 | * @throws IllegalArgumentException if the specified {@code OID} contains more than one wildcard character
36 | */
37 | public WildcardOID(final String oid) {
38 | Preconditions.checkNotNull(oid, "oid may not be null");
39 |
40 | final Matcher matcher = WILDCARD_OID_PATTERN.matcher(oid);
41 | if (matcher.matches()) {
42 | this.startsWith = new OID(matcher.group(1));
43 | if (matcher.group(5).isEmpty()) {
44 | this.endsWith = null;
45 | } else {
46 | this.endsWith = new OID(matcher.group(5));
47 | }
48 | } else {
49 | throw new IllegalArgumentException("specified oid \"" + oid + "\" is not a valid wildcard");
50 | }
51 | }
52 |
53 | /**
54 | * Returns {@code true} if this wildcard {@code OID} matches with the specified {@code OID}.
55 | *
56 | * Here some examples for matching {@code OID}s:
57 | *
58 | *
62 | *
63 | * @param oid the {@code OID} to test
64 | * @return {@code true} if the {@code OID}s are matching, otherwise {@code false}
65 | */
66 | public boolean matches(final OID oid) {
67 | return oid.startsWith(startsWith) && (endsWith == null || oid.size() >= endsWith.size() && oid.rightMostCompare(endsWith.size(), endsWith) == 0);
68 | }
69 |
70 | @Override
71 | public String toString() {
72 | if (endsWith == null) {
73 | return startsWith.toDottedString() + ".*";
74 | } else {
75 | return startsWith.toDottedString() + ".*." + endsWith.toDottedString();
76 | }
77 | }
78 | }
79 |
--------------------------------------------------------------------------------
/snmpman/src/main/java/com/oneandone/snmpman/configuration/type/package-info.java:
--------------------------------------------------------------------------------
1 | /** Types as used by other configuration representations. */
2 | package com.oneandone.snmpman.configuration.type;
--------------------------------------------------------------------------------
/snmpman/src/main/java/com/oneandone/snmpman/exception/InitializationException.java:
--------------------------------------------------------------------------------
1 | package com.oneandone.snmpman.exception;
2 |
3 | /** Exception type defines the failed initialization of the application. */
4 | public class InitializationException extends RuntimeException {
5 |
6 | /** The version number of this class. */
7 | private static final long serialVersionUID = 1L;
8 |
9 | /**
10 | * Constructs a new exception.
11 | *
12 | * @param message the detail message
13 | */
14 | public InitializationException(final String message) {
15 | super(message);
16 | }
17 |
18 | /**
19 | * Constructs a new exception.
20 | *
21 | * @param message the detail message
22 | * @param cause the exception cause
23 | */
24 | public InitializationException(final String message, final Throwable cause) {
25 | super(message, cause);
26 | }
27 |
28 | }
29 |
--------------------------------------------------------------------------------
/snmpman/src/main/java/com/oneandone/snmpman/exception/package-info.java:
--------------------------------------------------------------------------------
1 | /** Application specific exception types. */
2 | package com.oneandone.snmpman.exception;
--------------------------------------------------------------------------------
/snmpman/src/main/java/com/oneandone/snmpman/package-info.java:
--------------------------------------------------------------------------------
1 | /**
2 | * The {@code Snmpman} is a command-line application that simulates {@code SNMP}-capable devices.
3 | *
4 | * It also can be used within Unit tests which require the usage of SNMP devices. You can start and stop all agents
5 | * with pre- and post unit-test execution methods, which are available in probably every Unit-Test framework.
6 | *
7 | * Check the documentation of {@link com.oneandone.snmpman.Snmpman} to get more information on the execution.
8 | */
9 | package com.oneandone.snmpman;
--------------------------------------------------------------------------------
/snmpman/src/main/java/com/oneandone/snmpman/snmp/MOGroup.java:
--------------------------------------------------------------------------------
1 | package com.oneandone.snmpman.snmp;
2 |
3 | import lombok.extern.slf4j.Slf4j;
4 | import org.snmp4j.agent.DefaultMOScope;
5 | import org.snmp4j.agent.MOScope;
6 | import org.snmp4j.agent.ManagedObject;
7 | import org.snmp4j.agent.request.SubRequest;
8 | import org.snmp4j.mp.SnmpConstants;
9 | import org.snmp4j.smi.Null;
10 | import org.snmp4j.smi.OID;
11 | import org.snmp4j.smi.Variable;
12 |
13 | import java.util.Iterator;
14 | import java.util.SortedMap;
15 | import java.util.TreeMap;
16 |
17 | @Slf4j
18 | public class MOGroup implements ManagedObject {
19 |
20 | /**
21 | * Sorted map of the variable bindings for this group.
22 | */
23 | private final SortedMap
38 | * The specified {@code OID} and variable will be set as the only data stored
39 | * in the map of {@link #variableBindings}.
40 | *
41 | * @param root the root {@code OID}
42 | * @param oid the {@code OID} for a variable binding
43 | * @param variable the variable of the variable binding
44 | */
45 | public MOGroup(final OID root, final OID oid, final Variable variable) {
46 | this.root = root;
47 | this.scope = new DefaultMOScope(root, true, root.nextPeer(), false);
48 | this.variableBindings = new TreeMap<>();
49 | this.variableBindings.put(oid, variable);
50 | }
51 |
52 | /**
53 | * Constructs a new instance of this class.
54 | *
55 | * @param root the root {@code OID}
56 | * @param variableBindings the map of variable bindings for this instance
57 | */
58 | public MOGroup(final OID root, final SortedMap