code style improvements.
[utils] / test / enterprise / src / main / java / org / wamblee / support / persistence / JpaCustomizer.java
1 /*
2  * Copyright 2005-2010 the original author or authors.
3  * 
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  * 
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  * 
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */ 
16 package org.wamblee.support.persistence;
17
18 import java.util.Map;
19 import java.util.ServiceLoader;
20
21 import org.dbunit.dataset.filter.ITableFilterSimple;
22
23 /**
24  * JPA customizer is used to customize properties for a given JPA
25  * implementation.
26  * 
27  * Implementations of JpaCustomizer are found using {@link ServiceLoader}. In
28  * case of testing with a specific JPA provider, the customizer library for that
29  * JPA provider must be on the classpath as well.
30  * 
31  * @author Erik Brakkee
32  */
33 public interface JpaCustomizer {
34
35     /**
36      * Customizes the persistence unit through properties. 
37      * @param aPersistenceUnit Persistence unit. 
38      * @param aJpaProperties Current properties. 
39      */
40     void customize(PersistenceUnitDescription aPersistenceUnit,
41         Map<String, String> aJpaProperties);
42
43     /**
44      * Gets the tables specific to the JPA provider. 
45      * @return Tables. 
46      */
47     ITableFilterSimple getJpaTables();
48 }