/*
* 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;
import com.sun.enterprise.tools.verifier.tests.VerifierTest;
import com.sun.enterprise.tools.verifier.tests.VerifierCheck;
import com.sun.enterprise.tools.verifier.*;
import com.sun.enterprise.deployment.*;
import com.sun.enterprise.deployment.util.ModuleDescriptor;
import com.sun.enterprise.tools.verifier.Verifier;
import java.lang.ClassLoader;
import com.sun.enterprise.tools.verifier.tests.*;
import com.sun.enterprise.util.io.FileUtils;
import java.io.File;
/**
* Superclass for all EJB tests, contains common services.
*
* @author Jerome Dochez
* @version
*/
public abstract class EjbTest extends VerifierTest implements VerifierCheck, EjbCheck
{
/**
* <p>
* run an individual test against the deployment descriptor for the
* archive the verifier is performing compliance tests against.
* </p>
*
* @param descriptor deployment descriptor for the archive
* @return result object containing the result of the individual test
* performed
*/
public Result check(Descriptor descriptor) {
try {
return check((EjbDescriptor) descriptor);
}
catch(Throwable t) {
// Note : We assume that each test which loads a class
// would have its own ClassNotFoundException block
ComponentNameConstructor compName = getVerifierContext().getComponentNameConstructor();
Result r = getInitializedResult();
if (t instanceof java.lang.NoClassDefFoundError) {
String s = t.toString();
String className = s.substring(s.indexOf(":"));
addWarningDetails(r, compName);
r.warning(smh.getLocalString
("com.sun.enterprise.tools.verifier.checkinclasspath",
"The class [ {0} ] was not found, check manifest classpath, or make sure it is available in classpath at runtime.",
new Object[] {className}));
return r;
}
else
throw new RuntimeException(t);
}
}
/**
* <p>
* all connector tests should implement this method. it run an individual
* test against the resource adapter deployment descriptor.
* </p>
*
* @param descriptor deployment descriptor for the archive file
* @return result object containing the result of the individual test
* performed
*/
public abstract Result check(EjbDescriptor descriptor);
/**
* <p>
* load the declared EJB class from the archive
* </p>
*
* @param descriptor the deployment descriptors for the EJB
* @param result result to use if the load fails
* @return the class object for the EJB component
*/
protected Class loadEjbClass(EjbDescriptor descriptor, Result result) {
ComponentNameConstructor compName = getVerifierContext().getComponentNameConstructor();
try {
return Class.forName(descriptor.getEjbClassName(), false, getVerifierContext().getClassLoader());
} catch (ClassNotFoundException e) {
Verifier.debug(e);
addErrorDetails(result, compName);
result.failed(smh.getLocalString
("com.sun.enterprise.tools.verifier.tests.ejb.EjbTest.failedException",
"Error: [ {0} ] class not found.",
new Object[] {descriptor.getEjbClassName()}));
return null;
}
}
protected String getAbstractArchiveUri(EjbDescriptor desc) {
String archBase = getVerifierContext().getAbstractArchive().
getURI().toString();
final ModuleDescriptor moduleDescriptor = desc.getEjbBundleDescriptor().
getModuleDescriptor();
if (moduleDescriptor.isStandalone()) {
return archBase; // it must be a stand-alone module; no such physical dir exists
} else {
return archBase + "/" +
FileUtils.makeFriendlyFilename(moduleDescriptor.getArchiveUri());
}
}
public boolean implementsEndpoints(EjbDescriptor descriptor) {
BundleDescriptor bdesc = descriptor.getEjbBundleDescriptor();
if (bdesc.hasWebServices()) {
WebServicesDescriptor wdesc = bdesc.getWebServices();
if (wdesc.hasEndpointsImplementedBy(descriptor))
return true;
}
return false;
}
public String getArchiveURI(EjbDescriptor desc){
// if (Verifier.getEarFile()==null){
return getAbstractArchiveUri(desc);
/*
}else{
String uri = getVerifierContext().getStdAloneArchiveURI();
String moduleName = desc.getEjbBundleDescriptor().
getModuleDescriptor().getArchiveUri();
String moduleDir = moduleName.replace('.', '_');
uri=uri+File.separator+moduleDir;
return uri;
}
*/
}
}