Glassfish example source code file (HomeInterfaceCreateMethodExceptionMatch.java)

This example Glassfish source code file (HomeInterfaceCreateMethodExceptionMatch.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Glassfish tags/keywords

class, class, ejbclass, for, for, home, interface, log, logging, method, method, no, object, object, reflection, result, util, vector

The Glassfish HomeInterfaceCreateMethodExceptionMatch.java source code

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 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.createmethod;

import com.sun.enterprise.tools.verifier.tests.ejb.EjbTest;
import com.sun.enterprise.deployment.EjbDescriptor;
import com.sun.enterprise.deployment.EjbEntityDescriptor;
import java.lang.ClassLoader;
import com.sun.enterprise.tools.verifier.tests.*;
import java.util.*;
import java.util.logging.Level;
import java.lang.reflect.*;
import com.sun.enterprise.tools.verifier.*;
import com.sun.enterprise.tools.verifier.tests.ejb.RmiIIOPUtils;
import com.sun.enterprise.tools.verifier.tests.ejb.EjbCheck;

/** 
 * create<Method> method tests
 * Entity beans home interface method exceptions match test.
 * 
 * The following are the requirements for the enterprise Bean's home interface 
 * signature: 
 * 
 * An Entity Bean's home interface defines one or more create(...) methods. 
 * 
 * All the exceptions defined in the throws clause of an ejbCreate method of 
 * the enterprise Bean class must be defined in the throws clause of the 
 * matching create method of the home interface. 
 * 
 */
public class HomeInterfaceCreateMethodExceptionMatch extends EjbTest implements EjbCheck { 

    Result result = null;
    ComponentNameConstructor compName = null;
    boolean foundAtLeastOneCreate = false;
    /**
     * Entity beans home interface method exceptions match test.
     * 
     * The following are the requirements for the enterprise Bean's home interface 
     * signature: 
     * 
     * An Entity Bean's home interface defines one or more create(...) methods. 
     * 
     * All the exceptions defined in the throws clause of an ejbCreate method of 
     * the enterprise Bean class must be defined in the throws clause of the 
     * matching create method of the home interface. 
     * 
     * @param descriptor the Enterprise Java Bean deployment descriptor
     *   
     * @return <code>Result the results for this assertion
     */
    public Result check(EjbDescriptor descriptor) {

	 result = getInitializedResult();
	 compName = getVerifierContext().getComponentNameConstructor();
	 boolean oneFailed = false;
	 if (descriptor instanceof EjbEntityDescriptor) {
	     oneFailed = commonToBothInterfaces(descriptor.getHomeClassName(),descriptor.getLocalHomeClassName(),descriptor);
	     if (!foundAtLeastOneCreate) {
		 result.addNaDetails(smh.getLocalString
				     ("tests.componentNameConstructor",
				      "For [ {0} ]",
				      new Object[] {compName.toString()}));
		 result.addNaDetails(smh.getLocalString
				     (getClass().getName() + ".debug4",
				      "In Home Interface ",
				      new Object[] {}));
		 result.addNaDetails(smh.getLocalString
				     (getClass().getName() + ".notApplicable1",
				      "No create method was found, test not applicable." ));
		 result.setStatus(result.NOT_APPLICABLE);
	     } else { 
		 if (oneFailed) {
		     result.setStatus(result.FAILED);
		 } 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;
	} 
    }

    /** 
     * This method is responsible for the logic of the test. It is called for both local and remote interfaces.
     * @param descriptor the Enterprise Java Bean deployment descriptor
     * @param home for the Home interface of the Ejb. 
     * @param interfaceType remote/local
     * @return boolean the results for this assertion i.e if a test has failed or not
     */

    private boolean commonToBothInterfaces(String component, String local,EjbDescriptor descriptor) {
      boolean oneFailed = false;
      int ejbCreateMethodLoopCounter = 0;
      // RULE: entity home interface are only allowed to have create 
      //       methods which match ejbCreate, and exceptions match Bean's
      try {
	  Class methodReturnType;
	  Class [] methodParameterTypes;
	  Class [] methodExceptionTypes;
	  Class [] ejbCreateMethodExceptionTypes;
	  Class [] ejbCreateMethodParameterTypes;
	  boolean ejbCreateFound = false;
	  boolean exceptionsMatch = false;
	  Vector<Method> createMethodSuffix = new Vector();

	  if (component != null) {
	      Class home = Class.forName(component, false, getVerifierContext().getClassLoader());
	      Method [] homeMethods = home.getDeclaredMethods();
	      
	      for (int i = 0; i < homeMethods.length; i++) {
		  // The method name must start with create. 
		  if (homeMethods[i].getName().startsWith("create")) {
		      createMethodSuffix.addElement( (Method)homeMethods[i]);
		      foundAtLeastOneCreate = true;
		  }
	      }
	  }
	  if (local != null) {
	      Class home = Class.forName(local, false, getVerifierContext().getClassLoader());
	      Method [] homeMethods = home.getDeclaredMethods();
	      
	      for (int i = 0; i < homeMethods.length; i++) {
		  // The method name must start with create. 
		  if (homeMethods[i].getName().startsWith("create")) {
		      createMethodSuffix.addElement( (Method)homeMethods[i]);
		      foundAtLeastOneCreate = true;
		  }
	      }
	  }
	  if (foundAtLeastOneCreate == false)
	      return false;
	  Class EJBClass = Class.forName(descriptor.getEjbClassName(), false, getVerifierContext().getClassLoader());
	  
	  do {
	      Method [] methods = EJBClass.getDeclaredMethods();
	      // find matching "ejbCreate" in bean class
	      for (int i = 0; i < methods.length; i++) {
		  ejbCreateFound = false;
		  exceptionsMatch = false;
		  if (methods[i].getName().startsWith("ejbCreate")) {
		      String matchSuffix = methods[i].getName().substring(9);
		      for (int k = 0; k < createMethodSuffix.size(); k++) {
			  if (matchSuffix.equals(((Method)(createMethodSuffix.elementAt(k))).getName().substring(6))) {
			      // clear these from last time thru loop
			      // retrieve the EJB Class Methods
			      methodParameterTypes = ((Method)(createMethodSuffix.elementAt(k))).getParameterTypes();
			      ejbCreateMethodParameterTypes = methods[i].getParameterTypes();
			      if (Arrays.equals(methodParameterTypes,ejbCreateMethodParameterTypes)) {
				  ejbCreateFound = true;
				  methodExceptionTypes = ((Method)(createMethodSuffix.elementAt(k))).getExceptionTypes();
				  ejbCreateMethodExceptionTypes = methods[i].getExceptionTypes();
				  // methodExceptionTypes needs to be
				  // a superset of all the possible exceptions thrown in
				  // ejbCreateMethodExceptionTypes
				  // All the exceptions defined in the throws clause of the
				  // matching ejbCreate and ejbPostCreate methods of the
				  // enterprise Bean class must be included in the throws
				  // clause of the matching create method of the home interface
				  // (i.e the set of exceptions defined for the create method
				  // must be a superset of the union of exceptions defined for
				  // the ejbCreate and ejbPostCreate methods)
				  if (RmiIIOPUtils.isEjbFindMethodExceptionsSubsetOfFindMethodExceptions(ejbCreateMethodExceptionTypes,methodExceptionTypes)) {
				      exceptionsMatch = true;
				      // used to display output below
				      ejbCreateMethodLoopCounter = k;
				      break;
				  }
			      } // method params match
			  }
		      }
		      //report for this particular create method found in home interface
		      //if we know that ejbCreateFound got set to true in the above 
		      // loop, check other booleans, otherwise skip test, set status 
		      // to FAILED below
		      
		      // now display the appropriate results for this particular create
		      // method
		      if (ejbCreateFound && exceptionsMatch) {
			  result.addGoodDetails(smh.getLocalString
						  ("tests.componentNameConstructor",
						   "For [ {0} ]",
						   new Object[] {compName.toString()}));
			  result.addGoodDetails(smh.getLocalString
						(getClass().getName() + ".debug1",
						 "For Home Interface Method [ {0} ]",
						 new Object[] {((Method)(createMethodSuffix.elementAt(ejbCreateMethodLoopCounter))).getName()}));
			  result.addGoodDetails(smh.getLocalString
						(getClass().getName() + ".passed",
						 "The corresponding [ {0} ] method with matching exceptions was found.",
						 new Object[] {methods[i].getName()}));
		      } else if (ejbCreateFound && !exceptionsMatch) {
			  oneFailed = true;
			  result.addErrorDetails(smh.getLocalString
						  ("tests.componentNameConstructor",
						   "For [ {0} ]",
						   new Object[] {compName.toString()}));
			  result.addErrorDetails(smh.getLocalString
						 (getClass().getName() + ".debug1",
						  "For Home Interface Method [ {0} ]",
						  new Object[] {((Method)(createMethodSuffix.elementAt(ejbCreateMethodLoopCounter))).getName()}));
			  result.addErrorDetails(smh.getLocalString
						 (getClass().getName() + ".failed",
						  "Error: No corresponding ejbCreate() method was found, where the exceptions defined by method ejbCreate() are defined within matching create() method."));
			  logger.log(Level.FINE, getClass().getName() + ".debug1",
                      new Object[] {((Method)(createMethodSuffix.elementAt(ejbCreateMethodLoopCounter))).getName()});
              logger.log(Level.FINE, getClass().getName() + ".debug3",
                      new Object[] {methods[i].getName(),((Method)(createMethodSuffix.elementAt(ejbCreateMethodLoopCounter))).getName()});
			  break;
		      }  // end of reporting for this particular 'create' method
		  }
		  if (oneFailed == true)
		      break;
	      }
	  } while (((EJBClass = EJBClass.getSuperclass()) != null) && (!(ejbCreateFound && exceptionsMatch)));
	 
	  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: Home (Local/Remote) interface or bean class [ {0} ] does not exist or is not loadable within bean [ {1} ]",
			 new Object[] {descriptor.getEjbClassName(),descriptor.getName()}));
	  return oneFailed;
      }      
    }
}