org.snmp4j.agent.mo.snmp.Enumerated Maven / Gradle / Ivy
/*_############################################################################
_##
_## SNMP4J-Agent 3 - Enumerated.java
_##
_## Copyright (C) 2005-2018 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;
import org.snmp4j.agent.mo.MOMutableColumn;
import org.snmp4j.agent.MOAccess;
import org.snmp4j.smi.Variable;
import org.snmp4j.smi.SMIConstants;
import org.snmp4j.smi.Integer32;
import org.snmp4j.mp.SnmpConstants;
import org.snmp4j.agent.mo.snmp.smi.EnumerationConstraint;
import org.snmp4j.smi.OctetString;
/**
* The Enumerated class represents enumerated SMI INTEGER
* (={@link Integer32}) or an OCTET STRING with enumerated named bits for
* columnar objects. The latter represents the SMI construct BITS.
*
* @author Frank Fock
* @version 2.0.5
*/
public class Enumerated extends MOMutableColumn {
private EnumerationConstraint constraint;
/**
* Creates an enumerated INTEGER or BITS column with specifying a set of possible
* values.
* @param columnID
* the column ID (sub-identifier) of the column.
* @param access
* the maximum access for this column.
* @param defaultValue
* the default value used for new rows (must not be null for INTEGER enumerations). This value
* also defines the syntax of the column.
* @param mutableInService
* specifies whether this column can be changed while in service (active).
* @param allowedValues
* an array of possible values for this object.
* @deprecated
* As this version of the constructor does not safely define the column syntax if the defaultValue is null,
* use {@link #Enumerated(int, int, org.snmp4j.agent.MOAccess, org.snmp4j.smi.Variable, boolean, int[])} instead.
*/
@Deprecated
public Enumerated(int columnID,
MOAccess access,
V defaultValue,
boolean mutableInService,
int[] allowedValues) {
super(columnID, (defaultValue instanceof Integer32) ? SMIConstants.SYNTAX_INTEGER : SMIConstants.SYNTAX_OCTET_STRING,
access, defaultValue, mutableInService);
this.constraint = new EnumerationConstraint(allowedValues);
}
/**
* Creates an enumerated INTEGER or BITS column. To constraint the possible values
* assignable to this object, you will have to set the corresponding
* {@link EnumerationConstraint} with {@link #setConstraint} or use an
* appropriate value validation listener.
* @param columnID
* the column ID (sub-identifier) of the column.
* @param access
* the maximum access for this column.
* @param defaultValue
* the default value used for new rows (must not be null for INTEGER enumerations). This value
* also defines the syntax of the column.
* @param mutableInService
* specifies whether this column can be changed while in service (active).
* @deprecated
* As this version of the constructor does not safely define the column syntax if the defaultValue is null,
* use {@link #Enumerated(int, int, org.snmp4j.agent.MOAccess, org.snmp4j.smi.Variable, boolean)} instead.
*/
@Deprecated
public Enumerated(int columnID,
MOAccess access,
V defaultValue,
boolean mutableInService) {
super(columnID, (defaultValue instanceof Integer32) ? SMIConstants.SYNTAX_INTEGER : SMIConstants.SYNTAX_OCTET_STRING,
access, defaultValue, mutableInService);
}
/**
* Creates an enumerated INTEGER column. To constraint the possible values
* assignable to this object, you will have to set the corresponding
* {@link EnumerationConstraint} with {@link #setConstraint} or use an
* appropriate value validation listener.
* @param columnID
* the column ID (sub-identifier) of the column.
* @param access
* the maximum access for this column.
* @param defaultValue
* the default value used for new rows (must not be null for INTEGER enumerations). This value
* also defines the syntax of the column.
* @deprecated
* As this version of the constructor does not safely define the column syntax if the defaultValue is null,
* use {@link #Enumerated(int, int, org.snmp4j.agent.MOAccess, org.snmp4j.smi.Variable)} instead.
*/
@Deprecated
public Enumerated(int columnID,
MOAccess access,
V defaultValue) {
super(columnID, SMIConstants.SYNTAX_INTEGER,
access, defaultValue);
}
/**
* Creates an enumerated INTEGER or BITS column with specifying a set of possible
* values.
* @param columnID
* the column ID (sub-identifier) of the column.
* @param smiSyntax
* the smiSyntax for this column, which can be {@link SMIConstants#SYNTAX_INTEGER32} or
* {@link SMIConstants#SYNTAX_OCTET_STRING}.
* @param access
* the maximum access for this column.
* @param defaultValue
* the default value used for new rows (must not be null for INTEGER enumerations). This value
* also defines the syntax of the column.
* @param mutableInService
* specifies whether this column can be changed while in service (active).
* @param allowedValues
* an array of possible values for this object.
*/
public Enumerated(int columnID,
int smiSyntax,
MOAccess access,
V defaultValue,
boolean mutableInService,
int[] allowedValues) {
super(columnID, smiSyntax, access, defaultValue, mutableInService);
checkSmiSyntax(smiSyntax);
this.constraint = new EnumerationConstraint(allowedValues);
}
/**
* Creates an enumerated INTEGER or BITS column. To constraint the possible values
* assignable to this object, you will have to set the corresponding
* {@link EnumerationConstraint} with {@link #setConstraint} or use an
* appropriate value validation listener.
* @param columnID
* the column ID (sub-identifier) of the column.
* @param smiSyntax
* the smiSyntax for this column, which can be {@link SMIConstants#SYNTAX_INTEGER32} or
* {@link SMIConstants#SYNTAX_OCTET_STRING}.
* @param access
* the maximum access for this column.
* @param defaultValue
* the default value used for new rows (must not be null for INTEGER enumerations). This value
* also defines the syntax of the column.
* @param mutableInService
* specifies whether this column can be changed while in service (active).
*/
public Enumerated(int columnID,
int smiSyntax,
MOAccess access,
V defaultValue,
boolean mutableInService) {
super(columnID, smiSyntax, access, defaultValue, mutableInService);
checkSmiSyntax(smiSyntax);
}
/**
* Creates an enumerated INTEGER column. To constraint the possible values
* assignable to this object, you will have to set the corresponding
* {@link EnumerationConstraint} with {@link #setConstraint} or use an
* appropriate value validation listener.
* @param columnID
* the column ID (sub-identifier) of the column.
* @param smiSyntax
* the smiSyntax for this column, which can be {@link SMIConstants#SYNTAX_INTEGER32} or
* {@link SMIConstants#SYNTAX_OCTET_STRING}.
* @param access
* the maximum access for this column.
* @param defaultValue
* the default value used for new rows (must not be null for INTEGER enumerations). This value
* also defines the syntax of the column.
*/
public Enumerated(int columnID,
int smiSyntax,
MOAccess access,
V defaultValue) {
super(columnID, smiSyntax, access, defaultValue);
checkSmiSyntax(smiSyntax);
}
private void checkSmiSyntax(int smiSyntax) {
if ((smiSyntax != SMIConstants.SYNTAX_INTEGER32) && (smiSyntax != SMIConstants.SYNTAX_OCTET_STRING)) {
throw new IllegalArgumentException("Unsupported SMI syntax");
}
}
public synchronized int validate(V newValue, V oldValue) {
int result = super.validate(newValue, oldValue);
if ((constraint != null) &&
(result == SnmpConstants.SNMP_ERROR_SUCCESS)) {
return constraint.validate(newValue);
}
return result;
}
protected void setConstraint(EnumerationConstraint constraint) {
this.constraint = constraint;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy