com.sun.appserv.ejb.ReadOnlyBeanNotifier Maven / Gradle / Ivy
/*
* 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.appserv.ejb;
import java.rmi.RemoteException;
import org.jvnet.hk2.annotations.Contract;
import org.glassfish.persistence.ejb.entitybean.container.spi.ReadOnlyEJBHome;
/**
* ReadOnlyBeanNotifier is used to force refresh of ReadOnly beans
*
* @author Mahesh Kannan
*/
@Contract
public interface ReadOnlyBeanNotifier
extends java.rmi.Remote
{
/**
* This method would be used by the user to manually force the
* refresh of read only beans for an application. After this method
* the next access to the bean, identified by the primary key, will
* cause a ejbLoad() to be called on the bean
*
* @param The primary of the bean to be refreshed
*/
public void refresh(Object primaryKey)
throws RemoteException;
/**
* This method forces *all* primary keys for a read-only bean
* to be marked as needing a refresh.
*/
public void refreshAll()
throws RemoteException;
/**
* This is an init method for the helper class not to depend on the impl
*/
public void setHome(ReadOnlyEJBHome home) throws RemoteException;
}