jakarta.resource.Referenceable Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.resource;
import javax.naming.Reference;
/** The Referenceable interface extends the javax.naming.Referenceable
* interface. It enables support for JNDI Reference mechanism for
* the registration of the connection factory in the JNDI name space.
* Note that the implementation and structure of Reference is specific
* to an application server.
*
* The implementation class for a connection factory interface is
* required to implement both java.io.Serializable and
* jakarta.resource.Referenceable interfaces to support JNDI registration.
*
* @version 0.9
* @author Rahul Sharma
*
**/
public interface Referenceable extends javax.naming.Referenceable {
/** Sets the Reference instance. This method is called by the
* deployment code to set the Reference that can be later
* returned by the getReference method (as defined in the
* javax.naming.Referenceable interface).
*
* @param reference A Reference instance
* @see javax.naming.Referenceable#getReference
*
**/
public
void setReference(Reference reference);
}