Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish gemfire sample

Browse Source
This commit is contained in:
Phillip Webb
2014-04-30 20:54:39 +01:00
parent 2c087d4787
commit 1d5cddc1e9
8 changed files with 99 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
spring-boot-samples/spring-boot-sample-data-gemfire/src/main/java/sample/data/gemfire/SampleDataGemFireApplication.java
View File

@@ -25,17 +25,12 @@ import org.springframework.data.gemfire.repository.config.EnableGemfireRepositor
import org.springframework.transaction.annotation.EnableTransactionManagement;
/**
* The GemstoneAppConfiguration class for allowing Spring Boot to pickup additional application Spring configuration
* meta-data for GemFire, which must be specified in Spring Data GemFire's XML namespace.
* The GemstoneAppConfiguration class for allowing Spring Boot to pickup additional
* application Spring configuration meta-data for GemFire, which must be specified in
* Spring Data GemFire's XML namespace.
* <p/>
* @author John Blum
* @see org.springframework.boot.autoconfigure.EnableAutoConfiguration
* @see org.springframework.context.annotation.ComponentScan
* @see org.springframework.context.annotation.Configuration
* @see org.springframework.context.annotation.ImportResource
* @see org.springframework.data.gemfire.repository.config.EnableGemfireRepositories
* @see org.springframework.transaction.annotation.EnableTransactionManagement
* @since 1.0.0
* @since 1.1.0
*/
@Configuration
@ImportResource("/spring-data-gemfire-cache.xml")
@@ -43,7 +38,6 @@ import org.springframework.transaction.annotation.EnableTransactionManagement;
@EnableAutoConfiguration
@EnableGemfireRepositories
@EnableTransactionManagement
@SuppressWarnings("unused")
public class SampleDataGemFireApplication {
public static void main(final String[] args) {

18
spring-boot-samples/spring-boot-sample-data-gemfire/src/main/java/sample/data/gemfire/domain/Gemstone.java
View File

@@ -23,16 +23,12 @@ import org.springframework.data.gemfire.mapping.Region;
import org.springframework.util.ObjectUtils;
/**
* The Gemstone class is an abstract data type modeling a Gemstone, such as a diamond or a ruby.
* <p/>
* The Gemstone class is an abstract data type modeling a Gemstone, such as a diamond or a
* ruby.
*
* @author John Blum
* @see java.io.Serializable
* @see org.springframework.data.annotation.Id
* @see org.springframework.data.gemfire.mapping.Region
* @since 1.0.0
*/
@Region("Gemstones")
@SuppressWarnings("unused")
public class Gemstone implements Serializable {
@Id
@@ -53,7 +49,7 @@ public class Gemstone implements Serializable {
}
public Long getId() {
return id;
return this.id;
}
public void setId(final Long id) {
@@ -61,7 +57,7 @@ public class Gemstone implements Serializable {
}
public String getName() {
return name;
return this.name;
}
public void setName(final String name) {
@@ -92,8 +88,8 @@ public class Gemstone implements Serializable {
@Override
public String toString() {
return String.format("{ @type = %1$s, id = %2$d, name = %3$s }",
getClass().getName(), getId(), getName());
return String.format("{ @type = %1$s, id = %2$d, name = %3$s }", getClass()
.getName(), getId(), getName());
}
}

12
spring-boot-samples/spring-boot-sample-data-gemfire/src/main/java/sample/data/gemfire/service/GemstoneRepository.java
View File

@@ -21,20 +21,16 @@ import org.springframework.data.gemfire.repository.GemfireRepository;
import sample.data.gemfire.domain.Gemstone;
/**
* The GemstoneRepository interface is an extension of the GemfireRepository abstraction for encapsulating data access
* and persistence operations (CRUD) on Gemstone domain objects.
* <p/>
* The GemstoneRepository interface is an extension of the GemfireRepository abstraction
* for encapsulating data access and persistence operations (CRUD) on Gemstone domain
* objects.
*
* @author John Blum
* @see org.springframework.data.gemfire.repository.GemfireRepository
* @see sample.data.gemfire.domain.Gemstone
* @since 1.0.0
*/
public interface GemstoneRepository extends GemfireRepository<Gemstone, Long> {
/**
* Finds a particular Gemstone in the GemFire Cache by name.
* <p/>
*
* @param <T> the Class type of the Gemstone domain object to find.
* @param name a String value indicating the name of the Gemstone to find.
* @return a Gemstone by name.

22
spring-boot-samples/spring-boot-sample-data-gemfire/src/main/java/sample/data/gemfire/service/GemstoneService.java
View File

@@ -19,28 +19,21 @@ package sample.data.gemfire.service;
import sample.data.gemfire.domain.Gemstone;
/**
* The GemstoneService interface is a Service interface object contract defining business operations for processing
* Gemstone domain objects.
* <p/>
* The GemstoneService interface is a Service interface object contract defining business
* operations for processing Gemstone domain objects.
*
* @author John Blum
* @see sample.data.gemfire.domain.Gemstone
* @since 1.0.0
*/
@SuppressWarnings("unused")
public interface GemstoneService {
/**
* Returns a count of the number of Gemstones in the GemFire Cache.
* <p/>
*
* @return a long value indicating the number of Gemstones in the GemFire Cache.
*/
long count();
/**
* Gets a Gemstone by ID.
* <p/>
*
* @param id a long value indicating the identifier of the Gemstone.
* @return a Gemstone with ID, or null if no Gemstone exists with ID.
* @see sample.data.gemfire.domain.Gemstone
@@ -49,8 +42,6 @@ public interface GemstoneService {
/**
* Gets a Gemstone by name.
* <p/>
*
* @param name a String value indicating the name of the Gemstone.
* @return a Gemstone with name, or null if no Gemstone exists with name.
* @see sample.data.gemfire.domain.Gemstone
@@ -59,9 +50,8 @@ public interface GemstoneService {
/**
* Return a listing of Gemstones currently stored in the GemFire Cache.
* <p/>
*
* @return a Iterable object to iterate over the list of Gemstones currently stored in the GemFire Cache.
* @return a Iterable object to iterate over the list of Gemstones currently stored in
* the GemFire Cache.
* @see java.lang.Iterable
* @see sample.data.gemfire.domain.Gemstone
*/
@@ -69,8 +59,6 @@ public interface GemstoneService {
/**
* Saves the specified Gemstone to the GemFire Cache.
* <p/>
*
* @param gemstone the Gemstone to save in the GemFire Cache.
* @return the saved Gemstone.
* @see sample.data.gemfire.domain.Gemstone

65
spring-boot-samples/spring-boot-sample-data-gemfire/src/main/java/sample/data/gemfire/service/GemstoneServiceImpl.java
View File

@@ -19,6 +19,7 @@ package sample.data.gemfire.service;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import javax.annotation.PostConstruct;
import org.springframework.beans.factory.annotation.Autowired;
@@ -29,102 +30,106 @@ import org.springframework.util.Assert;
import sample.data.gemfire.domain.Gemstone;
/**
* The GemstoneServiceImpl class is a Service object implementing the GemstoneService interface containing
* business logic and rules in addition to data services for processing Gemstones.
* <p/>
* The GemstoneServiceImpl class is a Service object implementing the GemstoneService
* interface containing business logic and rules in addition to data services for
* processing Gemstones.
*
* @author John Blum
* @see org.springframework.stereotype.Service
* @see org.springframework.transaction.annotation.Transactional
* @see sample.data.gemfire.domain.Gemstone
* @see sample.data.gemfire.service.GemstoneRepository
* @see sample.data.gemfire.service.GemstoneService
* @since 1.0.0
*/
@Service("gemstoneService")
@SuppressWarnings("unused")
public class GemstoneServiceImpl implements GemstoneService {
protected static final List<String> APPROVED_GEMS = new ArrayList<String>(Arrays.asList(
"ALEXANDRITE", "AQUAMARINE", "DIAMOND", "OPAL", "PEARL", "RUBY", "SAPPHIRE", "SPINEL", "TOPAZ"));
protected static final List<String> APPROVED_GEMS = new ArrayList<String>(
Arrays.asList("ALEXANDRITE", "AQUAMARINE", "DIAMOND", "OPAL", "PEARL",
"RUBY", "SAPPHIRE", "SPINEL", "TOPAZ"));
@Autowired
private GemstoneRepository gemstoneRepo;
@PostConstruct
public void init() {
Assert.notNull(gemstoneRepo, "A reference to the 'GemstoneRepository' was not properly configured!");
Assert.notNull(this.gemstoneRepo,
"A reference to the 'GemstoneRepository' was not properly configured!");
System.out.printf("%1$s initialized!%n", getClass().getSimpleName());
}
/**
* Returns a count of the number of Gemstones in the GemFire Cache.
* <p/>
*
*
* @return a long value indicating the number of Gemstones in the GemFire Cache.
*/
@Override
@Transactional(readOnly = true)
public long count() {
return gemstoneRepo.count();
return this.gemstoneRepo.count();
}
/**
* Gets a Gemstone by ID.
* <p/>
*
*
* @param id a long value indicating the identifier of the Gemstone.
* @return a Gemstone with ID, or null if no Gemstone exists with ID.
* @see sample.data.gemfire.domain.Gemstone
*/
@Override
@Transactional(readOnly = true)
public Gemstone get(final Long id) {
return gemstoneRepo.findOne(id);
return this.gemstoneRepo.findOne(id);
}
/**
* Gets a Gemstone by name.
* <p/>
*
*
* @param name a String value indicating the name of the Gemstone.
* @return a Gemstone with name, or null if no Gemstone exists with name.
* @see sample.data.gemfire.domain.Gemstone
*/
@Override
@Transactional(readOnly = true)
public Gemstone get(final String name) {
return gemstoneRepo.findByName(name);
return this.gemstoneRepo.findByName(name);
}
/**
* Return a listing of Gemstones currently stored in the GemFire Cache.
* <p/>
*
* @return a Iterable object to iterate over the list of Gemstones currently stored in the GemFire Cache.
*
* @return a Iterable object to iterate over the list of Gemstones currently stored in
* the GemFire Cache.
* @see java.lang.Iterable
* @see sample.data.gemfire.domain.Gemstone
*/
@Override
@Transactional(readOnly = true)
public Iterable<Gemstone> list() {
return gemstoneRepo.findAll();
return this.gemstoneRepo.findAll();
}
/**
* Saves the specified Gemstone to the GemFire Cache.
* <p/>
*
*
* @param gemstone the Gemstone to save in the GemFire Cache.
* @return the saved Gemstone.
* @see sample.data.gemfire.domain.Gemstone
*/
@Override
@Transactional
public Gemstone save(final Gemstone gemstone) {
Assert.notNull(gemstone, "The Gemstone to save must not be null!");
Assert.notNull(gemstone.getName(), "The name of the Gemstone must be specified!");
// NOTE deliberately (naively) validate the Gemstone after mutating data access in GemFire rather than before
// NOTE deliberately (naively) validate the Gemstone after mutating data access in
// GemFire rather than before
// to demonstrate transactions in GemFire.
Gemstone savedGemstone = validate(gemstoneRepo.save(gemstone));
Gemstone savedGemstone = validate(this.gemstoneRepo.save(gemstone));
Assert.state(savedGemstone.equals(get(gemstone.getId())),
String.format("Failed to find Gemstone (%1$s) in GemFire's Cache Region 'Gemstones'!", gemstone));
Assert.state(savedGemstone.equals(get(gemstone.getId())), String.format(
"Failed to find Gemstone (%1$s) in GemFire's Cache Region 'Gemstones'!",
gemstone));
System.out.printf("Saved Gemstone (%1$s)%n", savedGemstone.getName());
@@ -133,9 +138,11 @@ public class GemstoneServiceImpl implements GemstoneService {
private Gemstone validate(final Gemstone gemstone) {
if (!APPROVED_GEMS.contains(gemstone.getName().toUpperCase())) {
// NOTE if the Gemstone is not valid, blow chunks (should cause transaction to rollback in GemFire)!
// NOTE if the Gemstone is not valid, blow chunks (should cause transaction to
// rollback in GemFire)!
System.err.printf("Illegal Gemstone (%1$s)!%n", gemstone.getName());
throw new IllegalGemstoneException(String.format("'%1$s' is not a valid Gemstone!", gemstone.getName()));
throw new IllegalGemstoneException(String.format(
"'%1$s' is not a valid Gemstone!", gemstone.getName()));
}
return gemstone;