javax.ejb.TimedObject.java Source code

Java tutorial

Introduction

Here is the source code for javax.ejb.TimedObject.java

Source

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2018 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://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or 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 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 javax.ejb;

import java.io.Serializable;

/**
 * The <code>TimedObject</code> interface contains a callback method
 * that is used to deliver timer expiration notifications.  It can be
 * implemented by a stateless session bean class, a singleton session
 * bean class, a message-driven bean class, or an EJB 2.x entity bean class.
 * <p>
 * If the bean implements the <code>TimedObject</code> interface, the
 * <code>Timeout</code> annotation, if used, can only be applied to 
 * the <code>ejbTimeout</code> method.
 *
 * @see Timeout
 *
 * @since EJB 2.1
 */
public interface TimedObject {

    /**
     * Invoked by the EJB container upon timer expiration.
     *
     * @param timer timer whose expiration caused this notification.
     *
     */
    public void ejbTimeout(Timer timer);

}