src/javax/persistence/spi/PersistenceProviderResolver.java

/*******************************************************************************
 * Copyright (c) 1998, 2009 Oracle. All rights reserved. 
 * 
 * This program and the accompanying materials are made available under the 
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0 
 * which accompanies this distribution. 
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at 
 * http://www.eclipse.org/org/documents/edl-v10.php.
 * 
 * Contributors:
 *     dclarke - Java Persistence 2.0 - Proposed Final Draft (March 13, 2009)
 *     		     Specification available from http://jcp.org/en/jsr/detail?id=317
 *
 * Java(TM) Persistence API, Version 2.0 - EARLY ACCESS
 * This is an implementation of an early-draft specification developed under the 
 * Java Community Process (JCP).  The code is untested and presumed not to be a  
 * compatible implementation of JSR 317: Java(TM) Persistence API, Version 2.0.   
 * We encourage you to migrate to an implementation of the Java(TM) Persistence 
 * API, Version 2.0 Specification that has been tested and verified to be compatible 
 * as soon as such an implementation is available, and we encourage you to retain 
 * this notice in any implementation of Java(TM) Persistence API, Version 2.0 
 * Specification that you distribute.
 ******************************************************************************/
package javax.persistence.spi;

import java.util.List;

/**
 * Determine the list of persistence providers available in the runtime
 * environment
 * 
 * Persistence providers are identified by the presence of
 * META-INF/services/javax.persistence.spi.PersistenceProvider files following
 * the Service Provider pattern.
 * 
 * Each META-INF/services/javax.persistence.spi.PersistenceProvider file
 * contains the name of the provider implementation class of the
 * javax.persistence.spi.PersistenceProvider interface.
 * 
 * Implementations must be thread-safe.
 * 
 */
public interface PersistenceProviderResolver {
    /**
     * Returns a list of PersistenceProvider implementations available in the
     * runtime environment.
     * 
     * @return list of persistence providers available in the environment
     */
    List<PersistenceProvider> getPersistenceProviders();
}