FileDocCategorySizeDatePackage
HomeInterfaceCreateMethodExceptionMatch.javaAPI DocGlassfish v2 API12348Fri May 04 22:33:46 BST 2007com.sun.enterprise.tools.verifier.tests.ejb.entity.createmethod

HomeInterfaceCreateMethodExceptionMatch

public class HomeInterfaceCreateMethodExceptionMatch extends com.sun.enterprise.tools.verifier.tests.ejb.EjbTest implements com.sun.enterprise.tools.verifier.tests.ejb.EjbCheck
create 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.

Fields Summary
Result
result
ComponentNameConstructor
compName
boolean
foundAtLeastOneCreate
Constructors Summary
Methods Summary
public Resultcheck(com.sun.enterprise.deployment.EjbDescriptor descriptor)
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
Result the results for this assertion

                                                                                                     
        

	 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;
	}
private booleancommonToBothInterfaces(java.lang.String component, java.lang.String local, com.sun.enterprise.deployment.EjbDescriptor descriptor)
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

      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<Method>();

	  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;
      }