javax.persistence.spi.PersistenceProviderResolver Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2008, 2009, 2011 Oracle, Inc. 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.
 */
package javax.persistence.spi;

import java.util.List;

/**
 * Determine the list of persistence providers available in the runtime environment.
 * 
 * Implementations must be thread-safe.
 * 
 * Note that the getPersistenceProviders method can potentially be called many times: it is
 * recommended that the implementation of this method make use of caching.
 * @see PersistenceProvider
 */
public interface PersistenceProviderResolver
{
    /**
     * Returns a list of the PersistenceProvider implementations available in the runtime environment.
     * @return list of the persistence providers available in the environment
     */
    List getPersistenceProviders();

    /**
     * Clear cache of providers.
     */
    void clearCachedProviders();
}