Define ejbFindByPrimaryKey method exception test.
Every entity enterprise Bean class must define the ejbFindByPrimaryKey
method.
Compatibility Note: EJB 1.0 allowed the finder methods to throw the
java.rmi.RemoteException to indicate a non-application exception. This
practice is deprecated in EJB 1.1---an EJB 1.1 compliant enterprise
bean should throw the javax.ejb.EJBException or another
java.lang.RuntimeException to indicate non-application exceptions to
the Container.
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 throwsRemoteException = false;
boolean oneFailed = false;
int foundWarning = 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;
// Compatibility Note: EJB 1.0 allowed the ejbFindByPrimaryKey to
// throw the java.rmi.RemoteException to indicate a non-application
// exception. This practice is deprecated in EJB 1.1---an EJB 1.1
// compliant enterprise bean should throw the javax.ejb.EJBException
// or another RuntimeException to indicate non-application
// exceptions to the Container (see Section 12.2.2).
// Note: Treat as a warning to user in this instance.
Class [] exceptions = ejbFinderMethods[j].getExceptionTypes();
for (int z = 0; z < exceptions.length; ++z) {
if (exceptions[z].getName().equals("java.rmi.RemoteException")) {
throwsRemoteException = true;
break;
}
}
if (ejbFindByPrimaryKeyMethodFound && (!throwsRemoteException)) {
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",
"[ {0} ] declares [ {1} ] method, which properly does not throw java.rmi.RemoteException",
new Object[] {EJBClass.getName(),ejbFinderMethods[j].getName()}));
} else if (ejbFindByPrimaryKeyMethodFound && throwsRemoteException) {
result.addWarningDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.addWarningDetails(smh.getLocalString
(getClass().getName() + ".debug1",
"For EJB Class [ {0} ] Finder Method [ {1} ]",
new Object[] {EJBClass.getName(),ejbFinderMethods[j].getName()}));
result.addWarningDetails(smh.getLocalString
(getClass().getName() + ".warning",
"Error: Compatibility Note:" +
"\n An [ {0} ] method was found, but" +
"\n EJB 1.0 allowed the ejbFindByPrimaryKey method to throw " +
"\n the java.rmi.RemoteException to indicate a non-application" +
"\n exception. This practice is deprecated in EJB 1.1" +
"\n ---an EJB 1.1 compliant enterprise bean should" +
"\n throw the javax.ejb.EJBException or another " +
"\n RuntimeException to indicate non-application exceptions" +
"\n to the Container. ",
new Object[] {ejbFinderMethods[j].getName()}));
foundWarning++;
}
// 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() + ".failed",
"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 if (foundWarning > 0) {
result.setStatus(result.WARNING);
} 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;
}
