org.snmp4j.agent.mo.snmp.tc.TruthValueTC Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of snmp4j-agent Show documentation
SNMP-Agent API for Java
There is a newer version: 3.8.1
/*_############################################################################
  _## 
  _##  SNMP4J-Agent 3 - TruthValueTC.java  
  _## 
  _##  Copyright (C) 2005-2021  Frank Fock (SNMP4J.org)
  _##  
  _##  Licensed under the Apache License, Version 2.0 (the "License");
  _##  you may not use this file except in compliance with the License.
  _##  You may obtain a copy of the License at
  _##  
  _##      http://www.apache.org/licenses/LICENSE-2.0
  _##  
  _##  Unless required by applicable law or agreed to in writing, software
  _##  distributed under the License is distributed on an "AS IS" BASIS,
  _##  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  _##  See the License for the specific language governing permissions and
  _##  limitations under the License.
  _##  
  _##########################################################################*/


package org.snmp4j.agent.mo.snmp.tc;

import org.snmp4j.agent.MOAccess;
import org.snmp4j.agent.mo.MOColumn;
import org.snmp4j.agent.mo.MOMutableColumn;
import org.snmp4j.agent.mo.MOScalar;
import org.snmp4j.agent.mo.snmp.smi.EnumerationConstraint;
import org.snmp4j.agent.mo.snmp.smi.ValueConstraintValidator;
import org.snmp4j.mp.SnmpConstants;
import org.snmp4j.smi.Integer32;
import org.snmp4j.smi.OID;
import org.snmp4j.smi.SMIConstants;

/**
 * TruthValueTC implements the TruthValue Textual Convention from RFC
 */
public class TruthValueTC implements TextualConvention {

    public static final int TRUE = 1;
    public static final int FALSE = 2;

    private EnumerationConstraint constraint =
            new EnumerationConstraint(new int[]{TRUE, FALSE});

    public TruthValueTC() {
    }

    public MOColumn createColumn(int columnID, int syntax, MOAccess access, Integer32 defaultValue,
                                            boolean mutableInService) {
        MOColumn c;
        if (access.isAccessibleForWrite()) {
            c = new MOMutableColumn(columnID, SMIConstants.SYNTAX_INTEGER32,
                    access, defaultValue);
            ((MOMutableColumn) c).addMOValueValidationListener(
                    new ValueConstraintValidator(constraint));
        } else {
            c = new MOColumn(columnID, SMIConstants.SYNTAX_INTEGER32, access);
        }
        return c;
    }

    public MOScalar createScalar(OID oid, MOAccess access, Integer32 value) {
        MOScalar scalar =
                new MOScalar(oid, access, (value == null) ? createInitialValue() : value);
        if (constraint.validate(scalar.getValue()) !=
                SnmpConstants.SNMP_ERROR_SUCCESS) {
            throw new IllegalArgumentException("Illegal TruthValue " + value);
        }
        scalar.
                addMOValueValidationListener(new ValueConstraintValidator(constraint));
        return scalar;
    }

    public String getModuleName() {
        return "SNMPv2-TC";
    }

    public String getName() {
        return "TruthValue";
    }

    public static Integer32 getValue(boolean b) {
        return (b) ? new Integer32(TRUE) : new Integer32(FALSE);
    }

    public Integer32 createInitialValue() {
        return new Integer32(FALSE);
    }

    /**
     * Gets the boolean value of a TruthValue variable.
     *
     * @param truthValue
     *         a TruthValue.
     *
     * @return true if truthValue equals
     * {@link #TRUE}.
     * @since 2.0
     */
    public static boolean getBooleanValue(Integer32 truthValue) {
        return (TRUE == truthValue.getValue());
    }
}