KeyChainSet.java
| Index Score | ||
|---|---|---|
 |
 |
eclipseme.core.internal.signing |
 |
 |
EclipseME |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| JAVA0034 | JAVA0034 Missing braces in if statement |  |
| COMMENTS | Comment lines | |
| BLOCK_COMMENT | Number of block comment lines | |
| SIZE | Size of the file in bytes | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0112 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LINE_COMMENT | Number of line comments | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0109 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| COMPARISONS | Number of comparison operators | |
| WHITESPACE | Number of whitespace lines | |
| FUNCTIONS | Number of function declarations | |
| EXITS | Procedure exits | |
| JAVA0256 | JAVA0256 Assignment of external collection/array to field | |
| CYCLOMATIC | Cyclomatic complexity | |
| ELOC | Effective lines of code | |
/*
********************************************************************
*
* File : KeyChainSet.java
* Package : eclipseme.core.internal.signing
* System : eclipseme.core
* Author : Kevin Hunter
* Description : This class manages the private key and certificate
* used to sign a MIDlet suite.
*
* Copyright (c) 2004 Kevin Hunter
* All Rights Reserved.
* Licensed under the Eclipse Public License - v 1.0
* For more information see http://www.eclipse.org/legal/epl-v10.html
*
*
* CVS
* $$Source: /cvsroot/eclipseme/eclipseme.core/src/eclipseme/core/internal/signing/KeyChainSet.java,v $$
* $$Author: kdhunter $$
* $$Date: 2004/12/07 02:42:54 $$
* $$Revision: 1.4 $$
*
********************************************************************
*/
package eclipseme.core.internal.signing;
import java.io.IOException;
import java.io.InputStream;
import java.security.Key;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.NoSuchProviderException;
import java.security.Principal;
import java.security.PrivateKey;
import java.security.UnrecoverableKeyException;
import java.security.cert.Certificate;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import org.eclipse.core.runtime.CoreException;
import eclipseme.core.EclipseMECoreErrors;
/**
* KeyChainSet
*
* This class manages a PrivateKey and an optional associated X509
* certificate chain. This class handles all the work of loading
* the key and the certificate chain from a keystore. Instances of
* this class cannot be created directly - the <code>getInstance</code>
* factory functions have to be used to load the contained data from
* a keystore.
*
* <p>Note that,
* to make things easier for the code using this class, all low-level
* exceptions that the crypto classes can throw are wrapped in
* an instance of <code>KeyChainSetException</code>.</p>
*
*/
public class KeyChainSet
{
private PrivateKey m_key; // key used for signing
private X509Certificate[] m_certChain; // certificate chain for key
private String m_strProvider; // optional provider for crypto classes
/**
* This constructor is private so that one is forced to obtain
* an instance of KeyChainSet using the factory functions.
*
* @param key Instance of <code>PrivateKey</code> that will
* be used to sign the MIDlet suite.
* @param certChain Array of <code>X509Certificate</code> objects
* that provide the validation certificate chain
* for <code>key</code>.
*/
private KeyChainSet(PrivateKey key, X509Certificate[] certChain, String strProvider)
{
m_key = key;
m_certChain = certChain;
m_strProvider = strProvider;
}
/**
* Returns the <code>PrivateKey</code> managed by this object.
*
* @return An instance of <code>java.security.PrivateKey</code>. This is
* guaranteed not to be null.
*/
public PrivateKey getKey()
{
return(m_key);
}
/**
* Returns the (optional) <code>X509Certificate</code> chain managed
* by this object. If a chain is present, the first entry in the array
* will be the certificate for the associated <code>PrivateKey</code>,
* and subsequent entries in the chain will be "parent" certificates,
* tracing back to the root certificate.
*
* @return Array of <code>java.security.cert.X509Certificate</code>
* objects. May be null.
*/
public X509Certificate[] getCertificateChain()
{
return(m_certChain);
}
/**
* Returns the (optional) provider string. Will be <code>null</code>
* if the system default provider is being used.
*
* @return
*/
public String getProvider()
{
return(m_strProvider);
}
/**
* Creates a <code>KeyChainSet</code> object from the specified keystore
* stream, loading the key specified by <code>strKeyAlias</code>
*
* @param isKeyStore <code>InputStream</code> containing the
* keystore from which the key is to be loaded.
* @param strKeyStorePass Password for the keystore as a whole.
* @param strKeyAlias Alias identifying the key within the keystore
* @param strKeyPass Password for the specific key.
* @return <code>KeyChainSet</code> containing the private key identified by
* <code>strKeyAlias</code> along with the matching certificate chain,
* if it is present.
*
* @throws KeyChainSetException
* @throws IOException
*/
public static KeyChainSet getInstance( InputStream keyStoreStream,
String strKeyStorePass,
String strKeyAlias,
String strKeyPass)
throws CoreException
{
return(getInstance(keyStoreStream, null, null, strKeyStorePass, strKeyAlias, strKeyPass));
}
/**
* Creates a <code>KeyChainSet</code> object from the specified keystore
* stream, loading the key specified by <code>strKeyAlias</code>. This version
* of the factory function allows non-default keystore types and keystore
* providers to be specified.
*
* @param isKeyStore <code>InputStream</code> containing the
* keystore from which the key is to be loaded.
* @param strKeyStoreType String identifying the particular keystore type
* being accessed. If <code>null</code>, the system
* default keystore type is assumed.
* @param strKeyStoreProvider String identifying the particular keystore provider.
* If <code>null</code>, the preferred implementation for
* the specified type will be used.
* @param strKeyStorePass Password for the keystore as a whole.
* @param strKeyAlias Alias identifying the key within the keystore
* @param strKeyPass Password for the specific key.
* @return <code>KeyChainSet</code> containing the private key identified by
* <code>strKeyAlias</code> along with the matching certificate chain,
* if it is present.
*
* @throws KeyChainSetException
* @throws IOException
*/
public static KeyChainSet getInstance( InputStream keyStoreStream,
String strKeyStoreType,
String strKeyStoreProvider,
String strKeyStorePass,
String strKeyAlias,
String strKeyPass)
throws CoreException
{
KeyStore store = null;
PrivateKey theKey = null;
X509Certificate[] orderedCertChain = null;
if (strKeyStoreProvider != null)
{
if (strKeyStoreProvider.length() == 0)
{
strKeyStoreProvider = null;
}
}
if (strKeyStoreType != null)
{
if (strKeyStoreType.length() == 0)
{
strKeyStoreType = null;
}
}
try
{
/*
* "null" is allowed for the key store type. In that case,
* we simply use the default key store type, which is "jks"
* for most JRE's. (This is the Sun default keystore type)
*/
if (strKeyStoreType == null)
{
strKeyStoreType = KeyStore.getDefaultType();
}
/*
* "null" is also allowed for the provider. It is possible
* to register non-default providers (e.g. bouncycastle) by
* configuring the JDK or JRE appropriately. This operation
* can throw a KeyStoreException if the key store type is
* not available. The second form can also thow a
* NoSuchProviderException.
*/
if (strKeyStoreProvider == null)
{
store = KeyStore.getInstance(strKeyStoreType);
}
else
{
store = KeyStore.getInstance(strKeyStoreType, strKeyStoreProvider);
}
/*
* Load the keystore data. This can throw an IOException, if the
* keystore file isn't validly formed, a NoSuchAlgorithmException
* if the algorithm used to check the integrity of the keystore
* can't be found, or a CertificateException if any of the certificates
* in the store can't be loaded.
*/
store.load(keyStoreStream, strKeyStorePass.toCharArray());
/*
* Load the key. This will return "null" if the key alias doesn't
* exist or doesn't reference a key. It will throw an UnrecoverableKeyException
* if the wrong password is provided, a NoSuchAlgorithmException if the
* algorithm for recovering the key cannot be found. In addition, the
* signature specifies that it could throw a KeyStoreException if the
* store wasn't initialized, but that shouldn't happen for us.
*/
Key k = store.getKey(strKeyAlias, strKeyPass.toCharArray());
if (k == null)
{
EclipseMECoreErrors.throwCoreExceptionError(EclipseMECoreErrors.SIGNING_KEY_NOT_FOUND);
}
if (!(k instanceof PrivateKey))
{
EclipseMECoreErrors.throwCoreExceptionError(EclipseMECoreErrors.SIGNING_BAD_KEY_TYPE);
}
theKey = (PrivateKey)k;
/*
* At this point, we've recovered the key, now try to recover the
* certificate chain. We will get null back from both of these
* if there isn't a certificate associated with the key.
*/
Certificate[] rawChain = store.getCertificateChain(strKeyAlias);
Certificate rawCert = store.getCertificate(strKeyAlias);
if (rawChain != null && rawCert != null)
{
/*
* Make sure we're dealing with X509Certificate instances
*/
if (!(rawCert instanceof X509Certificate))
{
EclipseMECoreErrors.throwCoreExceptionError(EclipseMECoreErrors.SIGNING_INVALID_CERTIFICATE_CHAIN);
}
X509Certificate baseCert = (X509Certificate)rawCert;
X509Certificate[] certChain = new X509Certificate[rawChain.length];
int i;
for (i = 0; i < rawChain.length; i++)
{
if (rawChain[i] instanceof X509Certificate)
{
certChain[i] = (X509Certificate)rawChain[i];
}
else
{
EclipseMECoreErrors.throwCoreExceptionError(EclipseMECoreErrors.SIGNING_INVALID_CERTIFICATE_CHAIN);
}
}
/*
* Apparently, judging from other code I've seen, if there's a
* multi-certificate chain, the chain members might not be returned
* in the correct order. This code will reorder the items in
* the certificate chain so that each certificate is immediately
* followed by its "parent" certificate.
*/
if (certChain[0].equals(baseCert))
{
orderedCertChain = certChain;
}
else
{
orderedCertChain = new X509Certificate[rawChain.length];
orderedCertChain[0] = baseCert;
for (i = 1; i < rawChain.length; i++)
{
orderedCertChain[i] = findParentCertificate(orderedCertChain[i-1], certChain);
if (orderedCertChain[i] == null)
{
EclipseMECoreErrors.throwCoreExceptionError(EclipseMECoreErrors.SIGNING_INVALID_CERTIFICATE_CHAIN);
}
}
}
}
}
catch(IOException ioe)
{
EclipseMECoreErrors.throwCoreExceptionError(EclipseMECoreErrors.SIGNING_BAD_KEYSTORE_OR_PASSWORD);
}
catch(KeyStoreException kse)
{
EclipseMECoreErrors.throwCoreExceptionError(EclipseMECoreErrors.SIGNING_KEYSTORE_TYPE_NOT_AVAILABLE, kse);
}
catch(NoSuchProviderException nspe)
{
EclipseMECoreErrors.throwCoreExceptionError(EclipseMECoreErrors.SIGNING_PROVIDER_NOT_CONFIGURED, nspe);
}
catch(NoSuchAlgorithmException nsae)
{
EclipseMECoreErrors.throwCoreExceptionError(EclipseMECoreErrors.SIGNING_MISSING_KEYSTORE_INTEGRITY_ALGORITHM, nsae);
}
catch(CertificateException ce)
{
EclipseMECoreErrors.throwCoreExceptionError(EclipseMECoreErrors.SIGNING_COULDNT_LOAD_CERTIFICATE, ce);
}
catch(UnrecoverableKeyException uke)
{
EclipseMECoreErrors.throwCoreExceptionError(EclipseMECoreErrors.SIGNING_INVALID_KEY_PASSWORD, uke);
}
KeyChainSet kcs = new KeyChainSet(theKey, orderedCertChain, strKeyStoreProvider);
return(kcs);
}
/**
* This routine searches a certificate array to find the certificate
* that is the "parent" for a particular certificate. Note that, as a side
* effect, the "parent" entry in the array is "nulled out" to improve
* performance during the operation.
*
* @param child The certificate whose parent is to be found.
* @param chain The certificate array to be searched.
* @return The parent certificate, or <code>null</code> if one cannot be found.
* (Indicates an error).
*/
private static X509Certificate findParentCertificate(X509Certificate child, X509Certificate[] chain)
{
Principal issuer = child.getIssuerDN();
X509Certificate retval = null;
for (int i = 0; i < chain.length; i++)
{
if (chain[i] != null)
{
Principal certDN = chain[i].getSubjectDN();
if (certDN.equals(issuer))
{
retval = chain[i];
chain[i] = null;
break;
}
}
}
return(retval);
}
/**
* Sets the <code>PrivateKey</code> managed by this object. Primarily included
* for unit testing purposes - under normal circumstances, the key should only
* be set via the <code>getInstance</code> methods.
*
* @param value
*/
/*package*/ void setKey(PrivateKey value)
{
m_key = value;
}
/**
* Sets the certificate chain managed by this object. Primarily included
* for unit testing purposes - under normal circumstances, the key should only
* be set via the <code>getInstance</code> methods.
*
* @param value
*/
/*package*/ void setCertificateChain(X509Certificate[] value)
{
m_certChain = value;
}
/**
* Sets the provider string managed by this object. Primarily included
* for unit testing purposes - under normal circumstances, the key should only
* be set via the <code>getInstance</code> methods.
*
* @param value
*/
/*package*/ void setProvider(String value)
{
m_strProvider = value;
}
}
/*
********************************************************************
* CVS History:
* $$Log: KeyChainSet.java,v $
* $Revision 1.4 2004/12/07 02:42:54 kdhunter
* $Switched from custom exception classes to CoreException
* $in signing routines.
* $Set up basic error code and error message handling, including
* $prep for internationalization
* $
* $Revision 1.3 2004/11/27 21:13:54 kdhunter
* $Handle case when empty strings get passed instead of nulls
* $
* $Revision 1.2 2004/11/26 20:53:26 kdhunter
* $Added package access methods for unit test purposes
* $
* $Revision 1.1 2004/11/26 14:59:22 kdhunter
* $Moved here from original "external" package
* $$
*
********************************************************************
*/
The table below shows all metrics for KeyChainSet.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 38.00 | Number of blocks | |
| BLOCK_COMMENT | 89.00 | Number of block comment lines | |
| COMMENTS | 209.00 | Comment lines | |
| COMMENT_DENSITY | 1.76 | Comment density | |
| COMPARISONS | 16.00 | Number of comparison operators | |
| CYCLOMATIC | 35.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 13.00 | Comments in declarations | |
| DOC_COMMENT | 120.00 | Number of javadoc comment lines | |
| ELOC | 119.00 | Effective lines of code | |
| EXEC_COMMENTS | 7.00 | Comments in executable code | |
| EXITS | 17.00 | Procedure exits | |
| FUNCTIONS | 10.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 58.04 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 40.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 1.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 1.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 3.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 2.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 4.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 2.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 0.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 1.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 624.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 1.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 2.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 446.00 | Number of lines in the source file | |
| LINE_COMMENT | 0.00 | Number of line comments | |
| LOC | 197.00 | Lines of code | |
| LOGICAL_LINES | 76.00 | Number of statements | |
| LOOPS | 3.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 345.00 | Number of operands | |
| OPERATORS | 605.00 | Number of operators | |
| PARAMS | 18.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 950.00 | Halstead program length | |
| PROGRAM_VOCAB | 143.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 22.00 | Number of return points from functions | |
| SIZE | 15990.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 107.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 36.00 | Number of unique operators | |
| WHITESPACE | 40.00 | Number of whitespace lines | |