KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > snmp4j > agent > mo > MOValueValidationListener


1 /*_############################################################################
2   _##
3   _## SNMP4J-Agent - MOValueValidationListener.java
4   _##
5   _## Copyright (C) 2005-2007 Frank Fock (SNMP4J.org)
6   _##
7   _## Licensed under the Apache License, Version 2.0 (the "License");
8   _## you may not use this file except in compliance with the License.
9   _## You may obtain a copy of the License at
10   _##
11   _## http://www.apache.org/licenses/LICENSE-2.0
12   _##
13   _## Unless required by applicable law or agreed to in writing, software
14   _## distributed under the License is distributed on an "AS IS" BASIS,
15   _## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   _## See the License for the specific language governing permissions and
17   _## limitations under the License.
18   _##
19   _##########################################################################*/

20
21
22 package org.snmp4j.agent.mo;
23
24 import java.util.EventListener JavaDoc;
25 // For JavaDOC:
26
import org.snmp4j.mp.SnmpConstants;
27
28 /**
29  * <code>MOValueValidationListener</code>s are able to validate SNMP values
30  * against certain criteria, for example MIB definition constraints.
31  *
32  * @author Frank Fock
33  * @version 1.0
34  */

35 public interface MOValueValidationListener extends EventListener JavaDoc {
36
37   /**
38    * Validates a value by returning a SNMP error code if validation fails
39    * or 0 ({@link SnmpConstants#SNMP_ERROR_SUCCESS}) if the validation was
40    * successful. The validation is returned by calling the
41    * {@link MOValueValidationEvent#setValidationStatus} method. If an error
42    * occured the returned status value should be one of the following values:
43    * <ul>
44    * <li>{@link SnmpConstants#SNMP_ERROR_WRONG_LENGTH}</li>
45    * <li>{@link SnmpConstants#SNMP_ERROR_WRONG_VALUE}</li>
46    * <li>{@link SnmpConstants#SNMP_ERROR_WRONG_TYPE}</li>
47    * <li>{@link SnmpConstants#SNMP_ERROR_WRONG_ENCODING}</li>
48    * <li>{@link SnmpConstants#SNMP_ERROR_BAD_VALUE}</li>
49    * </ul>
50    *
51    * @param validationEvent
52    * the <code>MOValueValidationEvent</code> containing the value to
53    * validate.
54    */

55   void validate(MOValueValidationEvent validationEvent);
56
57 }
58
Popular Tags