/*
* 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.entity.ejbfindbyprimarykey;
import com.sun.enterprise.tools.verifier.tests.ejb.EjbTest;
import java.lang.reflect.*;
import java.util.*;
import com.sun.enterprise.deployment.EjbEntityDescriptor;
import com.sun.enterprise.deployment.EjbDescriptor;
import com.sun.enterprise.deployment.MethodDescriptor;
import com.sun.enterprise.tools.verifier.tests.ejb.EjbCheck;
import com.sun.enterprise.tools.verifier.*;
import java.lang.ClassLoader;
import com.sun.enterprise.tools.verifier.tests.*;
/**
* Define ejbFindByPrimaryKey method final test.
*
* Every entity enterprise Bean class must define the ejbFindByPrimaryKey
* method.
*
* The method must not be declared as final.
*
*/
public class EjbFindByPrimaryKeyFinal extends EjbTest implements EjbCheck {
/**
* Define ejbFindByPrimaryKey method final test.
*
* Every entity enterprise Bean class must define the ejbFindByPrimaryKey
* method.
*
* The method must not be declared as final.
*
* @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();
if (descriptor instanceof EjbEntityDescriptor) {
String persistentType =
((EjbEntityDescriptor)descriptor).getPersistenceType();
if (EjbEntityDescriptor.BEAN_PERSISTENCE.equals(persistentType)) {
boolean ejbFindByPrimaryKeyMethodFound = false;
boolean isFinal = false;
boolean oneFailed = false;
int findMethodModifiers = 0;
try {
// retrieve the EJB Class Methods
Context context = getVerifierContext();
ClassLoader jcl = context.getClassLoader();
Class EJBClass = Class.forName(descriptor.getEjbClassName(), false, getVerifierContext().getClassLoader());
// start do while loop here....
do {
Method [] ejbFinderMethods = EJBClass.getDeclaredMethods();
for (int j = 0; j < ejbFinderMethods.length; ++j) {
if (ejbFinderMethods[j].getName().equals("ejbFindByPrimaryKey")) {
// Every entity enterprise Bean class must define the
// ejbFindByPrimaryKey method.
ejbFindByPrimaryKeyMethodFound = true;
// The method must not be declared as final.
findMethodModifiers = ejbFinderMethods[j].getModifiers();
if (Modifier.isFinal(findMethodModifiers)) {
isFinal = true;
}
if (ejbFindByPrimaryKeyMethodFound && !isFinal) {
result.addGoodDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.addGoodDetails(smh.getLocalString
(getClass().getName() + ".debug1",
"For EJB Class [ {0} ] Finder method [ {1} ]",
new Object[] {EJBClass.getName(),ejbFinderMethods[j].getName()}));
result.addGoodDetails(smh.getLocalString
(getClass().getName() + ".passed",
"A non-final [ {0} ] method was found.",
new Object[] {ejbFinderMethods[j].getName()}));
} else if (ejbFindByPrimaryKeyMethodFound && isFinal) {
oneFailed = true;
result.addErrorDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.addErrorDetails(smh.getLocalString
(getClass().getName() + ".debug1",
"For EJB Class [ {0} ] Finder method [ {1} ]",
new Object[] {EJBClass.getName(),ejbFinderMethods[j].getName()}));
result.addErrorDetails(smh.getLocalString
(getClass().getName() + ".failed",
"Error: A final [ {0} ] method was found, but [ {1} ] cannot be declared as final.",
new Object[] {ejbFinderMethods[j].getName(),ejbFinderMethods[j].getName()}));
}
// found one, and there should only be one, break out
break;
}
}
} while (((EJBClass = EJBClass.getSuperclass()) != null) && (!ejbFindByPrimaryKeyMethodFound));
if (!ejbFindByPrimaryKeyMethodFound) {
oneFailed = true;
result.addErrorDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.addErrorDetails(smh.getLocalString
(getClass().getName() + ".debug3",
"For EJB Class [ {0} ]",
new Object[] {descriptor.getEjbClassName()}));
result.addErrorDetails(smh.getLocalString
(getClass().getName() + ".failed1",
"Error: No ejbFindByPrimaryKey method was found in bean class."));
}
} 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: EJB Class [ {0} ] does not exist or is not loadable.",
new Object[] {descriptor.getEjbClassName()}));
oneFailed = true;
}
if (oneFailed) {
result.setStatus(result.FAILED);
} else {
result.setStatus(result.PASSED);
}
} else { //(CONTAINER_PERSISTENCE.equals(persistentType))
result.addNaDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.notApplicable(smh.getLocalString
(getClass().getName() + ".notApplicable2",
"Expected persistence type [ {0} ], but bean [ {1} ] has persistence type [ {2} ]",
new Object[] {EjbEntityDescriptor.BEAN_PERSISTENCE,descriptor.getName(),persistentType}));
}
return result;
} else {
result.addNaDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.notApplicable(smh.getLocalString
(getClass().getName() + ".notApplicable",
"[ {0} ] expected {1} bean, but called with {2} bean.",
new Object[] {getClass(),"Entity","Session"}));
return result;
}
}
}