/**
* Check that the Client API Connection interface implements the close() method
*
* @paramm descriptor deployment descriptor for the rar file
* @return result object containing the result of the individual test performed
*/
public Result check(ConnectorDescriptor descriptor) {
// get the connection
Result result = getInitializedResult();
ComponentNameConstructor compName = getVerifierContext().getComponentNameConstructor();
if (isCCIImplemented(descriptor, result)) {
Class c = testConnectionImpl(descriptor, result);
if (c == null) {
return result;
}
// now check the close() method
Method m = getMethod(c, "close", null);
if (m != null) {
// passed
result.addGoodDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.passed(
smh.getLocalString(
getClass().getName() + ".passed",
"The connection interface [ {0} ] implements the close() method",
new Object[] {c.getName()}));
} else {
result.addErrorDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.failed(
smh.getLocalString(
getClass().getName() + ".failed",
"Error: The connection interface [ {0} ] does not implement the close() method",
new Object[] {c.getName()}));
}
} else {
// test is NA
result.addNaDetails(
smh.getLocalString(
"tests.componentNameConstructor", "For [ {0} ]", new Object[] {compName.toString()}));
result.notApplicable(
smh.getLocalString(
"com.sun.enterprise.tools.verifier.tests.connector.cci.notApp",
"The CCI interfaces do not seem to be implemented by this resource adapter"));
}
return result;
}
/**
* Test if a javax.resource.cci.ConnectionMetaData implementation has been provided in the rar
* file
*
* @paramm descriptor deployment descriptor for the rar file
* @return result object containing the result of the individual test performed
*/
public Result check(ConnectorDescriptor descriptor) {
Result result = getInitializedResult();
ComponentNameConstructor compName = getVerifierContext().getComponentNameConstructor();
if (isCCIImplemented(descriptor, result)) {
// File jarFile = Verifier.getJarFile(descriptor.getModuleDescriptor().getArchiveUri());
// File
// f=Verifier.getArchiveFile(descriptor.getModuleDescriptor().getArchiveUri());
findImplementorOf(descriptor, "javax.resource.cci.ConnectionMetaData", result);
} else {
result.addNaDetails(
smh.getLocalString(
"tests.componentNameConstructor", "For [ {0} ]", new Object[] {compName.toString()}));
result.notApplicable(
smh.getLocalString(
"com.sun.enterprise.tools.verifier.tests.connector.cci.InteractionExistence.notapp",
"NotApplicable : The CCI interfaces do not seem to be implemented by this resource adapter"));
}
return result;
}
/**
* iterates over all declared filter in the archive file and delegates actual test on individual
* filter class to runIndividualFilterTest
*
* @param descriptor the Web deployment descriptor
* @return <code>Result</code> the results for this assertion
*/
public Result check(WebBundleDescriptor descriptor) {
Result result;
ComponentNameConstructor compName = getVerifierContext().getComponentNameConstructor();
Enumeration filterEnum = descriptor.getServletFilterDescriptors().elements();
if (filterEnum.hasMoreElements()) {
boolean oneFailed = false;
// test the filters in this .war
result = loadWarFile(descriptor);
while (filterEnum.hasMoreElements()) {
ServletFilterDescriptor filter = (ServletFilterDescriptor) filterEnum.nextElement();
Class filterClass = loadClass(result, filter.getClassName());
if (!runIndividualFilterTest(result, filterClass)) oneFailed = true;
}
if (oneFailed) {
result.setStatus(Result.FAILED);
} else {
result.setStatus(Result.PASSED);
}
} else {
result = getInitializedResult();
result.setStatus(Result.NOT_APPLICABLE);
result.addNaDetails(
smh.getLocalString(
"tests.componentNameConstructor", "For [ {0} ]", new Object[] {compName.toString()}));
result.notApplicable(
smh.getLocalString(
"com.sun.enterprise.tools.verifier.tests.web.FilterClass" + ".notApplicable",
"There are no filter components within the web archive [ {0} ]",
new Object[] {descriptor.getName()}));
}
return result;
}
/**
* Test for each message-listener , that "activationspec-class" implements
* "javax.resource.spi.ActivationSpec".
*
* @param descriptor deployment descriptor for the rar file
* @return result object containing the result of the individual test performed
*/
public Result check(ConnectorDescriptor descriptor) {
Result result = getInitializedResult();
ComponentNameConstructor compName = getVerifierContext().getComponentNameConstructor();
if (!descriptor.getInBoundDefined()) {
result.addNaDetails(
smh.getLocalString(
"tests.componentNameConstructor", "For [ {0} ]", new Object[] {compName.toString()}));
result.notApplicable(
smh.getLocalString(
"com.sun.enterprise.tools.verifier.tests.connector.messageinflow.notApp",
"Resource Adapter does not provide inbound communication"));
return result;
}
InboundResourceAdapter ra = descriptor.getInboundResourceAdapter();
Set msgListeners = ra.getMessageListeners();
boolean oneFailed = false;
Iterator iter = msgListeners.iterator();
while (iter.hasNext()) {
MessageListener msgListener = (MessageListener) iter.next();
String impl = msgListener.getActivationSpecClass();
Class implClass = null;
try {
implClass = Class.forName(impl, false, getVerifierContext().getClassLoader());
} catch (ClassNotFoundException e) {
result.addErrorDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.failed(
smh.getLocalString(
"com.sun.enterprise.tools.verifier.tests.connector.messageinflow.nonexist",
"Error: The class [ {0} ] as defined under activationspec-class in the deployment descriptor does not exist",
new Object[] {impl}));
return result;
}
if (!isImplementorOf(implClass, "javax.resource.spi.ActivationSpec")) {
oneFailed = true;
result.addErrorDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.failed(
smh.getLocalString(
getClass().getName() + ".failed",
"Error: activationspec-class [ {0} ] does not implement javax.resource.spi.ActivationSpec.",
new Object[] {impl}));
return result;
}
}
if (!oneFailed) {
result.addGoodDetails(
smh.getLocalString(
"tests.componentNameConstructor", "For [ {0} ]", new Object[] {compName.toString()}));
result.passed(
smh.getLocalString(
getClass().getName() + ".passed",
"Success: all activationspec-class implement javax.resource.spi.ActivationSpec"));
}
return result;
}
/**
* The Web form-error-page value defines the location in the web application where the page can be
* used for error page can be found within web application test
*
* @param descriptor the Web deployment descriptor
* @return <code>Result</code> the results for this assertion
*/
public Result check(WebBundleDescriptor descriptor) {
Result result = getInitializedResult();
ComponentNameConstructor compName = getVerifierContext().getComponentNameConstructor();
if (descriptor.getLoginConfiguration() != null) {
boolean foundIt = false;
// ZipEntry ze=null;
// JarFile jar=null;
FileArchive arch = null;
String formErrorPage = descriptor.getLoginConfiguration().getFormErrorPage();
if (formErrorPage.length() > 0) {
try {
// File f =
// Verifier.getArchiveFile(descriptor.getModuleDescriptor().getArchiveUri());
// if(f==null){
String uri = getAbstractArchiveUri(descriptor);
try {
arch = new FileArchive();
arch.open(uri);
} catch (IOException e) {
throw e;
}
// }else{
// jar = new JarFile(f);
// }
if (formErrorPage.startsWith("/")) formErrorPage = formErrorPage.substring(1);
// if (f!=null){
// ze = jar.getEntry(formErrorPage);
// foundIt = (ze != null);
// }
// else{
File fep = new File(new File(arch.getURI()), formErrorPage);
if (fep.exists()) foundIt = true;
fep = null;
// }
// if (jar!=null)
// jar.close();
} catch (Exception ex) {
// should be aldready set?
foundIt = false;
}
if (foundIt) {
result.addGoodDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.passed(
smh.getLocalString(
getClass().getName() + ".passed",
"The form-error-page [ {0} ] value defines the location in the web application where the error page that is displayed when login is not successful can be found within web application [ {1} ]",
new Object[] {formErrorPage, descriptor.getName()}));
} else {
result.addErrorDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.failed(
smh.getLocalString(
getClass().getName() + ".failed",
"Error: The form-error-page [ {0} ] value does not define the location in the web application where the error page that is displayed when login is not successful can be found within web application [ {1} ]",
new Object[] {formErrorPage, descriptor.getName()}));
}
} else {
result.addNaDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.notApplicable(
smh.getLocalString(
getClass().getName() + ".notApplicable",
"There are no form-error-page elements within this web archive [ {0} ]",
new Object[] {descriptor.getName()}));
}
} else {
result.addNaDetails(
smh.getLocalString(
"tests.componentNameConstructor", "For [ {0} ]", new Object[] {compName.toString()}));
result.notApplicable(
smh.getLocalString(
getClass().getName() + ".notApplicable",
"There are no form-error-page elements within this web archive [ {0} ]",
new Object[] {descriptor.getName()}));
}
return result;
}
/**
* Entity bean's Primary Key Class test. If the enterprise bean is a Entity Bean, the Bean
* provider specifies the fully qualified name of the Entity bean's primary key class in the
* "primary-class" element. The Bean provider 'must' specify the primary key class for an Entity
* with bean managed persistence, and 'may' (but is not required to) specify the primary key class
* for an Entity with Container-managed persistence.
*
* @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 (descriptor instanceof EjbEntityDescriptor) {
String persistence = ((EjbEntityDescriptor) descriptor).getPersistenceType();
if (EjbEntityDescriptor.BEAN_PERSISTENCE.equals(persistence)) {
logger.log(
Level.FINE,
getClass().getName() + ".debug1",
new Object[] {descriptor.getName(), "bean"});
String primkey = ((EjbEntityDescriptor) descriptor).getPrimaryKeyClassName();
if (!primkey.equals("java.lang.String")) {
try {
Class c = Class.forName(primkey, false, getVerifierContext().getClassLoader());
result.addGoodDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.passed(
smh.getLocalString(
getClass().getName() + ".passed",
"Primary Key Class [ {0} ] exist and is loadable",
new Object[] {primkey}));
} catch (Exception e) {
Verifier.debug(e);
result.addErrorDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.failed(
smh.getLocalString(
getClass().getName() + ".failedException",
"Error: Loading Primary Key Class [ {0} ]",
new Object[] {primkey}));
return result;
}
} else {
result.addGoodDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.passed(
smh.getLocalString(
getClass().getName() + ".passed1",
"Primary Key Class is [ {0} ]",
new Object[] {primkey}));
}
return result;
} else if (EjbEntityDescriptor.CONTAINER_PERSISTENCE.equals(persistence)) {
result.addNaDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.notApplicable(
smh.getLocalString(
getClass().getName() + ".notApplicable1",
"Entity Bean [ {0} ] with [ {1} ] managed persistence, primkey optional.",
new Object[] {descriptor.getName(), persistence}));
return result;
} else {
result.addNaDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.notApplicable(
smh.getLocalString(
getClass().getName() + ".notApplicable2",
"Expected [ {0} ] managed persistence, but [ {1} ] bean has [ {2} ] managed persistence.",
new Object[] {
EjbEntityDescriptor.BEAN_PERSISTENCE, descriptor.getName(), persistence
}));
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;
}
}
/**
* Entity Bean's ejbCreate(...) methods return 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:
*
* <p>The method name must be ejbCreate.
*
* <p>The return type must be primary key type.
*
* @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 (descriptor instanceof EjbEntityDescriptor) {
String persistence = ((EjbEntityDescriptor) descriptor).getPersistenceType();
if (EjbEntityDescriptor.BEAN_PERSISTENCE.equals(persistence)) {
boolean oneFailed = false;
boolean oneWarning = false;
int foundAtLeastOne = 0;
try {
Context context = getVerifierContext();
ClassLoader jcl = context.getClassLoader();
Class c =
Class.forName(
descriptor.getEjbClassName(), false, getVerifierContext().getClassLoader());
String primaryKeyType = ((EjbEntityDescriptor) descriptor).getPrimaryKeyClassName();
boolean ejbCreateFound = false;
boolean returnsPrimaryKeyType = false;
// start do while loop here....
do {
Method[] methods = c.getDeclaredMethods();
for (int i = 0; i < methods.length; i++) {
// reset flags from last time thru loop
ejbCreateFound = false;
returnsPrimaryKeyType = false;
// The method name must be ejbCreate.
if (methods[i].getName().startsWith("ejbCreate")) {
foundAtLeastOne++;
ejbCreateFound = true;
// The return type must be primary key type.
Class rt = methods[i].getReturnType();
if (rt.getName().equals(primaryKeyType)) {
returnsPrimaryKeyType = true;
}
// now display the appropriate results for this particular ejbCreate
// method
if (ejbCreateFound && !returnsPrimaryKeyType) {
if (primaryKeyType.equals("java.lang.Object")) {
oneWarning = true;
result.addWarningDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.addWarningDetails(
smh.getLocalString(
getClass().getName() + ".debug1",
"For EJB Class [ {0} ] method [ {1} ]",
new Object[] {descriptor.getEjbClassName(), methods[i].getName()}));
result.addWarningDetails(
smh.getLocalString(
getClass().getName() + ".warning",
"Warning: An [ {0} ] method was found, but [ {1} ] method has [ {2} ] return type. Deployment descriptor primary key type [ {3} ]. Definition of the primary key type is deferred to deployment time ?",
new Object[] {
methods[i].getName(),
methods[i].getName(),
methods[i].getReturnType().getName(),
primaryKeyType
}));
} else {
oneFailed = true;
result.addErrorDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.addErrorDetails(
smh.getLocalString(
getClass().getName() + ".debug1",
"For EJB Class [ {0} ] method [ {1} ]",
new Object[] {descriptor.getEjbClassName(), methods[i].getName()}));
result.addErrorDetails(
smh.getLocalString(
getClass().getName() + ".failed",
"Error: An [ {0} ] method was found, but [ {1} ] method has illegal return value. [ {2} ] methods must return primary key type [ {3} ].",
new Object[] {
methods[i].getName(),
methods[i].getName(),
methods[i].getName(),
primaryKeyType
}));
break;
}
}
}
}
if (oneFailed == true) break;
} while (((c = c.getSuperclass()) != null) && (foundAtLeastOne == 0));
if (foundAtLeastOne == 0) {
result.addNaDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.notApplicable(
smh.getLocalString(
getClass().getName() + ".notApplicable0",
"[ {0} ] does not declare any ejbCreate(...) methods.",
new Object[] {descriptor.getEjbClassName()}));
}
if (oneFailed == false && foundAtLeastOne > 0) {
result.addGoodDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.addGoodDetails(
smh.getLocalString(
getClass().getName() + ".debug1",
"For EJB Class [ {0} ]",
new Object[] {descriptor.getEjbClassName()}));
result.addGoodDetails(
smh.getLocalString(
getClass().getName() + ".passed",
"[ {0} ] properly declares ejbCreate<method> method to return primary key type [ {1} ].",
new Object[] {descriptor.getEjbClassName(), primaryKeyType}));
}
} 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;
}
if (oneFailed) {
result.setStatus(result.FAILED);
} else if (foundAtLeastOne == 0) {
result.setStatus(result.NOT_APPLICABLE);
} else {
if (oneWarning) {
result.setStatus(result.WARNING);
} else {
result.setStatus(result.PASSED);
}
}
return result;
} else { // if (CONTAINER_PERSISTENCE.equals(persistence)) {
result.addNaDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.notApplicable(
smh.getLocalString(
getClass().getName() + ".notApplicable1",
"Expected [ {0} ] managed persistence, but [ {1} ] bean has [ {2} ] managed persistence.",
new Object[] {
EjbEntityDescriptor.BEAN_PERSISTENCE, descriptor.getName(), persistence
}));
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;
}
}
/**
* Entity Bean's ejbPostCreate(...) methods test. Each entity Bean class may define zero or more
* ejbPostCreate(...) 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:
*
* <p>The method name must be ejbPostCreate.
*
* <p>The method must not be declared as static.
*
* @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 (descriptor instanceof EjbEntityDescriptor) {
boolean oneFailed = false;
int foundAtLeastOne = 0;
try {
Context context = getVerifierContext();
ClassLoader jcl = context.getClassLoader();
Class c =
Class.forName(
descriptor.getEjbClassName(), false, getVerifierContext().getClassLoader());
boolean ejbPostCreateFound = false;
boolean isStatic = false;
// start do while loop here....
do {
Method[] methods = c.getDeclaredMethods();
for (int i = 0; i < methods.length; i++) {
// reset flags from last time thru loop
ejbPostCreateFound = false;
isStatic = false;
// The method name must be ejbPostCreate.
if (methods[i].getName().startsWith("ejbPostCreate")) {
foundAtLeastOne++;
ejbPostCreateFound = true;
// The method must not be declared as final or static.
int modifiers = methods[i].getModifiers();
if (Modifier.isStatic(modifiers)) {
isStatic = true;
}
// now display the appropriate results for this particular
// ejbPostCreate method
if (ejbPostCreateFound && (!isStatic)) {
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[i].getName()}));
result.addGoodDetails(
smh.getLocalString(
getClass().getName() + ".passed",
"[ {0} ] properly declares non-static [ {1} ] method.",
new Object[] {descriptor.getEjbClassName(), methods[i].getName()}));
} else if (ejbPostCreateFound && isStatic) {
oneFailed = true;
result.addErrorDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.addErrorDetails(
smh.getLocalString(
getClass().getName() + ".debug1",
"For EJB Class [ {0} ] ejbPostCreate(...) Method [ {1} ]",
new Object[] {descriptor.getEjbClassName(), methods[i].getName()}));
result.addErrorDetails(
smh.getLocalString(
getClass().getName() + ".failed",
"Error: A static [ {0} ] method was found, but [ {1} ] cannot be declared as static.",
new Object[] {methods[i].getName(), methods[i].getName()}));
}
}
}
} while (((c = c.getSuperclass()) != null) && (foundAtLeastOne == 0));
if (foundAtLeastOne == 0) {
result.addNaDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.notApplicable(
smh.getLocalString(
getClass().getName() + ".notApplicable1",
"[ {0} ] does not declare any ejbPostCreate(...) methods.",
new Object[] {descriptor.getEjbClassName()}));
}
} 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;
}
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;
}
}
/**
* Entity bean's Primary Key Class type test. If the enterprise bean is a Entity Bean, the Bean
* provider specifies the fully qualified name of the Entity bean's primary key class in the
* "primary-class" element. The Bean provider 'must' specify the primary key class for an Entity
* with bean managed persistence, and 'may' (but is not required to) specify the primary key class
* for an Entity with Container-managed persistence.
*
* <p>Special case: Unknown primary key class In special situations, the Bean Provider may choose
* not to specify the primary key class for an entity bean with container-managed persistence.
* This case happens if the Bean Provider wants to allow the Deployer to select the primary key
* fields at deployment time. The Deployer uses instructions supplied by the Bean Provider (these
* instructions are beyond the scope of the EJB spec.) to define a suitable primary key class.
*
* <p>In this special case, the type of the argument of the findByPrimaryKey method must be
* declared as java.lang.Object, and the return value of ejbCreate() must be declared as
* java.lang.Object. The Bean Provider must specify the primary key class in the deployment
* descriptor as of the type java.lang.Object.
*
* <p>The primary key class is specified at deployment time when the Bean Provider develops
* enterprise beans that is intended to be used with multiple back-ends that provide persistence,
* and when these multiple back-ends require different primary key structures.
*
* @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 (descriptor instanceof EjbEntityDescriptor) {
String persistence = ((EjbEntityDescriptor) descriptor).getPersistenceType();
if (EjbEntityDescriptor.CONTAINER_PERSISTENCE.equals(persistence)) {
String primkey = ((EjbEntityDescriptor) descriptor).getPrimaryKeyClassName();
// primkey can be not set, via setting xml element
// <prim-key-class> to "java.lang.Object"
if (primkey.equals("java.lang.Object")) {
result.addGoodDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.passed(
smh.getLocalString(
getClass().getName() + ".passed",
"Properly defined primary key class type [ {0} ]",
new Object[] {"java.lang.Object"}));
} else {
result.addNaDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.notApplicable(
smh.getLocalString(
getClass().getName() + ".notApplicable1",
"Primary Key Class is [ {0} ]",
new Object[] {primkey}));
}
return result;
} else if (EjbEntityDescriptor.BEAN_PERSISTENCE.equals(persistence)) {
result.addNaDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.notApplicable(
smh.getLocalString(
getClass().getName() + ".notApplicable2",
"Entity Bean with [ {0} ] managed persistence, primkey mandatory.",
new Object[] {persistence}));
return result;
} else {
result.addNaDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.notApplicable(
smh.getLocalString(
getClass().getName() + ".notApplicable3",
"Expected [ {0} ] managed persistence, but [ {1} ] bean has [ {2} ] managed persistence.",
new Object[] {
EjbEntityDescriptor.CONTAINER_PERSISTENCE, descriptor.getName(), persistence
}));
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;
}
}
/**
* Define ejbFindByPrimaryKey method arguments test.
*
* <p>Every entity enterprise Bean class must define the ejbFindByPrimaryKey method.
*
* <p>The methods arguments types must be legal types for RMI-IIOP.
*
* @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 (descriptor instanceof EjbEntityDescriptor) {
String persistentType = ((EjbEntityDescriptor) descriptor).getPersistenceType();
if (EjbEntityDescriptor.BEAN_PERSISTENCE.equals(persistentType)) {
Class[] ejbFinderMethodParameterTypes;
boolean ejbFindByPrimaryKeyMethodFound = false;
boolean oneFailed = false;
boolean isLegalRMIIIOP = false;
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;
// The methods arguments types must be legal types for RMI-IIOP.
ejbFinderMethodParameterTypes = ejbFinderMethods[j].getParameterTypes();
if (RmiIIOPUtils.isValidRmiIIOPParameters(ejbFinderMethodParameterTypes)) {
// these method parameters are valid, continue
isLegalRMIIIOP = true;
}
if (ejbFindByPrimaryKeyMethodFound && isLegalRMIIIOP) {
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",
"An [ {0} ] method with valid RMI-IIOP argument types was found.",
new Object[] {ejbFinderMethods[j].getName()}));
} else if (ejbFindByPrimaryKeyMethodFound && (!isLegalRMIIIOP)) {
oneFailed = true;
result.addErrorDetails(
smh.getLocalString(
"tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.addErrorDetails(
smh.getLocalString(
getClass().getName() + ".debug1",
"For EJB Class [ {0} ] Finder Method [ {1} ]",
new Object[] {EJBClass.getName(), ejbFinderMethods[j].getName()}));
result.addErrorDetails(
smh.getLocalString(
getClass().getName() + ".failed",
"Error: An [ {0} ] method was found, but [ {1} ] method has illegal parameter values. [ {2} ] methods arguments types must be legal types for RMI-IIOP.",
new Object[] {
ejbFinderMethods[j].getName(),
ejbFinderMethods[j].getName(),
ejbFinderMethods[j].getName()
}));
}
// 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() + ".failed1",
"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 {
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;
}
}