/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.tools.verifier.tests.ejb.beanclass;
import com.sun.enterprise.tools.verifier.tests.ejb.EjbTest;
import java.lang.reflect.*;
import com.sun.enterprise.deployment.*;
import com.sun.enterprise.tools.verifier.*;
import com.sun.enterprise.tools.verifier.tests.ejb.EjbCheck;
import com.sun.enterprise.tools.verifier.tests.*;
/**
* Enterprise Java Bean class static final fields test.
* An enterprise Bean must not use read/write static fields. Using read-only
* static fields is allowed. Therefore, it is recommended that all static
* fields in the enterprise bean class be declared as final.
*
* This rule is required to ensure consistent runtime semantics because while
* some EJB Containers may use a single JVM to execute all enterprise bean's
* instances, others may distribute the instances across multiple JVMs.
*/
public class EjbClassStaticFieldsFinal extends EjbTest implements EjbCheck {
/**
* Enterprise Java Bean class static final fields test.
* An enterprise Bean must not use read/write static fields. Using read-only
* static fields is allowed. Therefore, it is recommended that all static
* fields in the enterprise bean class be declared as final.
*
* This rule is required to ensure consistent runtime semantics because while
* some EJB Containers may use a single JVM to execute all enterprise bean's
* instances, others may distribute the instances across multiple JVMs.
*
* @param descriptor the Enterprise Java Bean deployment descriptor
*
* @return <code>Result</code> the results for this assertion
*/
public Result check(EjbDescriptor descriptor) {
Result result = getInitializedResult();
ComponentNameConstructor compName = getVerifierContext().getComponentNameConstructor();
// it is recommended that all static fields in the enterprise bean class
// be declared as final.
try {
Class c = Class.forName(descriptor.getEjbClassName(), false, getVerifierContext().getClassLoader());
boolean oneFailed = false;
boolean badField = false;
Field [] fields = c.getDeclaredFields();
for (int i = 0; i < fields.length; i++) {
badField = false;
// hack to prevent compiler bug, don't want to process fields such as
// class$test$enforcer$hello$HelloHome, so if the field contains a "$"
// just skip it, otherwise process normally.
// if "$" does not occur as a substring, -1 is returned.
if (fields[i].getName().indexOf("$") == -1) {
int modifiers = fields[i].getModifiers();
if (Modifier.isStatic(modifiers)) {
if (Modifier.isFinal(modifiers)) {
continue;
} else {
if (!oneFailed) {
oneFailed = true;
}
badField = true;
}
}
}
if (badField) {
result.addWarningDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.warning(smh.getLocalString
(getClass().getName() + ".warning",
"Warning: Field [ {0} ] defined within bean class [ {1} ] is defined as static, but not defined as final. An enterprise Bean must not use read/write static fields. Using read-only static fields is allowed.",
new Object[] {fields[i].getName(),(descriptor).getEjbClassName()}));
}
}
if (!oneFailed) {
result.addGoodDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.passed(smh.getLocalString
(getClass().getName() + ".passed",
"This bean class [ {0} ] has defined any and all static fields as final.",
new Object[] {(descriptor).getEjbClassName()}));
}
} catch (ClassNotFoundException e) {
Verifier.debug(e);
result.addErrorDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.failed(smh.getLocalString
(getClass().getName() + ".failedException",
"Error: [ {0} ] class not found.",
new Object[] {(descriptor).getEjbClassName()}));
} catch (Exception e) {
Verifier.debug(e);
result.addErrorDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.failed(smh.getLocalString
(getClass().getName() + ".failedException1",
"Error: [ {0} ] class encountered [ {1} ]",
new Object[] {(descriptor).getEjbClassName(),e.getMessage()}));
} catch (Throwable t) {
result.addWarningDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.warning(smh.getLocalString
(getClass().getName() + ".warningException",
"Warning: [ {0} ] class encountered [ {1} ]. Cannot access fields of class [ {2} ] which is external to [ {3} ].",
new Object[] {(descriptor).getEjbClassName(),t.toString(), t.getMessage(), descriptor.getEjbBundleDescriptor().getModuleDescriptor().getArchiveUri()}));
}
return result;
}
}
|
