/**
* All methods should have a
*
* @param descriptor the Enterprise Java Bean deployment descriptor
* @return <code>Result</code> the results for this assertion
*/
public Result check(EjbDescriptor descriptor) {
result = getInitializedResult();
// boolean oneFailed = false;
try {
if (descriptor instanceof EjbSessionDescriptor || descriptor instanceof EjbEntityDescriptor) {
Set methods = descriptor.getMethodDescriptors();
// Set methodPermissions = new HashSet();
boolean noPermissions = false;
for (Iterator i = methods.iterator(); i.hasNext(); ) {
MethodDescriptor md = (MethodDescriptor) i.next();
Set permissions = descriptor.getMethodPermissionsFor(md);
if (permissions.isEmpty() || (permissions == null)) {
result.addWarningDetails(
smh.getLocalString(
getClass().getName() + ".failed",
"Warning: Method [ {0} ] of EJB [ {1} ] does not have assigned security-permissions",
new Object[] {md.getName(), descriptor.getName()}));
result.setStatus(result.WARNING);
noPermissions = true;
}
}
if (!noPermissions) {
result.passed(
smh.getLocalString(
getClass().getName() + ".passed",
"Valid: All [ {0} ]EJB interfaces methods have security-permissions assigned.",
new Object[] {descriptor.getName()}));
}
} else {
result.notApplicable(
smh.getLocalString(
getClass().getName() + ".notApplicable",
"The bean [ {0} ] is neither a Session nor Entity Bean",
new Object[] {descriptor.getName()}));
return result;
}
} catch (Exception e) {
result.failed(
smh.getLocalString(
getClass().getName() + ".exception",
"The test generated the following exception [ {0} ]",
new Object[] {e.getLocalizedMessage()}));
}
return result;
}
private void commonToBothInterfaces(String intf, EjbDescriptor descriptor) {
try {
Class intfClass = Class.forName(intf, false, getVerifierContext().getClassLoader());
for (Method remoteMethod : intfClass.getMethods()) {
// we don't test the EJB methods
if (remoteMethod.getDeclaringClass().getName().equals("javax.ejb.EJBObject")) continue;
Class beanClass =
Class.forName(
descriptor.getEjbClassName(), false, getVerifierContext().getClassLoader());
for (Method method : beanClass.getMethods()) {
if (method.getName().equals(remoteMethod.getName())
&& !RmiIIOPUtils.isValidRmiIIOPReturnType(method.getReturnType())) {
// The methods arguments types must be legal types for
// RMI-IIOP. This means that their return values must
// be of valid types for RMI-IIOP,
addErrorDetails(result, compName);
result.failed(
smh.getLocalString(
getClass().getName() + ".failed",
"Error: business method [ {0} ] was found, but "
+ "business method has invalid return type [ {1} ]. Business "
+ "method return type must be a valid type for RMI-IIOP.",
new Object[] {method.getName(), method.getReturnType()}));
}
}
}
} catch (ClassNotFoundException e) {
Verifier.debug(e);
addErrorDetails(result, compName);
result.failed(
smh.getLocalString(
getClass().getName() + ".failedException",
"Error: Remote interface [ {0} ] or bean class [ {1} ] does "
+ "not exist or is not loadable within bean [ {2} ].",
new Object[] {
descriptor.getRemoteClassName(), descriptor.getEjbClassName(), descriptor.getName()
}));
}
}
/**
* Enterprise Bean's business(...) methods argument RMI IIOP test. Each enterprise Bean class must
* define zero or more business(...) methods. The method signatures must follow these rules:
*
* <p>The methods return value 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 = getInitializedResult();
compName = getVerifierContext().getComponentNameConstructor();
if ((descriptor instanceof EjbSessionDescriptor)
|| (descriptor instanceof EjbEntityDescriptor)) {
if (descriptor.getRemoteClassName() != null && !"".equals(descriptor.getRemoteClassName()))
commonToBothInterfaces(descriptor.getRemoteClassName(), descriptor);
Set<String> remoteInterfaces = descriptor.getRemoteBusinessClassNames();
for (String remoteIntf : remoteInterfaces) commonToBothInterfaces(remoteIntf, descriptor);
}
if (result.getStatus() != Result.FAILED) {
addGoodDetails(result, compName);
result.passed(
smh.getLocalString(
getClass().getName() + ".passed", "Proper declaration of business method(s) found."));
}
return result;
}
/**
* The ejb element specifies the URI of a ejb-jar, relative to the top level of the application
* package.
*
* @param descriptor the Application deployment descriptor
* @return <code>Result</code> the results for this assertion
*/
public Result check(Application descriptor) {
Result result = getInitializedResult();
if (descriptor.getBundleDescriptors(EjbBundleDescriptor.class).size() > 0) {
boolean oneFailed = false;
for (Iterator itr = descriptor.getBundleDescriptors(EjbBundleDescriptor.class).iterator();
itr.hasNext(); ) {
EjbBundleDescriptor ejbd = (EjbBundleDescriptor) itr.next();
// not sure what we can do to test this string?
if (ejbd.getModuleDescriptor().getArchiveUri().endsWith(".jar")) {
result.passed(
smh.getLocalString(
getClass().getName() + ".passed",
"[ {0} ] specifies the URI [ {1} ] of an ejb-jar, relative to the top level of the application package [ {2} ].",
new Object[] {
ejbd.getName(), ejbd.getModuleDescriptor().getArchiveUri(), descriptor.getName()
}));
} else {
if (!oneFailed) {
oneFailed = true;
}
result.addErrorDetails(
smh.getLocalString(
getClass().getName() + ".failed",
"Error: [ {0} ] does not specify the URI [ {1} ] of an ejb-jar, relative to the top level of the application package [ {2} ], or does not end with \".jar\"",
new Object[] {
ejbd.getName(), ejbd.getModuleDescriptor().getArchiveUri(), descriptor.getName()
}));
}
}
if (oneFailed) {
result.setStatus(Result.FAILED);
} else {
result.setStatus(Result.PASSED);
}
} else {
result.notApplicable(
smh.getLocalString(
getClass().getName() + ".notApplicable",
"There are no ejb components in application [ {0} ]",
new Object[] {descriptor.getName()}));
}
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 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;
}
}
/**
* The alt-dd element specifies a URI to the post-assembly deployment descriptor relative to the
* root of the application
*
* @param descriptor the Application deployment descriptor
* @return <code>Result</code> the results for this assertion
*/
public Result check(Application descriptor) {
Result result = getInitializedResult();
if (descriptor.getEjbBundleDescriptors().size() > 0) {
boolean oneFailed = false;
int na = 0;
for (Iterator itr = descriptor.getEjbBundleDescriptors().iterator(); itr.hasNext(); ) {
EjbBundleDescriptor ejbd = (EjbBundleDescriptor) itr.next();
if (ejbd.getModuleDescriptor().getAlternateDescriptor() != null) {
if (!(ejbd.getModuleDescriptor().getAlternateDescriptor().equals(""))) {
JarFile jarFile = null;
InputStream deploymentEntry = null;
// File f = null;
// if (Verifier.getEarFile() != null)
// f = new File(Verifier.getEarFile());
try {
// if (f==null){
String uri = getAbstractArchiveUri(descriptor);
// try {
FileArchive arch = new FileArchive();
arch.open(uri);
deploymentEntry = arch.getEntry(ejbd.getModuleDescriptor().getAlternateDescriptor());
// }catch (Exception e) { }
// }else{
//
// jarFile = new JarFile(f);
// ZipEntry deploymentEntry1 =
// jarFile.getEntry(ejbd.getModuleDescriptor().getAlternateDescriptor());
// if (deploymentEntry1 != null){
// deploymentEntry =
// jarFile.getInputStream(deploymentEntry1);
// }
// }
if (deploymentEntry != null) {
result.addGoodDetails(
smh.getLocalString(
getClass().getName() + ".passed",
"Found alternate EJB deployment descriptor URI file [ {0} ] within [ {1} ]",
new Object[] {
ejbd.getModuleDescriptor().getAlternateDescriptor(), ejbd.getName()
}));
} else {
if (!oneFailed) {
oneFailed = true;
}
result.addErrorDetails(
smh.getLocalString(
getClass().getName() + ".failed",
"Error: No alternate EJB deployment descriptor URI file found, looking for [ {0} ] within [ {1} ]",
new Object[] {
ejbd.getModuleDescriptor().getAlternateDescriptor(), ejbd.getName()
}));
}
// jarFile.close();
} catch (FileNotFoundException ex) {
Verifier.debug(ex);
if (!oneFailed) {
oneFailed = true;
}
result.failed(
smh.getLocalString(
getClass().getName() + ".failedException",
"Error: File not found trying to read deployment descriptor file [ {0} ] within [ {1} ]",
new Object[] {
ejbd.getModuleDescriptor().getAlternateDescriptor(), ejbd.getName()
}));
} catch (IOException ex) {
Verifier.debug(ex);
if (!oneFailed) {
oneFailed = true;
}
result.failed(
smh.getLocalString(
getClass().getName() + ".failedException1",
"Error: IO Error trying to read deployment descriptor file [ {0} ] within [ {1} ]",
new Object[] {
ejbd.getModuleDescriptor().getAlternateDescriptor(), ejbd.getName()
}));
} finally {
try {
if (deploymentEntry != null) deploymentEntry.close();
} catch (Exception x) {
}
}
}
} else {
na++;
result.notApplicable(
smh.getLocalString(
getClass().getName() + ".notApplicable1",
"There is no java EJB alternative deployment descriptor in [ {0} ]",
new Object[] {ejbd.getName()}));
}
}
if (oneFailed) {
result.setStatus(Result.FAILED);
} else if (na == descriptor.getEjbBundleDescriptors().size()) {
result.setStatus(Result.NOT_APPLICABLE);
} else {
result.setStatus(Result.PASSED);
}
} else {
result.notApplicable(
smh.getLocalString(
getClass().getName() + ".notApplicable",
"There are no EJB components in application [ {0} ]",
new Object[] {descriptor.getName()}));
}
return result;
}
