/*
* 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.homeintf;
import com.sun.enterprise.tools.verifier.Result;
import com.sun.enterprise.tools.verifier.Verifier;
import java.lang.ClassLoader;
import java.lang.reflect.Method;
import java.util.Vector;
import java.util.Iterator;
import com.sun.enterprise.tools.verifier.tests.ejb.EjbTest;
import com.sun.enterprise.tools.verifier.tests.ComponentNameConstructor;
import com.sun.enterprise.deployment.EjbDescriptor;
import com.sun.enterprise.deployment.EjbSessionDescriptor;
import com.sun.enterprise.deployment.EjbEntityDescriptor;
/**
* Superclass for all Home methods tests.
*
* @author Jerome Dochez
* @version
*/
abstract public class HomeMethodTest extends EjbTest {
/** Method tells the name of the home interface class that called this test
*/
abstract protected String getHomeInterfaceName(EjbDescriptor descriptor);
abstract protected String getSuperInterface();
/** <p>
* run an individual home method test
* </p>
* @param descriptor the deployment descriptor for the entity bean
* @param result the result object
* @param m the mehtod to test
*/
abstract protected void runIndividualHomeMethodTest( Method m,EjbDescriptor descriptor, Result result);
/**
*
* @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(getHomeInterfaceName(descriptor) == null || "".equals(getHomeInterfaceName(descriptor))){
addNaDetails(result, compName);
result.notApplicable(smh.getLocalString
("com.sun.enterprise.tools.verifier.tests.ejb.localinterfaceonly.notapp",
"Not Applicable because, EJB [ {0} ] has Local Interfaces only.",
new Object[] {descriptor.getEjbClassName()}));
return result;
}
if (!(descriptor instanceof EjbSessionDescriptor) &&
!(descriptor instanceof EjbEntityDescriptor)) {
addNaDetails(result, compName);
result.notApplicable(smh.getLocalString
("com.sun.enterprise.tools.verifier.tests.ejb.homeintf.HomeMethodTest.notApplicable1",
"Test apply only to session or entity beans."));
return result;
}
boolean homeMethodFound = false;
try {
// retrieve the remote interface methods
ClassLoader jcl = getVerifierContext().getClassLoader();
Class homeInterfaceClass = Class.forName(getClassName(descriptor), false, jcl);
Vector<Method> v = new Vector<Method>();
while (homeInterfaceClass != null &&
!homeInterfaceClass.getName().equals(getSuperInterface()) &&
!homeInterfaceClass.getName().equals("java.lang.Object")) {
Method [] homeInterfaceMethods = homeInterfaceClass.getDeclaredMethods();
for (int i=0;i<homeInterfaceMethods.length;i++) {
v.add(homeInterfaceMethods[i]);
}
homeInterfaceClass = homeInterfaceClass.getSuperclass();
}
Iterator iterator = v.iterator();
while (iterator.hasNext()) {
Method method = (Method) iterator.next();
String methodName = method.getName();
if (methodName.startsWith("create") || methodName.startsWith("find") ||
methodName.startsWith("remove"))
continue;
Method m = getMethod(javax.ejb.EJBHome.class, methodName,
method.getParameterTypes());
if (m!=null) {
// this is an EJBHome method...
continue;
}
homeMethodFound = true;
// if (!runIndividualHomeMethodTest( method,descriptor, result))
// oneFailed = true;
runIndividualHomeMethodTest( method,descriptor, result);
if (result.getStatus() == Result.FAILED)
break;
}
} catch (ClassNotFoundException e) {
Verifier.debug(e);
addErrorDetails(result, compName);
result.failed(smh.getLocalString
("com.sun.enterprise.tools.verifier.tests.ejb.homeintf.HomeMethodTest.failedException",
"Error: Home interface [ {0} ] does not exist or is not loadable within bean [ {1} ]",
new Object[] {getClassName(descriptor),descriptor.getName()}));
}
if (!homeMethodFound) {
addNaDetails(result, compName);
result.notApplicable(smh.getLocalString
("com.sun.enterprise.tools.verifier.tests.ejb.homeintf.HomeMethodTest.notApplicable2",
"Home interface [ {0} ] does not define any home methods",
new Object[] {getClassName(descriptor)}));
} //else {
// result.setStatus(oneFailed?result.FAILED:Result.PASSED);
// }
return result;
}
private String getClassName(EjbDescriptor descriptor) {
return getHomeInterfaceName(descriptor);
}
}