/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 Oracle and/or its affiliates. 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_1_1.html
* or packager/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 packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [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.ejbcreatemethod;
import com.sun.enterprise.tools.verifier.Result;
import com.sun.enterprise.tools.verifier.Verifier;
import com.sun.enterprise.tools.verifier.VerifierTestContext;
import com.sun.enterprise.tools.verifier.tests.ComponentNameConstructor;
import com.sun.enterprise.tools.verifier.tests.ejb.EjbCheck;
import com.sun.enterprise.tools.verifier.tests.ejb.EjbTest;
import org.glassfish.ejb.deployment.descriptor.EjbDescriptor;
import org.glassfish.ejb.deployment.descriptor.EjbEntityDescriptor;
import java.lang.reflect.Method;
import java.util.Vector;
/**
* Entity Bean's ejbCreate(...) methods name test.
* Each entity Bean class may define zero or more ejbCreate(...) methods.
* The number and signatures of a entity Bean's create methods are specific
* to each EJB class. The method signatures must follow these rules:
*
* The method name must be ejbCreate.
*/
public class EjbCreateMethodName extends EjbTest implements EjbCheck {
Result result = null;
ComponentNameConstructor compName = null;
int foundAtLeastOne = 0;
/**
* Entity Bean's ejbCreate(...) methods name test.
* Each entity Bean class may define zero or more ejbCreate(...) methods.
* The number and signatures of a entity Bean's create methods are specific
* to each EJB class. The method signatures must follow these rules:
*
* The method name must be ejbCreate.
*
* @param descriptor the Enterprise Java Bean deployment descriptor
*
* @return <code>Result</code> the results for this assertion
*/
public Result check(EjbDescriptor descriptor) {
result = getInitializedResult();
compName = getVerifierContext().getComponentNameConstructor();
boolean oneFailed = false;
if (descriptor instanceof EjbEntityDescriptor) {
if(descriptor.getHomeClassName() != null && !"".equals(descriptor.getHomeClassName()))
oneFailed = commonToBothInterfaces(descriptor.getHomeClassName(),(EjbEntityDescriptor)descriptor);
if (oneFailed == false) {
if(descriptor.getLocalHomeClassName() != null && !"".equals(descriptor.getLocalHomeClassName()))
oneFailed = commonToBothInterfaces(descriptor.getLocalHomeClassName(),(EjbEntityDescriptor)descriptor);
}
if (oneFailed) {
result.setStatus(result.FAILED);
} else if (foundAtLeastOne == 0) {
result.setStatus(result.NOT_APPLICABLE);
} else {
result.setStatus(result.PASSED);
}
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;
}
}
private boolean commonToBothInterfaces(String component, EjbEntityDescriptor descriptor) {
boolean oneFailed = false;
boolean createExists = false;
try {
VerifierTestContext context = getVerifierContext();
ClassLoader jcl = context.getClassLoader();
Class c = Class.forName(descriptor.getEjbClassName(), false, getVerifierContext().getClassLoader());
Class home = Class.forName(component, false, getVerifierContext().getClassLoader());
Method [] homeMethods = home.getDeclaredMethods();
Vector<String> createMethodSuffix = new Vector<String>();
for (int i = 0; i < homeMethods.length; i++) {
// The method name must start with create.
if (homeMethods[i].getName().startsWith("create")) {
createMethodSuffix.addElement( homeMethods[i].getName().substring(6));
createExists = true;
}
}
// start do while loop here....
do {
boolean found = false;
Method [] methods = c.getDeclaredMethods();
for (int j = 0; j < methods.length; j++) {
// The method name must start with ejbCreate.
if (methods[j].getName().startsWith("ejbCreate")) {
String matchSuffix = methods[j].getName().substring(9);
for (int k = 0; k < createMethodSuffix.size(); k++) {
found = false;
if (matchSuffix.equals(createMethodSuffix.elementAt(k))) {
found = true;
foundAtLeastOne++;
// now display the appropriate results for this particular ejbCreate
// method
result.addGoodDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.addGoodDetails(smh.getLocalString
(getClass().getName() + ".debug1",
"For EJB Class [ {0} ] method [ {1} ]",
new Object[] {descriptor.getEjbClassName(),methods[j].getName()}));
result.addGoodDetails(smh.getLocalString
(getClass().getName() + ".passed",
"[ {0} ] declares [ {1} ] method.",
new Object[] {descriptor.getEjbClassName(),methods[j].getName()}));
break;
}
}
if (found == false) {
result.addErrorDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.failed(smh.getLocalString
(getClass().getName() + ".failedException1",
"Error: no create{0}() method found corresponding to ejbCreate{1}() method ",
new Object[] {matchSuffix, matchSuffix}));
oneFailed = true;
break;
}
}
}
if (oneFailed == true)
break;
} while (((c = c.getSuperclass()) != null) && (foundAtLeastOne == 0));
if ( createExists == false){
result.addNaDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.notApplicable(smh.getLocalString
(getClass().getName() + ".notApplicable1",
"[ {0} ] does not declare any ejbCreate(...) methods.",
new Object[] {descriptor.getEjbClassName()}));
oneFailed = false;
}
if (foundAtLeastOne == 0 && createExists == true){
result.addErrorDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.failed(smh.getLocalString
(getClass().getName() + ".failedException1",
"Error: no ejbCreate<Method> method for corresponding create<Method> method found!",
new Object[] {}));
oneFailed = false;
}
return oneFailed;
} 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()}));
oneFailed = true;
return oneFailed;
}
}
}