Browse Source
Relocate several auto-configuration classes to `...autoconfigure.data` to make it clearer that they are Spring Data specific. Also moved `EntityManagerFactoryBuilder` to `spring-boot` since it is generally useful and doesn't need to be directly tied to the auto-configuration module. Fixes gh-4002pull/4010/head
Phillip Webb
11 years ago
34 changed files with 364 additions and 131 deletions
@ -1,21 +0,0 @@
@@ -1,21 +0,0 @@
|
||||
/* |
||||
* Copyright 2012-2015 the original author or authors. |
||||
* |
||||
* Licensed under the Apache 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://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* 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. |
||||
*/ |
||||
|
||||
/** |
||||
* Auto-configuration for Elasticsearch. |
||||
*/ |
||||
package org.springframework.boot.autoconfigure.elasticsearch; |
||||
|
||||
@ -0,0 +1,203 @@
@@ -0,0 +1,203 @@
|
||||
/* |
||||
* Copyright 2012-2015 the original author or authors. |
||||
* |
||||
* Licensed under the Apache 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://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* 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.springframework.boot.orm.jpa; |
||||
|
||||
import java.util.HashMap; |
||||
import java.util.HashSet; |
||||
import java.util.LinkedHashMap; |
||||
import java.util.Map; |
||||
import java.util.Set; |
||||
|
||||
import javax.sql.DataSource; |
||||
|
||||
import org.springframework.orm.jpa.JpaVendorAdapter; |
||||
import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean; |
||||
import org.springframework.orm.jpa.persistenceunit.PersistenceUnitManager; |
||||
import org.springframework.util.ClassUtils; |
||||
|
||||
/** |
||||
* Convenient builder for JPA EntityManagerFactory instances. Collects common |
||||
* configuration when constructed and then allows you to create one or more |
||||
* {@link LocalContainerEntityManagerFactoryBean} through a fluent builder pattern. The |
||||
* most common options are covered in the builder, but you can always manipulate the |
||||
* product of the builder if you need more control, before returning it from a |
||||
* {@code @Bean} definition. |
||||
* |
||||
* @author Dave Syer |
||||
* @author Phillip Webb |
||||
* @since 1.3.0 |
||||
*/ |
||||
public class EntityManagerFactoryBuilder { |
||||
|
||||
private JpaVendorAdapter jpaVendorAdapter; |
||||
|
||||
private PersistenceUnitManager persistenceUnitManager; |
||||
|
||||
private Map<String, Object> jpaProperties; |
||||
|
||||
private EntityManagerFactoryBeanCallback callback; |
||||
|
||||
/** |
||||
* Create a new instance passing in the common pieces that will be shared if multiple |
||||
* EntityManagerFactory instances are created. |
||||
* @param jpaVendorAdapter a vendor adapter |
||||
* @param jpaProperties JPA properties to be passed to the persistence provider. |
||||
* @param persistenceUnitManager optional source of persistence unit information (can |
||||
* be null) |
||||
*/ |
||||
public EntityManagerFactoryBuilder(JpaVendorAdapter jpaVendorAdapter, |
||||
Map<String, ?> jpaProperties, PersistenceUnitManager persistenceUnitManager) { |
||||
this.jpaVendorAdapter = jpaVendorAdapter; |
||||
this.persistenceUnitManager = persistenceUnitManager; |
||||
this.jpaProperties = new LinkedHashMap<String, Object>(jpaProperties); |
||||
} |
||||
|
||||
public Builder dataSource(DataSource dataSource) { |
||||
return new Builder(dataSource); |
||||
} |
||||
|
||||
/** |
||||
* An optional callback for new entity manager factory beans. |
||||
* @param callback the entity manager factory bean callback |
||||
*/ |
||||
public void setCallback(EntityManagerFactoryBeanCallback callback) { |
||||
this.callback = callback; |
||||
} |
||||
|
||||
/** |
||||
* A fluent builder for a LocalContainerEntityManagerFactoryBean. |
||||
*/ |
||||
public final class Builder { |
||||
|
||||
private DataSource dataSource; |
||||
|
||||
private String[] packagesToScan; |
||||
|
||||
private String persistenceUnit; |
||||
|
||||
private Map<String, Object> properties = new HashMap<String, Object>(); |
||||
|
||||
private boolean jta; |
||||
|
||||
private Builder(DataSource dataSource) { |
||||
this.dataSource = dataSource; |
||||
} |
||||
|
||||
/** |
||||
* The names of packages to scan for {@code @Entity} annotations. |
||||
* @param packagesToScan packages to scan |
||||
* @return the builder for fluent usage |
||||
*/ |
||||
public Builder packages(String... packagesToScan) { |
||||
this.packagesToScan = packagesToScan; |
||||
return this; |
||||
} |
||||
|
||||
/** |
||||
* The classes whose packages should be scanned for {@code @Entity} annotations. |
||||
* @param basePackageClasses the classes to use |
||||
* @return the builder for fluent usage |
||||
*/ |
||||
public Builder packages(Class<?>... basePackageClasses) { |
||||
Set<String> packages = new HashSet<String>(); |
||||
for (Class<?> type : basePackageClasses) { |
||||
packages.add(ClassUtils.getPackageName(type)); |
||||
} |
||||
this.packagesToScan = packages.toArray(new String[0]); |
||||
return this; |
||||
} |
||||
|
||||
/** |
||||
* The name of the persistence unit. If only building one EntityManagerFactory you |
||||
* can omit this, but if there are more than one in the same application you |
||||
* should give them distinct names. |
||||
* @param persistenceUnit the name of the persistence unit |
||||
* @return the builder for fluent usage |
||||
*/ |
||||
public Builder persistenceUnit(String persistenceUnit) { |
||||
this.persistenceUnit = persistenceUnit; |
||||
return this; |
||||
} |
||||
|
||||
/** |
||||
* Generic properties for standard JPA or vendor-specific configuration. These |
||||
* properties override any values provided in the constructor. |
||||
* @param properties the properties to use |
||||
* @return the builder for fluent usage |
||||
*/ |
||||
public Builder properties(Map<String, ?> properties) { |
||||
this.properties.putAll(properties); |
||||
return this; |
||||
} |
||||
|
||||
/** |
||||
* Configure if using a JTA {@link DataSource}, i.e. if |
||||
* {@link LocalContainerEntityManagerFactoryBean#setDataSource(DataSource) |
||||
* setDataSource} or |
||||
* {@link LocalContainerEntityManagerFactoryBean#setJtaDataSource(DataSource) |
||||
* setJtaDataSource} should be called on the |
||||
* {@link LocalContainerEntityManagerFactoryBean}. |
||||
* @param jta if the data source is JTA |
||||
* @return the builder for fluent usage |
||||
*/ |
||||
public Builder jta(boolean jta) { |
||||
this.jta = jta; |
||||
return this; |
||||
} |
||||
|
||||
public LocalContainerEntityManagerFactoryBean build() { |
||||
LocalContainerEntityManagerFactoryBean entityManagerFactoryBean = new LocalContainerEntityManagerFactoryBean(); |
||||
if (EntityManagerFactoryBuilder.this.persistenceUnitManager != null) { |
||||
entityManagerFactoryBean |
||||
.setPersistenceUnitManager(EntityManagerFactoryBuilder.this.persistenceUnitManager); |
||||
} |
||||
if (this.persistenceUnit != null) { |
||||
entityManagerFactoryBean.setPersistenceUnitName(this.persistenceUnit); |
||||
} |
||||
entityManagerFactoryBean |
||||
.setJpaVendorAdapter(EntityManagerFactoryBuilder.this.jpaVendorAdapter); |
||||
|
||||
if (this.jta) { |
||||
entityManagerFactoryBean.setJtaDataSource(this.dataSource); |
||||
} |
||||
else { |
||||
entityManagerFactoryBean.setDataSource(this.dataSource); |
||||
} |
||||
|
||||
entityManagerFactoryBean.setPackagesToScan(this.packagesToScan); |
||||
entityManagerFactoryBean.getJpaPropertyMap().putAll( |
||||
EntityManagerFactoryBuilder.this.jpaProperties); |
||||
entityManagerFactoryBean.getJpaPropertyMap().putAll(this.properties); |
||||
if (EntityManagerFactoryBuilder.this.callback != null) { |
||||
EntityManagerFactoryBuilder.this.callback |
||||
.execute(entityManagerFactoryBean); |
||||
} |
||||
return entityManagerFactoryBean; |
||||
} |
||||
|
||||
} |
||||
|
||||
/** |
||||
* A callback for new entity manager factory beans created by a Builder. |
||||
*/ |
||||
public interface EntityManagerFactoryBeanCallback { |
||||
|
||||
void execute(LocalContainerEntityManagerFactoryBean factory); |
||||
|
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,71 @@
@@ -0,0 +1,71 @@
|
||||
/* |
||||
* Copyright 2012-2015 the original author or authors. |
||||
* |
||||
* Licensed under the Apache 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://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* 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.springframework.boot.orm.jpa; |
||||
|
||||
import java.util.Collections; |
||||
import java.util.LinkedHashMap; |
||||
import java.util.Map; |
||||
|
||||
import javax.sql.DataSource; |
||||
|
||||
import org.junit.Test; |
||||
import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean; |
||||
import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter; |
||||
|
||||
import static org.junit.Assert.assertFalse; |
||||
import static org.junit.Assert.assertTrue; |
||||
import static org.mockito.Mockito.mock; |
||||
|
||||
/** |
||||
* Tests for {@link EntityManagerFactoryBuilder}. |
||||
* |
||||
* @author Dave Syer |
||||
*/ |
||||
@Deprecated |
||||
public class EntityManagerFactoryBuilderTests { |
||||
|
||||
private Map<String, Object> properties = new LinkedHashMap<String, Object>(); |
||||
|
||||
private DataSource dataSource1 = mock(DataSource.class); |
||||
|
||||
private DataSource dataSource2 = mock(DataSource.class); |
||||
|
||||
@Test |
||||
public void entityManagerFactoryPropertiesNotOverwritingDefaults() { |
||||
EntityManagerFactoryBuilder factory = new EntityManagerFactoryBuilder( |
||||
new HibernateJpaVendorAdapter(), this.properties, null); |
||||
LocalContainerEntityManagerFactoryBean result1 = factory |
||||
.dataSource(this.dataSource1) |
||||
.properties(Collections.singletonMap("foo", "spam")).build(); |
||||
assertFalse(result1.getJpaPropertyMap().isEmpty()); |
||||
assertTrue(this.properties.isEmpty()); |
||||
} |
||||
|
||||
@Test |
||||
public void multipleEntityManagerFactoriesDoNotOverwriteEachOther() { |
||||
EntityManagerFactoryBuilder factory = new EntityManagerFactoryBuilder( |
||||
new HibernateJpaVendorAdapter(), this.properties, null); |
||||
LocalContainerEntityManagerFactoryBean result1 = factory |
||||
.dataSource(this.dataSource1) |
||||
.properties(Collections.singletonMap("foo", "spam")).build(); |
||||
assertFalse(result1.getJpaPropertyMap().isEmpty()); |
||||
LocalContainerEntityManagerFactoryBean result2 = factory.dataSource( |
||||
this.dataSource2).build(); |
||||
assertTrue(result2.getJpaPropertyMap().isEmpty()); |
||||
} |
||||
|
||||
} |
||||
Loading…
Reference in new issue