View Javadoc
1   /*
2    * Copyright 2002-2014 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.springframework.orm.jpa.vendor;
17  
18  import java.util.HashMap;
19  import java.util.Map;
20  import javax.persistence.EntityManager;
21  import javax.persistence.EntityManagerFactory;
22  import javax.persistence.spi.PersistenceProvider;
23  import org.apache.openjpa.persistence.OpenJPAEntityManagerFactorySPI;
24  import org.apache.openjpa.persistence.OpenJPAEntityManagerSPI;
25  import org.apache.openjpa.persistence.PersistenceProviderImpl;
26  
27  /**
28   * {@link org.springframework.orm.jpa.JpaVendorAdapter} implementation for Apache OpenJPA.
29   * Developed and tested against OpenJPA 3.0.
30   *
31   * Exposes OpenJPA's persistence provider and EntityManager extension interface,
32   * and adapts {@link AbstractJpaVendorAdapter}'s common configuration settings.
33   * No support for the detection of annotated packages (through
34   * {@link org.springframework.orm.jpa.persistenceunit.SmartPersistenceUnitInfo#getManagedPackages()})
35   * since OpenJPA doesn't use package-level metadata.
36   *
37   * @author Juergen Hoeller
38   * @author Costin Leau
39   * @since 2.0
40   * @see OpenJpaDialect
41   * @see org.apache.openjpa.persistence.PersistenceProviderImpl
42   * @see org.apache.openjpa.persistence.OpenJPAEntityManager
43   */
44  public class OpenJpaVendorAdapter extends AbstractJpaVendorAdapter {
45  
46      private final PersistenceProvider persistenceProvider = new PersistenceProviderImpl();
47  
48      private final OpenJpaDialect jpaDialect = new OpenJpaDialect();
49  
50      @Override
51      public PersistenceProvider getPersistenceProvider() {
52          return this.persistenceProvider;
53      }
54  
55      @Override
56      public String getPersistenceProviderRootPackage() {
57          return "org.apache.openjpa";
58      }
59  
60      @Override
61      public Map<String, Object> getJpaPropertyMap() {
62          Map<String, Object> jpaProperties = new HashMap<>();
63  
64          if (getDatabasePlatform() != null) {
65              jpaProperties.put("openjpa.jdbc.DBDictionary", getDatabasePlatform());
66          } else if (getDatabase() != null) {
67              String databaseDictonary = determineDatabaseDictionary(getDatabase());
68              if (databaseDictonary != null) {
69                  jpaProperties.put("openjpa.jdbc.DBDictionary", databaseDictonary);
70              }
71          }
72  
73          if (isGenerateDdl()) {
74              jpaProperties.put("openjpa.jdbc.SynchronizeMappings", "buildSchema(ForeignKeys=true)");
75          }
76          if (isShowSql()) {
77              // Taken from the OpenJPA 0.9.6 docs ("Standard OpenJPA Log Configuration + All SQL Statements")
78              jpaProperties.put("openjpa.Log", "DefaultLevel=WARN, Runtime=INFO, Tool=INFO, SQL=TRACE");
79          }
80  
81          return jpaProperties;
82      }
83  
84      /**
85       * Determine the OpenJPA database dictionary name for the given database.
86       *
87       * @param database the specified database
88       * @return the OpenJPA database dictionary name, or {@code null} if none found
89       */
90      protected static String determineDatabaseDictionary(final Database database) {
91          switch (database) {
92              case DB2:
93                  return "db2";
94              case DERBY:
95                  return "derby";
96              case HSQL:
97                  return "hsql(SimulateLocking=true)";
98              case INFORMIX:
99                  return "informix";
100             case MYSQL:
101                 return "mysql";
102             case ORACLE:
103                 return "oracle";
104             case POSTGRESQL:
105                 return "postgres";
106             case SQL_SERVER:
107                 return "sqlserver";
108             case SYBASE:
109                 return "sybase";
110             default:
111                 return null;
112         }
113     }
114 
115     @Override
116     public OpenJpaDialect getJpaDialect() {
117         return this.jpaDialect;
118     }
119 
120     @Override
121     public Class<? extends EntityManagerFactory> getEntityManagerFactoryInterface() {
122         return OpenJPAEntityManagerFactorySPI.class;
123     }
124 
125     @Override
126     public Class<? extends EntityManager> getEntityManagerInterface() {
127         return OpenJPAEntityManagerSPI.class;
128     }
129 }