/*
 * 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.timer;

import com.sun.enterprise.deployment.EjbDescriptor;
import com.sun.enterprise.deployment.EjbEntityDescriptor;
import com.sun.enterprise.deployment.EjbSessionDescriptor;
import com.sun.enterprise.tools.verifier.Result;
import com.sun.enterprise.tools.verifier.tests.ComponentNameConstructor;
import com.sun.enterprise.tools.verifier.tests.ejb.EjbTest;

/**
 * Checks if the EJB class implements the TimedObject interface 
 *
 * @version
 * @author Anisha Malhotra
 */
public class ImplementsTimedObjectTest extends EjbTest {

    ComponentNameConstructor compName = null;
    /**
     * Checks if the EJB class implements the TimedObject interface
     *
     * @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();
        boolean isEjb30 = descriptor.getEjbBundleDescriptor().getSpecVersion().equalsIgnoreCase("3.0");
        if(descriptor.isTimedObject()) {
            //Timers can be created for stateless session beans, message-driven beans,
            //and 2.1 entity beans.Timers cannot be created for stateful session beans or EJB 3.0 entities.
            if(((descriptor instanceof EjbEntityDescriptor) && isEjb30)
                    || ( (descriptor instanceof EjbSessionDescriptor) &&
                    ((((EjbSessionDescriptor)descriptor).getSessionType()).equals
                    (EjbSessionDescriptor.STATEFUL)) )) {
                addErrorDetails(result, compName);
                result.failed(smh.getLocalString(getClass().getName()+
                        ".failed1", "[ {0} ] must not implement the TimedObject interface." +
                        "Only 2.1 entity beans or stateless session beans may " +
                        "implement the TimedObject interface" ,
                        new Object[] {descriptor.getEjbClassName()}));
            }
        }
        if(result.getStatus() != Result.FAILED) {
            addGoodDetails(result, compName);
            result.passed(smh.getLocalString (getClass().getName()+".passed",
                    "[ {0} ] properly implements the TimedObject interface",
                    new Object[] {descriptor.getEjbClassName()}));

        }
        return result;
    }
}
