RemoteInterfaceRmiIIOPException.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2012 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.intf.remoteintf;

import com.sun.enterprise.deployment.MethodDescriptor;
import com.sun.enterprise.tools.verifier.Result;
import com.sun.enterprise.tools.verifier.tests.ComponentNameConstructor;
import com.sun.enterprise.tools.verifier.tests.ejb.RmiIIOPUtils;
import com.sun.enterprise.tools.verifier.tests.ejb.intf.InterfaceMethodTest;
import org.glassfish.ejb.deployment.descriptor.EjbDescriptor;

import java.lang.reflect.Method;

/**
 * Remote interface business method throws clause must include the 
 *   java.rmi.RemoteException test.
 * Verify the following:
 * 
 *   The methods defined in this interface must follow the rules for RMI-IIOP. 
 *   This means that their throws clause must include the 
 *   java.rmi.RemoteException. 
 * 
 */
public class RemoteInterfaceRmiIIOPException extends InterfaceMethodTest { 
    
    /**
     * <p>
     * run an individual verifier test against a declared method of the 
     * remote interface.
     * </p>
     * 
     * @param descriptor the deployment descriptor for the bean
     * @param method the method to run the test on
     * @return true if the test passes
     */
    protected boolean runIndividualMethodTest(EjbDescriptor descriptor, Method method, Result result) {
        
        Class[] methodExceptionTypes = method.getExceptionTypes();
        ComponentNameConstructor compName = getVerifierContext().getComponentNameConstructor();	  
        // The methods arguments types must be legal types for
        // RMI-IIOP.  This means that their exception values must
        // throw java.rmi.RemoteException
        // methods must also throw java.rmi.RemoteException
        if (RmiIIOPUtils.isValidRmiIIOPException(methodExceptionTypes)) {
            // this is the right exception for method, throws RemoteException
            addGoodDetails(result, compName);
            result.addGoodDetails(smh.getLocalString
                    (getClass().getName() + ".passed",
                    "[ {0} ] method properly throws java.rmi.RemoteException.",
                    new Object[] {method.getName()}));
            return true;
        } else {
            addErrorDetails(result, compName);
            result.addErrorDetails(smh.getLocalString
                    (getClass().getName() + ".failed",
                    "Error: [ {0} ] method was found, but does not properly " +
                    "throw java.rmi.RemoteException.",
                    new Object[] {method.getName()}));
            return false;
        }
    } 
    protected String getInterfaceName(EjbDescriptor descriptor) {
        return descriptor.getRemoteClassName();
    }
    
    protected String getInterfaceType() {
        return MethodDescriptor.EJB_REMOTE;
    }
}