AttributeManager.java
| Index Score | ||
|---|---|---|
 |
 |
com.zimbra.cs.account |
 |
 |
Zimbra Collaboration Suite |
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 | |
|---|---|---|
| EXITS | Procedure exits |  |
| UNIQUE_OPERANDS | Number of unique operands | |
| COMPARISONS | Number of comparison operators | |
| OPERANDS | Number of operands | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| CYCLOMATIC | Cyclomatic complexity | |
| BLOCKS | Number of blocks | |
| LOGICAL_LINES | Number of statements | |
| SIZE | Size of the file in bytes | |
| ELOC | Effective lines of code | |
| LOC | Lines of code | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| PARAMS | Number of formal parameter declarations | |
| LOOPS | Number of loops | |
| LINES | Number of lines in the source file | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0269 | JAVA0269 Contents of StringBuffer never used | |
| RETURNS | Number of return points from functions | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0285 | JAVA0285 Dereference of potentially null variable | |
| EXEC_COMMENTS | Comments in executable code | |
| FUNCTIONS | Number of function declarations | |
| LINE_COMMENT | Number of line comments | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0040 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0125 | JAVA0125 Continue statement with label | |
| JAVA0282 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0032 | JAVA0032 Switch statement missing default | |
| JAVA0138 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0265 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0029 | JAVA0029 Private method not used | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| DECL_COMMENTS | Comments in declarations | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| COMMENTS | Comment lines | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.1 ("License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.zimbra.com/license
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is: Zimbra Collaboration Suite Server.
*
* The Initial Developer of the Original Code is Zimbra, Inc.
* Portions created by Zimbra are Copyright (C) 2005, 2006 Zimbra, Inc.
* All Rights Reserved.
*
* Contributor(s):
*
* ***** END LICENSE BLOCK *****
*/
package com.zimbra.cs.account;
import com.zimbra.common.localconfig.LC;
import com.zimbra.common.service.ServiceException;
import com.zimbra.cs.account.ldap.LdapUtil;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.GnuParser;
import org.apache.commons.cli.HelpFormatter;
import org.apache.commons.cli.Option;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
import com.zimbra.common.util.*;
import org.dom4j.Attribute;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
import javax.naming.NameClassPair;
import javax.naming.NamingEnumeration;
import javax.naming.NamingException;
import javax.naming.directory.Attributes;
import javax.naming.directory.DirContext;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
public class AttributeManager {
private static final String E_ATTRS = "attrs";
private static final String A_GROUP = "group";
private static final String A_GROUP_ID = "groupid";
private static final String E_ATTR = "attr";
private static final String A_NAME = "name";
private static final String A_IMMUTABLE = "immutable";
private static final String A_TYPE = "type";
private static final String A_ORDER = "order";
private static final String A_VALUE = "value";
private static final String A_MAX = "max";
private static final String A_MIN = "min";
private static final String A_CALLBACK = "callback";
private static final String A_ID = "id";
private static final String A_PARENT_OID = "parentOid";
private static final String A_CARDINALITY = "cardinality";
private static final String A_REQUIRED_IN = "requiredIn";
private static final String A_OPTIONAL_IN = "optionalIn";
private static final String A_FLAGS = "flags";
private static final String E_DESCRIPTION = "desc";
private static final String E_GLOBAL_CONFIG_VALUE = "globalConfigValue";
private static final String E_DEFAULT_COS_VALUE = "defaultCOSValue";
private static AttributeManager mInstance;
private Map<String, AttributeInfo> mAttrs = new HashMap<String, AttributeInfo>();
private static Map<Integer,String> mGroupMap = new HashMap<Integer,String>();
public static AttributeManager getInstance() throws ServiceException {
synchronized(AttributeManager.class) {
if (mInstance != null) {
return mInstance;
}
String dir = LC.zimbra_attrs_directory.value();
mInstance = new AttributeManager(dir);
if (mInstance.hasErrors()) {
throw ServiceException.FAILURE(mInstance.getErrors(), null);
}
return mInstance;
}
}
private AttributeManager(String dir) throws ServiceException {
initFlagsToAttrsMap();
initClassToAttrsMap();
File fdir = new File(dir);
if (!fdir.exists()) {
throw ServiceException.FAILURE("attrs directory does not exists: " + dir, null);
}
if (!fdir.isDirectory()) {
throw ServiceException.FAILURE("attrs directory is not a directory: " + dir, null);
}
File[] files = fdir.listFiles();
for (File file : files) {
if (!file.getPath().endsWith(".xml")) {
ZimbraLog.misc.warn("while loading attrs, ignoring not .xml file: " + file);
continue;
}
if (!file.isFile()) {
ZimbraLog.misc.warn("while loading attrs, ignored non-file: " + file);
}
try {
loadAttrs(file);
} catch (DocumentException de) {
throw ServiceException.FAILURE("error loading attrs file: " + file, de);
}
}
}
private List<String> mErrors = new LinkedList<String>();
private boolean hasErrors() {
return mErrors.size() > 0;
}
private String getErrors() {
StringBuilder result = new StringBuilder();
for (String error : mErrors) {
result.append(error).append("\n");
}
return result.toString();
}
private void error(String attrName, File file, String error) {
if (attrName != null) {
mErrors.add("attr " + attrName + " in file " + file + ": " + error);
} else {
mErrors.add("file " + file + ": " + error);
}
}
private void loadAttrs(File file) throws DocumentException {
SAXReader reader = new SAXReader();
Document doc = reader.read(file);
Element root = doc.getRootElement();
if (!root.getName().equals(E_ATTRS)) {
error(null, file, "root tag is not " + E_ATTRS);
return;
}
String group = root.attributeValue(A_GROUP);
String groupIdStr = root.attributeValue(A_GROUP_ID);
if (group == null ^ groupIdStr == null) {
error(null, file, A_GROUP + " and " + A_GROUP_ID + " both have to be both specified");
}
int groupId = -1;
if (group != null) {
try {
groupId = Integer.valueOf(groupIdStr);
} catch (NumberFormatException nfe) {
error(null, file, A_GROUP_ID + " is not a number: " + groupIdStr);
}
}
if (groupId == 2) {
error(null, file, A_GROUP_ID + " is not valid (used by ZimbraObjectClass)");
} else if (groupId > 0) {
if (mGroupMap.containsKey(groupId)) {
error(null, file, "duplicate group id: " + groupId);
} else if (mGroupMap.containsValue(group)) {
error(null, file, "duplicate group: " + group);
} else {
mGroupMap.put(groupId, group);
}
}
NEXT_ATTR: for (Iterator iter = root.elementIterator(); iter.hasNext();) {
Element eattr = (Element) iter.next();
if (!eattr.getName().equals(E_ATTR)) {
error(null, file, "unknown element: " + eattr.getName());
continue;
}
AttributeCallback callback = null;
AttributeType type = null;
AttributeOrder order = null;
String value = null;
long min = Long.MIN_VALUE;
long max = Long.MAX_VALUE;
boolean immutable = false;
// boolean ignore = false;
int id = -1;
String parentOid = null;
AttributeCardinality cardinality = null;
Set<AttributeClass> requiredIn = null;
Set<AttributeClass> optionalIn = null;
Set<AttributeFlag> flags = null;
String canonicalName = null;
String name = eattr.attributeValue(A_NAME);
if (name == null) {
error(null, file, "no name specified");
continue;
}
canonicalName = name.toLowerCase();
for (Iterator attrIter = eattr.attributeIterator(); attrIter.hasNext();) {
Attribute attr = (Attribute) attrIter.next();
String aname = attr.getName();
if (aname.equals(A_NAME)) {
// nothing to do - already processed
} else if (aname.equals(A_CALLBACK)) {
callback = loadCallback(attr.getValue());
} else if (aname.equals(A_IMMUTABLE)) {
immutable = "1".equals(attr.getValue());
} else if (aname.equals(A_MAX)) {
max = AttributeInfo.parseLong(attr.getValue(), Integer.MAX_VALUE);
} else if (aname.equals(A_MIN)) {
min = AttributeInfo.parseLong(attr.getValue(), Integer.MIN_VALUE);
} else if (aname.equals(A_TYPE)) {
type = AttributeType.getType(attr.getValue());
if (type == null) {
error(name, file, "unknown <attr> type: " + attr.getValue());
continue NEXT_ATTR;
}
} else if (aname.equals(A_VALUE)) {
value = attr.getValue();
} else if (aname.equals(A_PARENT_OID)) {
parentOid = attr.getValue();
if (!parentOid.matches("^\\d+(\\.\\d+)+"))
error(name, file, "invalid parent OID " + parentOid + ": must be an OID");
} else if (aname.equals(A_ID)) {
try {
id = Integer.parseInt(attr.getValue());
if (id < 0) {
error(name, file, "invalid id " + id + ": must be positive");
}
} catch (NumberFormatException nfe) {
error(name, file, aname + " is not a number: " + attr.getValue());
}
} else if (aname.equals(A_CARDINALITY)) {
try {
cardinality = AttributeCardinality.valueOf(attr.getValue());
} catch (IllegalArgumentException iae) {
error(name, file, aname + " is not valid: " + attr.getValue());
}
} else if (aname.equals(A_REQUIRED_IN)) {
requiredIn = parseClasses(name, file, attr.getValue());
} else if (aname.equals(A_OPTIONAL_IN)) {
optionalIn = parseClasses(name, file, attr.getValue());
} else if (aname.equals(A_FLAGS)) {
flags = parseFlags(name, file, attr.getValue());
} else if (aname.equals(A_ORDER)) {
try {
order = AttributeOrder.valueOf(attr.getValue());
} catch (IllegalArgumentException iae) {
error(name, file, aname + " is not valid: " + attr.getValue());
}
} else {
error(name, file, "unknown <attr> attr: " + aname);
}
}
List<String> globalConfigValues = new LinkedList<String>();
List<String> defaultCOSValues = new LinkedList<String>();
String description = null;
for (Iterator elemIter = eattr.elementIterator(); elemIter.hasNext();) {
Element elem = (Element)elemIter.next();
if (elem.getName().equals(E_GLOBAL_CONFIG_VALUE)) {
globalConfigValues.add(elem.getText());
} else if (elem.getName().equals(E_DEFAULT_COS_VALUE)) {
defaultCOSValues.add(elem.getText());
} else if (elem.getName().equals(E_DESCRIPTION)) {
if (description != null) {
error(name, file, "more than one description");
}
description = elem.getText();
} else {
error(name, file, "unknown element: " + elem.getName());
}
}
// Check that if id is specified, then cardinality is specified.
if (id > 0 && cardinality == null) {
error(name, file, "cardinality not specified");
}
// Check that if id is specified, then atleast one object class is
// defined
if (id > 0 && (optionalIn != null && optionalIn.isEmpty()) && (requiredIn != null && requiredIn.isEmpty())) {
error(name, file, "atleast one of " + A_REQUIRED_IN + " or " + A_OPTIONAL_IN + " must be specified");
}
// Check that if it is COS inheritable it is in account and COS
// classes
checkFlag(name, file, flags, AttributeFlag.accountInherited, AttributeClass.account, AttributeClass.cos, requiredIn, optionalIn);
// Check that if it is domain inheritable it is in domain and
// account
checkFlag(name, file, flags, AttributeFlag.domainInherited, AttributeClass.account, AttributeClass.domain, requiredIn, optionalIn);
// Check that if it is domain inheritable it is in domain and
// account
checkFlag(name, file, flags, AttributeFlag.serverInherited, AttributeClass.server, AttributeClass.globalConfig, requiredIn, optionalIn);
// Check that is cardinality is single, then not more than one
// default value is specified
if (cardinality == AttributeCardinality.single) {
if (globalConfigValues.size() > 1) {
error(name, file, "more than one global config value specified for cardinality " + AttributeCardinality.single);
}
if (defaultCOSValues.size() > 1) {
error(name, file, "more than one default COS value specified for cardinality " + AttributeCardinality.single);
}
}
AttributeInfo info = new AttributeInfo(name, id, parentOid, groupId, callback, type, order, value, immutable, min, max, cardinality, requiredIn, optionalIn, flags, globalConfigValues, defaultCOSValues, description);
if (mAttrs.get(canonicalName) != null) {
error(name, file, "duplicate definiton");
}
mAttrs.put(canonicalName, info);
if (flags != null) {
for (AttributeFlag flag : flags) {
mFlagToAttrsMap.get(flag).add(name);
}
}
if (requiredIn != null || optionalIn != null) {
if (requiredIn != null) {
for (AttributeClass klass : requiredIn) {
mClassToAttrsMap.get(klass).add(name);
mClassToLowerCaseAttrsMap.get(klass).add(name.toLowerCase());
}
}
if (optionalIn != null) {
for (AttributeClass klass : optionalIn) {
mClassToAttrsMap.get(klass).add(name);
mClassToLowerCaseAttrsMap.get(klass).add(name.toLowerCase());
}
}
}
}
}
private Set<AttributeClass> parseClasses(String attrName, File file, String value) {
Set<AttributeClass> result = new HashSet<AttributeClass>();
String[] cnames = value.split(",");
for (String cname : cnames) {
try {
AttributeClass ac = AttributeClass.valueOf(cname);
if (result.contains(ac)) {
error(attrName, file, "duplicate class: " + cname);
}
result.add(ac);
} catch (IllegalArgumentException iae) {
error(attrName, file, "invalid class: " + cname);
}
}
return result;
}
private Set<AttributeFlag> parseFlags(String attrName, File file, String value) {
Set<AttributeFlag> result = new HashSet<AttributeFlag>();
String[] flags = value.split(",");
for (String flag : flags) {
try {
AttributeFlag ac = AttributeFlag.valueOf(flag);
if (result.contains(ac)) {
error(attrName, file, "duplicate flag: " + flag);
}
result.add(ac);
} catch (IllegalArgumentException iae) {
error(attrName, file, "invalid flag: " + flag);
}
}
return result;
}
private void checkFlag(String attrName, File file, Set<AttributeFlag> flags, AttributeFlag flag, AttributeClass c1, AttributeClass c2, Set<AttributeClass> required, Set<AttributeClass> optional) {
if (flags != null && flags.contains(flag)) {
boolean inC1 = (optional != null && optional.contains(c1)) || (required != null && required.contains(c1));
boolean inC2 = (optional != null && optional.contains(c2)) || (required != null && required.contains(c2));
if (!inC1 && !inC2) {
error(attrName, file, "flag " + flag + " requires that attr be in both these classes " + c1 + " and " + c2);
}
}
}
/*
* Support for lookup by class
*/
private Map<AttributeClass, Set<String>> mClassToAttrsMap = new HashMap<AttributeClass, Set<String>>();
private Map<AttributeClass, Set<String>> mClassToLowerCaseAttrsMap = new HashMap<AttributeClass, Set<String>>();
private void initClassToAttrsMap() {
for (AttributeClass klass : AttributeClass.values()) {
mClassToAttrsMap.put(klass, new HashSet<String>());
mClassToLowerCaseAttrsMap.put(klass, new HashSet<String>());
}
}
/*
* Support for lookup by flag
*/
private Map<AttributeFlag, Set<String>> mFlagToAttrsMap = new HashMap<AttributeFlag, Set<String>>();
private void initFlagsToAttrsMap() {
for (AttributeFlag flag : AttributeFlag.values()) {
mFlagToAttrsMap.put(flag, new HashSet<String>());
}
}
public boolean isAccountInherited(String attr) {
return mFlagToAttrsMap.get(AttributeFlag.accountInherited).contains(attr);
}
public boolean isDomainInherited(String attr) {
return mFlagToAttrsMap.get(AttributeFlag.domainInherited).contains(attr);
}
public boolean isServerInherited(String attr) {
return mFlagToAttrsMap.get(AttributeFlag.serverInherited).contains(attr);
}
public boolean isDomainAdminModifiable(String attr) {
return mFlagToAttrsMap.get(AttributeFlag.domainAdminModifiable).contains(attr);
}
public Set<String> getAttrsWithFlag(AttributeFlag flag) {
return mFlagToAttrsMap.get(flag);
}
public Set<String> getAttrsInClass(AttributeClass klass) {
return mClassToAttrsMap.get(klass);
}
public Set<String> getLowerCaseAttrsInClass(AttributeClass klass) {
return mClassToLowerCaseAttrsMap.get(klass);
}
public Set<String> getImmutableAttrs() {
Set<String> immutable = new HashSet<String>();
for (AttributeInfo info : mAttrs.values()) {
if (info != null && info.isImmutable())
immutable.add(info.getName());
}
return immutable;
}
public Set<String> getImmutableAttrsInClass(AttributeClass klass) {
Set<String> immutable = new HashSet<String>();
for (String attr : mClassToAttrsMap.get(klass)) {
AttributeInfo info = mAttrs.get(attr.toLowerCase());
if (info != null) {
if (info.isImmutable())
immutable.add(attr);
} else {
ZimbraLog.misc.warn("getImmutableAttrsInClass: no attribute info for: " + attr);
}
}
return immutable;
}
/**
* @param type
* @return
*/
private static AttributeCallback loadCallback(String clazz) {
AttributeCallback cb = null;
if (clazz == null)
return null;
if (clazz.indexOf('.') == -1)
clazz = "com.zimbra.cs.account.callback." + clazz;
try {
cb = (AttributeCallback) Class.forName(clazz).newInstance();
} catch (Exception e) {
ZimbraLog.misc.warn("loadCallback caught exception", e);
}
return cb;
}
public void preModify(Map<String, ? extends Object> attrs,
Entry entry,
Map context,
boolean isCreate,
boolean checkImmutable)
throws ServiceException {
preModify(attrs, entry, context, isCreate, checkImmutable, true);
}
public void preModify(Map<String, ? extends Object> attrs,
Entry entry,
Map context,
boolean isCreate,
boolean checkImmutable,
boolean allowCallback)
throws ServiceException {
String[] keys = attrs.keySet().toArray(new String[0]);
for (int i = 0; i < keys.length; i++) {
String name = keys[i];
if (name.length() == 0) {
throw AccountServiceException.INVALID_ATTR_NAME("empty attr name found", null);
}
Object value = attrs.get(name);
if (name.charAt(0) == '-' || name.charAt(0) == '+') name = name.substring(1);
AttributeInfo info = mAttrs.get(name.toLowerCase());
if (info != null) {
info.checkValue(value, checkImmutable);
if (allowCallback && info.getCallback() != null)
info.getCallback().preModify(context, name, value, attrs, entry, isCreate);
} else {
ZimbraLog.misc.warn("checkValue: no attribute info for: "+name);
}
}
}
public void postModify(Map<String, ? extends Object> attrs,
Entry entry,
Map context,
boolean isCreate) {
postModify(attrs, entry, context, isCreate, true);
}
public void postModify(Map<String, ? extends Object> attrs,
Entry entry,
Map context,
boolean isCreate,
boolean allowCallback) {
String[] keys = attrs.keySet().toArray(new String[0]);
for (int i = 0; i < keys.length; i++) {
String name = keys[i];
// Object value = attrs.get(name);
if (name.charAt(0) == '-' || name.charAt(0) == '+') name = name.substring(1);
AttributeInfo info = mAttrs.get(name.toLowerCase());
if (info != null) {
if (allowCallback && info.getCallback() != null) {
try {
info.getCallback().postModify(context, name, entry, isCreate);
} catch (Exception e) {
// need to swallow all exceptions as postModify shouldn't throw any...
ZimbraLog.account.warn("postModify caught exception: "+e.getMessage(), e);
}
}
}
}
}
private static Log mLog = LogFactory.getLog(AttributeManager.class);
private static Options mOptions = new Options();
static {
mOptions.addOption("h", "help", false, "display this usage info");
mOptions.addOption("o", "output", true, "output file (default it to generate output to stdout)");
mOptions.addOption("a", "action", true, "[generateLdapSchema | generateGlobalConfigLdif | generateDefaultCOSLdif]");
mOptions.addOption("t", "template", true, "template for LDAP schema");
Option iopt = new Option("i", "input", true,"attrs definition xml input file (can repeat)");
iopt.setArgs(Option.UNLIMITED_VALUES);
mOptions.addOption(iopt);
}
private static void usage(String errmsg) {
if (errmsg != null) {
mLog.error(errmsg);
}
HelpFormatter formatter = new HelpFormatter();
formatter.printHelp("AttributeManager [options] where [options] are one of:", mOptions);
System.exit((errmsg == null) ? 0 : 1);
}
private static CommandLine parseArgs(String args[]) {
StringBuffer gotCL = new StringBuffer("cmdline: ");
for (int i = 0; i < args.length; i++) {
gotCL.append("'").append(args[i]).append("' ");
}
//mLog.info(gotCL);
CommandLineParser parser = new GnuParser();
CommandLine cl = null;
try {
cl = parser.parse(mOptions, args);
} catch (ParseException pe) {
usage(pe.getMessage());
}
if (cl.hasOption('h')) {
usage(null);
}
return cl;
}
private enum Action { generateLdapSchema, generateGlobalConfigLdif, generateDefaultCOSLdif, dump }
public static void main(String[] args) throws IOException, ServiceException {
CliUtil.toolSetup();
CommandLine cl = parseArgs(args);
if (!cl.hasOption('a')) usage("no action specified");
String actionStr = cl.getOptionValue('a');
Action action = null;
try {
action = Action.valueOf(actionStr);
} catch (IllegalArgumentException iae) {
usage("unknown action: " + actionStr);
}
AttributeManager am = null;
if (action != Action.dump) {
if (!cl.hasOption('i')) usage("no input attribute xml files specified");
am = new AttributeManager(cl.getOptionValue('i'));
if (am.hasErrors()) {
ZimbraLog.misc.warn(am.getErrors());
System.exit(1);
}
}
OutputStream os = System.out;
if (cl.hasOption('o')) {
os = new FileOutputStream(cl.getOptionValue('o'));
}
PrintWriter pw = new PrintWriter(new BufferedWriter(new OutputStreamWriter(os, "utf8")));
switch (action) {
case generateDefaultCOSLdif:
am.generateDefaultCOSLdif(pw);
break;
case generateGlobalConfigLdif:
am.generateGlobalConfigLdif(pw);
break;
case generateLdapSchema:
if (!cl.hasOption('t')) {
usage("no schema template specified");
}
am.generateLdapSchema(pw, cl.getOptionValue('t'));
break;
case dump:
dumpSchema(pw);
break;
}
pw.close();
}
private void generateGlobalConfigLdif(PrintWriter pw) {
pw.println("# DO NOT MODIFY - generated by AttributeManager.");
pw.println("# LDAP entry that contains initial default Zimbra global config.");
pw.println("# " + buildVersion());
pw.println("dn: cn=config,cn=zimbra");
pw.println("objectclass: organizationalRole");
pw.println("cn: config");
pw.println("objectclass: zimbraGlobalConfig");
List<String> out = new LinkedList<String>();
for (AttributeInfo attr : mAttrs.values()) {
List<String> gcv = attr.getGlobalConfigValues();
if (gcv != null) {
for (String v : gcv) {
out.add(attr.getName() + ": " + v);
}
}
}
String[] outs = out.toArray(new String[0]);
Arrays.sort(outs);
for (String o : outs) {
pw.println(o);
}
}
private void generateDefaultCOSLdif(PrintWriter pw) {
pw.println("# DO NOT MODIFY - generated by AttributeManager.");
pw.println("# LDAP entry for the default Zimbra COS.");
pw.println("# " + buildVersion());
pw.println("dn: cn=default,cn=cos,cn=zimbra");
pw.println("cn: default");
pw.println("objectclass: zimbraCOS");
pw.println("zimbraId: e00428a1-0c00-11d9-836a-000d93afea2a");
pw.println("description: The default COS");
List<String> out = new LinkedList<String>();
for (AttributeInfo attr : mAttrs.values()) {
List<String> gcv = attr.getDefaultCosValues();
if (gcv != null) {
for (String v : gcv) {
out.add(attr.getName() + ": " + v);
}
}
}
String[] outs = out.toArray(new String[0]);
Arrays.sort(outs);
for (String o : outs) {
pw.println(o);
}
}
private void generateLdapSchema(PrintWriter pw, String schemaTemplateFile) throws IOException {
byte[] templateBytes = ByteUtil.getContent(new File(schemaTemplateFile));
String templateString = new String(templateBytes, "utf-8");
StringBuilder GROUP_OIDS = new StringBuilder();
StringBuilder ATTRIBUTE_OIDS = new StringBuilder();
StringBuilder ATTRIBUTE_DEFINITIONS = new StringBuilder();
for (Iterator<Integer> iter = mGroupMap.keySet().iterator(); iter.hasNext();) {
int i = iter.next();
//GROUP_OIDS
GROUP_OIDS.append("objectIdentifier " + mGroupMap.get(i) + " ZimbraLDAP:" + i + "\n");
// List all attrs which we define and which belong in this group
List<AttributeInfo> list = new ArrayList<AttributeInfo>(mAttrs.size());
for (AttributeInfo ai : mAttrs.values()) {
if (ai.getId() > -1 && ai.getGroupId() == i) {
list.add(ai);
}
}
// ATTRIBUTE_OIDS - sorted by OID
Collections.sort(list, new Comparator<AttributeInfo>() {
public int compare(AttributeInfo a1, AttributeInfo b1) {
return a1.getId() - b1.getId();
}
});
for (AttributeInfo ai : list) {
String parentOid = ai.getParentOid();
if (parentOid == null)
ATTRIBUTE_OIDS.append("objectIdentifier " + ai.getName() + " " + mGroupMap.get(i) + ':' + ai.getId() + "\n");
else
ATTRIBUTE_OIDS.append("objectIdentifier " + ai.getName() + " " + parentOid + "." + ai.getId() + "\n");
}
// ATTRIBUTE_DEFINITIONS: DESC EQUALITY NAME ORDERING SINGLE-VALUE SUBSTR SYNTAX
// - sorted by name
Collections.sort(list, new Comparator<AttributeInfo>() {
public int compare(AttributeInfo a1, AttributeInfo b1) {
return a1.getName().compareTo(b1.getName());
}
});
String lengthSuffix;
for (AttributeInfo ai : list) {
ATTRIBUTE_DEFINITIONS.append("attributetype ( " + ai.getName() + "\n");
ATTRIBUTE_DEFINITIONS.append("\tNAME ( '" + ai.getName() + "' )\n");
ATTRIBUTE_DEFINITIONS.append("\tDESC '" + ai.getDescription() + "'\n");
String syntax = null, substr = null, equality = null;
switch (ai.getType()) {
case TYPE_BOOLEAN:
syntax = "1.3.6.1.4.1.1466.115.121.1.7";
equality = "booleanMatch";
break;
case TYPE_EMAIL:
case TYPE_EMAILP:
syntax = "1.3.6.1.4.1.1466.115.121.1.26{256}";
equality = "caseIgnoreIA5Match";
substr = "caseIgnoreSubstringsMatch";
break;
case TYPE_GENTIME:
syntax = "1.3.6.1.4.1.1466.115.121.1.24";
equality = "generalizedTimeMatch";
break;
case TYPE_ID:
syntax = "1.3.6.1.4.1.1466.115.121.1.15{256}";
equality = "caseIgnoreMatch";
substr = "caseIgnoreSubstringsMatch";
break;
case TYPE_DURATION:
syntax = "1.3.6.1.4.1.1466.115.121.1.26{32}";
equality = "caseIgnoreIA5Match";
break;
case TYPE_ENUM:
int maxLen = Math.max(32, ai.getEnumValueMaxLength());
syntax = "1.3.6.1.4.1.1466.115.121.1.15{" + maxLen + "}";
equality = "caseIgnoreMatch";
substr = "caseIgnoreSubstringsMatch";
break;
case TYPE_INTEGER:
case TYPE_PORT:
case TYPE_LONG:
syntax = "1.3.6.1.4.1.1466.115.121.1.27";
equality = "integerMatch";
break;
case TYPE_STRING:
case TYPE_REGEX:
lengthSuffix = "";
if (ai.getMax() != Long.MAX_VALUE) {
lengthSuffix = "{" + ai.getMax() + "}";
}
syntax = "1.3.6.1.4.1.1466.115.121.1.15" + lengthSuffix;
equality = "caseIgnoreMatch";
substr = "caseIgnoreSubstringsMatch";
break;
case TYPE_ASTRING:
lengthSuffix = "";
if (ai.getMax() != Long.MAX_VALUE) {
lengthSuffix = "{" + ai.getMax() + "}";
}
syntax = "1.3.6.1.4.1.1466.115.121.1.26" + lengthSuffix;
equality = "caseIgnoreIA5Match";
substr = "caseIgnoreSubstringsMatch";
break;
case TYPE_OSTRING:
lengthSuffix = "";
if (ai.getMax() != Long.MAX_VALUE) {
lengthSuffix = "{" + ai.getMax() + "}";
}
syntax = "1.3.6.1.4.1.1466.115.121.1.40" + lengthSuffix;
equality = "octetStringMatch";
break;
case TYPE_CSTRING:
lengthSuffix = "";
if (ai.getMax() != Long.MAX_VALUE) {
lengthSuffix = "{" + ai.getMax() + "}";
}
syntax = "1.3.6.1.4.1.1466.115.121.1.15" + lengthSuffix;
equality = "caseExactMatch";
substr = "caseExactSubstringsMatch";
break;
case TYPE_PHONE:
lengthSuffix = "";
if (ai.getMax() != Long.MAX_VALUE) {
lengthSuffix = "{" + ai.getMax() + "}";
}
syntax = "1.3.6.1.4.1.1466.115.121.1.50" + lengthSuffix;
equality = "telephoneNumberMatch";
substr = "telephoneNumberSubstringsMatch";
break;
default:
throw new RuntimeException("unknown type encountered!");
}
ATTRIBUTE_DEFINITIONS.append("\tSYNTAX " + syntax + "\n");
ATTRIBUTE_DEFINITIONS.append("\tEQUALITY " + equality);
if (substr != null) {
ATTRIBUTE_DEFINITIONS.append("\n\tSUBSTR " + substr);
}
if (ai.getOrder() != null) {
ATTRIBUTE_DEFINITIONS.append("\n\tORDERING " + ai.getOrder());
}
if (ai.getCardinality() == AttributeCardinality.single) {
ATTRIBUTE_DEFINITIONS.append("\n\tSINGLE-VALUE");
}
ATTRIBUTE_DEFINITIONS.append(")\n\n");
}
}
Map<String,String> templateFillers = new HashMap<String,String>();
templateFillers.put("SCHEMA_VERSION_INFO", buildVersion());
templateFillers.put("GROUP_OIDS", GROUP_OIDS.toString());
templateFillers.put("ATTRIBUTE_OIDS", ATTRIBUTE_OIDS.toString());
templateFillers.put("ATTRIBUTE_DEFINITIONS", ATTRIBUTE_DEFINITIONS.toString());
for (AttributeClass cls : AttributeClass.values()) {
String key = "CLASS_MEMBERS_" + cls.toString().toUpperCase();
List<String> must = new LinkedList<String>();
List<String> may = new LinkedList<String>();
for (AttributeInfo ai : mAttrs.values()) {
if (ai.requiredInClass(cls)) {
must.add(ai.getName());
}
if (ai.optionalInClass(cls)) {
may.add(ai.getName());
}
}
Collections.sort(must);
Collections.sort(may);
StringBuilder value = new StringBuilder();
if (!must.isEmpty()) {
value.append("\tMUST (\n");
Iterator<String> mustIter = must.iterator();
while (true) {
value.append("\t\t").append(mustIter.next());
if (!mustIter.hasNext()) {
break;
}
value.append(" $\n");
}
value.append("\n\t)\n");
}
if (!may.isEmpty()) {
value.append("\tMAY (\n");
Iterator<String> mayIter = may.iterator();
while (true) {
value.append("\t\t").append(mayIter.next());
if (!mayIter.hasNext()) {
break;
}
value.append(" $\n");
}
value.append("\n\t)\n");
}
value.append('\t');
templateFillers.put(key, value.toString());
}
pw.print(StringUtil.fillTemplate(templateString, templateFillers));
}
private String buildVersion() {
String version = System.getProperty("zimbra.version");
if (version == null) {
return "unknown";
}
return version;
}
private static String sortCSL(String in) {
String[] ss = in.split("\\s*,\\s*");
Arrays.sort(ss);
StringBuilder sb = new StringBuilder(in.length());
for (int i = 0; i < ss.length; i++) {
sb.append(ss[i]);
if (i < (ss.length-1)) {
sb.append(", ");
}
}
return sb.toString();
}
private static void dumpAttrs(PrintWriter pw, String name, Attributes attrs) throws NamingException {
NamingEnumeration<javax.naming.directory.Attribute> attrIter = (NamingEnumeration<javax.naming.directory.Attribute>) attrs.getAll();
List<javax.naming.directory.Attribute> attrsList = new LinkedList<javax.naming.directory.Attribute>();
while (attrIter.hasMore()) {
attrsList.add(attrIter.next());
}
Collections.sort(attrsList, new Comparator<javax.naming.directory.Attribute>() {
public int compare(javax.naming.directory.Attribute a1, javax.naming.directory.Attribute b1) {
return a1.getID().compareTo(b1.getID());
}
});
for (javax.naming.directory.Attribute attr : attrsList) {
// String s = attr.toString();
NamingEnumeration valIter = attr.getAll();
List<String> values = new LinkedList<String>();
while (valIter.hasMore()) {
values.add((String)valIter.next());
}
Collections.sort(values);
for (String val : values) {
pw.println(name + ": " + attr.getID() + ": " + val);
}
}
}
private static void dumpSchema(PrintWriter pw) throws ServiceException {
DirContext dc = null;
try {
dc = LdapUtil.getDirContext(true);
DirContext schema = dc.getSchema("");
// Enumerate over ClassDefinition, AttributeDefinition, MatchingRule, SyntaxDefinition
NamingEnumeration<NameClassPair> schemaTypeIter = schema.list("");
while (schemaTypeIter.hasMore()) {
String schemaType = schemaTypeIter.next().getName();
NamingEnumeration<NameClassPair> schemaEntryIter = schema.list(schemaType);
List<String> schemaEntries = new LinkedList<String>();
while (schemaEntryIter.hasMore()) {
schemaEntries.add(schemaEntryIter.next().getName());
}
Collections.sort(schemaEntries);
for (String schemaEntry : schemaEntries) {
DirContext sdc = (DirContext) schema.lookup(schemaType + "/" + schemaEntry);
dumpAttrs(pw, schemaType + ": " + schemaEntry, sdc.getAttributes(""));
}
}
dumpAttrs(pw, "GlobalConfig", dc.getAttributes("cn=config,cn=zimbra"));
dumpAttrs(pw, "DefaultCOS", dc.getAttributes("cn=default,cn=cos,cn=zimbra"));
} catch (NamingException ne) {
ne.printStackTrace();
} finally {
LdapUtil.closeContext(dc);
}
}
}
The table below shows all metrics for AttributeManager.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 190.00 | Number of blocks | |
| BLOCK_COMMENT | 30.00 | Number of block comment lines | |
| COMMENTS | 57.00 | Comment lines | |
| COMMENT_DENSITY | 0.08 | Comment density | |
| COMPARISONS | 154.00 | Number of comparison operators | |
| CYCLOMATIC | 197.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 4.00 | Comments in declarations | |
| DOC_COMMENT | 4.00 | Number of javadoc comment lines | |
| ELOC | 692.00 | Effective lines of code | |
| EXEC_COMMENTS | 17.00 | Comments in executable code | |
| EXITS | 165.00 | Procedure exits | |
| FUNCTIONS | 38.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 94.66 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 127.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.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 | 1.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 | 1.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 1.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 12.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 | 1.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 | 1.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 | 1.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 1.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 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 15.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 1.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 | 1.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 | 1.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 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 2.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 1.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 | 7.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 119.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 | 2.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 | 4.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.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 | 5.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 | 1.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 1.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 1.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 3.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 | 2.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 | 4.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 | 1016.00 | Number of lines in the source file | |
| LINE_COMMENT | 23.00 | Number of line comments | |
| LOC | 849.00 | Lines of code | |
| LOGICAL_LINES | 464.00 | Number of statements | |
| LOOPS | 14.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 2442.00 | Number of operands | |
| OPERATORS | 4312.00 | Number of operators | |
| PARAMS | 66.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 6754.00 | Halstead program length | |
| PROGRAM_VOCAB | 820.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 61.00 | Number of return points from functions | |
| SIZE | 41402.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 761.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 59.00 | Number of unique operators | |
| WHITESPACE | 110.00 | Number of whitespace lines | |