org.opencastproject.util.persistencefn.OsgiPersistenceEnvUser Maven / Gradle / Ivy
/**
* Licensed to The Apereo Foundation under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
*
* The Apereo Foundation licenses this file to you under the Educational
* Community License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of the License
* at:
*
* http://opensource.org/licenses/ecl2.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*
*/
package org.opencastproject.util.persistencefn;
import java.util.Map;
import javax.persistence.spi.PersistenceProvider;
/**
* Definition of a contract for the use of a {@link org.opencastproject.util.persistence.PersistenceEnv} in an OSGi environment.
*
* Use in conjunction with {@link org.opencastproject.util.persistence.PersistenceEnvBuilder}.
*/
public interface OsgiPersistenceEnvUser {
/** OSGi callback to set persistence properties. */
void setPersistenceProperties(Map persistenceProperties);
/** OSGi callback to set persistence provider. */
void setPersistenceProvider(PersistenceProvider persistenceProvider);
/**
* Return the persistence environment.
*
* Create the persistence environment in the activate method like so:
*
* penv = PersistenceEnvs.persistenceEnvironment(persistenceProvider, "my.persistence.context", persistenceProperties);
*
* Or better use the {@link org.opencastproject.util.persistence.PersistenceEnvBuilder}.
*/
PersistenceEnv getPenv();
/** Close the persistence environment {@link org.opencastproject.util.persistence.PersistenceEnv#close()}. Call from the deactivate method. */
void closePenv();
}