/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. 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.html
* or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [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.deployment.*;
import java.lang.ClassLoader;
import java.util.*;
import java.lang.reflect.*;
import com.sun.enterprise.tools.verifier.*;
import com.sun.enterprise.tools.verifier.tests.*;
/**
* ContainerTransaction Style 3 - Each container transaction element consists
* of a list of one or more method elements, and the trans-attribute element.
* The container transaction element specifies that all the listed methods are
* assigned the specified transaction attribute value.
*
* Style 3:
* <method>
* <ejb-name> EJBNAME</ejb-name>
* <method-name>METHOD</method-name>
* <method-param> PARAMETER_1</method-param>
* ...
* <method-param> PARAMETER_N</method-param>
* </method>
* This style is used to refer to a single method within a set of methods with
* an overloaded name. The method must be one defined in the remote or home
* interface of the specified enterprise bean. If there is also a container
* transaction element that uses the Style 2 element for the method name, or
* the Style 1 element for the bean, the value specified by the Style 3 element
* takes precedence.
*/
public class ContainerTransactionStyle3 extends EjbTest implements EjbCheck {
private Result result = null;
private ComponentNameConstructor compName = null;
private EjbDescriptor descriptor = null;
private Method[] homeMethods = null;
private Method[] localHomeMethods = null;
private Method[] remoteMethods = null;
private Method[] localMethods = null;
private Method[] serviceMethods = null;
/**
* ContainerTransaction Style 3 - Each container transaction element consists
* of a list of one or more method elements, and the trans-attribute element.
* The container transaction element specifies that all the listed methods are
* assigned the specified transaction attribute value.
*
* Style 3:
* <method>
* <ejb-name> EJBNAME</ejb-name>
* <method-name>METHOD</method-name>
* <method-param> PARAMETER_1</method-param>
* ...
* <method-param> PARAMETER_N</method-param>
* </method>
*
* This style is used to refer to a single method within a set of methods with
* an overloaded name. The method must be one defined in the remote or home
* interface of the specified enterprise bean. If there is also a container
* transaction element that uses the Style 2 element for the method name, or
* the Style 1 element for the bean, the value specified by the Style 3 element
* takes precedence.
*
* @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();
this.descriptor = descriptor;
if (!(descriptor instanceof EjbSessionDescriptor) &&
!(descriptor instanceof EjbEntityDescriptor)) {
result.notApplicable(smh.getLocalString
("com.sun.enterprise.tools.verifier.tests.ejb.homeintf.HomeMethodTest.notApplicable1",
"Test apply only to session or entity beans."));
return result;
}
// The method must be one defined in the remote, home or business interface of
// the specified enterprise bean.
if (!descriptor.getMethodContainerTransactions().isEmpty())
commonToAllInterfaces();
if(result.getStatus() != Result.FAILED) {
addGoodDetails(result, compName);
result.passed(smh.getLocalString
(getClass().getName() + ".passed",
"Valid container transaction methods."));
}
return result;
}
/**
* Iterate over all the bean methods and check if they are present in any
* of the bean's interfaces.
*/
private void commonToAllInterfaces() {
boolean isTimedObject=false;
try {
ClassLoader jcl = getVerifierContext().getClassLoader();
Class beanClass = Class.forName(descriptor.getEjbClassName(), false, jcl);
isTimedObject = javax.ejb.TimedObject.class.isAssignableFrom(beanClass);
} catch (ClassNotFoundException e) {} //continue
initializeMethods();
for (Enumeration ee = descriptor.getMethodContainerTransactions().keys(); ee.hasMoreElements();) {
MethodDescriptor methodDescriptor = (MethodDescriptor) ee.nextElement();
if (methodDescriptor.getName().equals(MethodDescriptor.ALL_EJB_METHODS) ||
methodDescriptor.getParameterClassNames() == null) // style 1 and 2
continue;
if(isTimedObject &&
MethodDescriptor.EJB_BEAN.equals(methodDescriptor.getEjbClassSymbol()) &&
methodDescriptor.getName().equals("ejbTimeout")) {
String[] params=methodDescriptor.getJavaParameterClassNames();
if(params.length==1 && params[0].trim().equals("javax.ejb.Timer"))
continue;//found a match
}//if implements timer
Set<Method> methods = getAllInterfaceMethods(methodDescriptor);
if(!isMethodContained(methods, methodDescriptor)) { // report failure
String ejbClassSymbol = methodDescriptor.getEjbClassSymbol();
String intf = ejbClassSymbol;
if(ejbClassSymbol == null) {
intf = smh.getLocalString(getClass().getName() + ".msg", "any of bean");
} else if(ejbClassSymbol.equals(MethodDescriptor.EJB_REMOTE)) {
intf = "Remote or RemoteBusiness";
} else if(ejbClassSymbol.equals(MethodDescriptor.EJB_LOCAL)) {
intf = "Local or LocalBusiness";
}
addErrorDetails(result, compName);
result.failed(smh.getLocalString
(getClass().getName() + ".failed",
"Error: Container Transaction method name [ {0} ] not " +
"defined in [ {1} ] interface(s).",
new Object[] {methodDescriptor.getName(), intf}));
}
}
}
/** get methods from all of bean's interfaces*/
private void initializeMethods() {
homeMethods = getMethods(descriptor.getHomeClassName());
localHomeMethods = getMethods(descriptor.getLocalHomeClassName());
remoteMethods = getMethods(descriptor.getRemoteClassName());
remoteMethods = getBusinessMethods(descriptor.getRemoteBusinessClassNames(),remoteMethods);
localMethods = getMethods(descriptor.getLocalClassName());
localMethods = getBusinessMethods(descriptor.getLocalBusinessClassNames(), localMethods);
serviceMethods = getMethods(descriptor.getWebServiceEndpointInterfaceName());
}
/** Collect all the methods the bean interfaces specified in methodDescriptor*/
private Set<Method> getAllInterfaceMethods(MethodDescriptor methodDescriptor) {
Set<Method> methods = new HashSet<Method>();
String methodIntf = methodDescriptor.getEjbClassSymbol();
if((methodIntf == null)) {
methods.addAll(Arrays.asList(homeMethods));
methods.addAll(Arrays.asList(localHomeMethods));
methods.addAll(Arrays.asList(remoteMethods));
methods.addAll(Arrays.asList(localMethods));
methods.addAll(Arrays.asList(serviceMethods));
} else if(methodIntf.equals(MethodDescriptor.EJB_HOME)) {
methods.addAll(Arrays.asList(homeMethods));
} else if(methodIntf.equals(MethodDescriptor.EJB_LOCALHOME)) {
methods.addAll(Arrays.asList(localHomeMethods));
} else if(methodIntf.equals(MethodDescriptor.EJB_REMOTE)) {
methods.addAll(Arrays.asList(remoteMethods));
} else if(methodIntf.equals(MethodDescriptor.EJB_LOCAL)) {
methods.addAll(Arrays.asList(localMethods));
} else if(methodIntf.equals(MethodDescriptor.EJB_WEB_SERVICE)) {
methods.addAll(Arrays.asList(serviceMethods));
}
return methods;
}
/** get all the methods defined in the given class clsName*/
private Method[] getMethods(String clsName) {
if(clsName==null)
return new Method[]{};
ClassLoader jcl = getVerifierContext().getClassLoader();
try {
Class cls = Class.forName(clsName, false, jcl);
return cls.getMethods();
} catch (ClassNotFoundException e) {} // ignore and continue
return new Method[]{};
}
/** returns an array of business methods that are collected from set classNames*/
private Method[] getBusinessMethods(Set<String> classNames, Method[] intfMethods) {
if(!classNames.isEmpty()) {
List<Method> methods = new ArrayList<Method>();
for (String clsName : classNames) {
Method[] methodArray = getMethods(clsName);
if(methodArray != null)
methods.addAll(Arrays.asList(methodArray));
}
if(intfMethods != null)
methods.addAll(Arrays.asList(intfMethods));
return methods.toArray(new Method[]{});
}
return intfMethods;
}
/** returns true if methodDescriptor is contained in the set methods */
private boolean isMethodContained(Set<Method> methods, MethodDescriptor methodDescriptor) {
boolean foundIt = false;
for (Method method : methods) {
if(method.getName().equals(methodDescriptor.getName()) &&
MethodUtils.stringArrayEquals(methodDescriptor.getParameterClassNames(),
(new MethodDescriptor(method)).getParameterClassNames())) {
foundIt = true;
break;
}
}
return foundIt;
}
}
|
