fix warnings and findbugs hints
[captive-validator.git] / src / com / verisign / tat / dnssec / SecurityStatus.java
1 /***************************** -*- Java -*- ********************************\
2  *                                                                         *
3  *   Copyright (c) 2009 VeriSign, Inc. All rights reserved.                *
4  *                                                                         *
5  * This software is provided solely in connection with the terms of the    *
6  * license agreement.  Any other use without the prior express written     *
7  * permission of VeriSign is completely prohibited.  The software and      *
8  * documentation are "Commercial Items", as that term is defined in 48     *
9  * C.F.R.  section 2.101, consisting of "Commercial Computer Software" and *
10  * "Commercial Computer Software Documentation" as such terms are defined  *
11  * in 48 C.F.R. section 252.227-7014(a)(5) and 48 C.F.R. section           *
12  * 252.227-7014(a)(1), and used in 48 C.F.R. section 12.212 and 48 C.F.R.  *
13  * section 227.7202, as applicable.  Pursuant to the above and other       *
14  * relevant sections of the Code of Federal Regulations, as applicable,    *
15  * VeriSign's publications, commercial computer software, and commercial   *
16  * computer software documentation are distributed and licensed to United  *
17  * States Government end users with only those rights as granted to all    *
18  * other end users, according to the terms and conditions contained in the *
19  * license agreement(s) that accompany the products and software           *
20  * documentation.                                                          *
21  *                                                                         *
22 \***************************************************************************/
23
24 package com.verisign.tat.dnssec;
25
26 import java.io.Serializable;
27
28 /**
29  * Codes for DNSSEC security statuses.
30  * 
31  * @author davidb
32  */
33 public class SecurityStatus implements Serializable {
34     private static final long serialVersionUID = 1L;
35
36     public static final byte INVALID = -1;
37
38     /**
39      * UNCHECKED means that object has yet to be validated.
40      */
41     public static final byte UNCHECKED = 0;
42
43     /**
44      * BOGUS means that the object (RRset or message) failed to validate
45      * (according to local policy), but should have validated.
46      */
47     public static final byte BOGUS = 1;
48
49     /**
50      * BAD is a synonym for BOGUS.
51      */
52     public static final byte BAD = BOGUS;
53
54     /**
55      * INDTERMINATE means that the object is insecure, but not authoritatively
56      * so. Generally this means that the RRset is not below a configured trust
57      * anchor.
58      */
59     public static final byte INDETERMINATE = 2;
60
61     /**
62      * INSECURE means that the object is authoritatively known to be insecure.
63      * Generally this means that this RRset is below a trust anchor, but also
64      * below a verified, insecure delegation.
65      */
66     public static final byte INSECURE = 3;
67
68     /**
69      * SECURE means that the object (RRset or message) validated according to
70      * local policy.
71      */
72     public static final byte SECURE = 4;
73     private byte status;
74
75     public SecurityStatus() {
76         status = UNCHECKED;
77     }
78
79     public SecurityStatus(byte status) {
80         setStatus(status);
81     }
82
83     public static String string(int status) {
84         switch (status) {
85         case INVALID:
86             return "Invalid";
87
88         case BOGUS:
89             return "Bogus";
90
91         case SECURE:
92             return "Secure";
93
94         case INSECURE:
95             return "Insecure";
96
97         case INDETERMINATE:
98             return "Indeterminate";
99
100         case UNCHECKED:
101             return "Unchecked";
102
103         default:
104             return "UNKNOWN";
105         }
106     }
107
108     public byte getStatus() {
109         return status;
110     }
111
112     public void setStatus(byte status) {
113         this.status = status;
114     }
115 }