diff --git a/.gitignore b/.gitignore index 8a95788e..fd227024 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,7 @@ target/ #IntelliJ Stuff .idea *.iml + +#Geode Stuff +*.log +*.dat diff --git a/README.md b/README.md index 2e83cee8..f9854851 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,17 @@ This repository contains example projects for the different Spring Data modules We have separate folders for the samples of individual modules: +## Spring Data for Apache Geode + +* `events` - In this example the test will make use of event handlers and async event queue to handle events. +* `expiration-eviction` - In these examples the server is configured to delete entries after a certain idle period or after a Time-To-Live period (expiration0 or remove data from memory when certain thresholds are reached (eviction). +* `function-invocation` - In this example the server will have 3 functions registered. The client will invoke each of the functions. +* `queries` - In this example a client will query the data in various ways using OQl, continuous queries, and Apache Lucene indexes. +* `security` - In this example the servers and clients are set up with security (username/password) authentication using Geode Security and Apache Shiro. +* `storage` - In this example the server is configured to store data off of hte JVM heap using the `@EnableOffHeap` annotation and to compress region data using SnappyCompressor`. +* `transactions` - In this example the client will perform operations within a transaction. First, it will do a successful transaction where entries are saved to the server, and then a failed transaction where all changes are reverted. +* `wan` - In these example two servers are deployed. One server populates itself with data, and the other server gets populated with that data via WAN replication. + ## Spring Data JPA * `eclipselink` - Sample project to show how to use Spring Data JPA with Spring Boot and [Eclipselink](https://www.eclipse.org/eclipselink/). diff --git a/geode/README.md b/geode/README.md new file mode 100755 index 00000000..51469670 --- /dev/null +++ b/geode/README.md @@ -0,0 +1,22 @@ +Spring Data For GemFire and Apache Geode Examples +========================================================= + +This project provides a number of examples to get you started using Spring Data for Apache Geode or Pivotal GemFire. These examples are designed to work with [Spring Data for Pivotal GemFire](http://projects.spring.io/spring-data-gemfire) 2.0.9-RELEASE or higher and are organized into the following sub projects: + +It is important to note that all examples will follow the prescribed Maven directory structure. + +Examples: + +* **events** - In this example the test will make use of event handlers and async event queue to handle events. +* **expiration-eviction** - In these examples the server is configured to delete entries after a certain idle period or after a Time-To-Live period (expiration0 or remove data from memory when certain thresholds are reached (eviction). +* **function-invocation** - In this example the server will have 3 functions registered. The client will invoke each of the functions. +* **queries** - In this example a client will query the data in various ways using OQl, continuous queries, and Apache Lucene indexes. +* **security** - In this example the servers and clients are set up with security (username/password) authentication using Geode Security and Apache Shiro. +* **storage** - In this example the server is configured to store data off of hte JVM heap using the `@EnableOffHeap` annotation and to compress region data using SnappyCompressor`. +* **transactions** - In this example the client will perform operations within a transaction. First, it will do a successful transaction where entries are saved to the server, and then a failed transaction where all changes are reverted. +* **wan** - In these example two servers are deployed. One server populates itself with data, and the other server gets populated with that data via WAN replication. + +# Running The Examples + +Each example has at least one test file located in the test directory. The examples are driven by the tests, so simply run the test either through your IDE or via the commandline. +The logging level of the examples is set to "error", so there will be no output. To see output, simply find the `logback.xml` file located in src/test/resources and set the loglevel to "info". \ No newline at end of file diff --git a/geode/events/README.md b/geode/events/README.md new file mode 100755 index 00000000..12933162 --- /dev/null +++ b/geode/events/README.md @@ -0,0 +1,5 @@ +# Events Example + +In this example you will how to handle events using Async event queue, Cache Listeners, Cache Loaders, and Cache Writers. + +NOTE: Inorder to see output, you must change the loglevel from "error" to "info" in the `logback.xml` file located under src/test/resources. \ No newline at end of file diff --git a/geode/events/pom.xml b/geode/events/pom.xml new file mode 100755 index 00000000..d7c2c297 --- /dev/null +++ b/geode/events/pom.xml @@ -0,0 +1,17 @@ + + + + example.springdata.geode + spring-data-geode-examples + 1.0-SNAPSHOT + + 4.0.0 + events + + + + + + \ No newline at end of file diff --git a/geode/events/src/main/java/example/springdata/geode/server/events/Address.java b/geode/events/src/main/java/example/springdata/geode/server/events/Address.java new file mode 100755 index 00000000..5f8b8007 --- /dev/null +++ b/geode/events/src/main/java/example/springdata/geode/server/events/Address.java @@ -0,0 +1,41 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import lombok.Data; + +import java.io.Serializable; + +/** + * An address used in the examples. + * + * @author Oliver Gierke + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +public class Address implements Serializable { + private String street; + private String city; + private String country; + + public Address(String street, String city, String country) { + this.street = street; + this.city = city; + this.country = country; + } +} diff --git a/geode/events/src/main/java/example/springdata/geode/server/events/Customer.java b/geode/events/src/main/java/example/springdata/geode/server/events/Customer.java new file mode 100755 index 00000000..1be4fe37 --- /dev/null +++ b/geode/events/src/main/java/example/springdata/geode/server/events/Customer.java @@ -0,0 +1,51 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import lombok.Data; +import org.springframework.data.annotation.Id; +import org.springframework.data.gemfire.mapping.annotation.Region; + +import java.io.Serializable; +import java.util.Arrays; +import java.util.List; + +/** + * A customer used for Lucene examples. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +@Region(name = "Customers") +public class Customer implements Serializable { + + @Id + private Long id; + private EmailAddress emailAddress; + private String firstName; + private String lastName; + private List
addresses; + + public Customer(Long id, EmailAddress emailAddress, String firstName, String lastName, Address... addresses) { + this.id = id; + this.emailAddress = emailAddress; + this.firstName = firstName; + this.lastName = lastName; + this.addresses = Arrays.asList(addresses); + } +} \ No newline at end of file diff --git a/geode/events/src/main/java/example/springdata/geode/server/events/CustomerCacheWriter.java b/geode/events/src/main/java/example/springdata/geode/server/events/CustomerCacheWriter.java new file mode 100755 index 00000000..8f31e674 --- /dev/null +++ b/geode/events/src/main/java/example/springdata/geode/server/events/CustomerCacheWriter.java @@ -0,0 +1,33 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import org.apache.geode.cache.CacheWriterException; +import org.apache.geode.cache.EntryEvent; +import org.apache.geode.cache.util.CacheWriterAdapter; +import org.apache.geode.internal.cache.EntryEventImpl; +import org.springframework.stereotype.Component; + +@Component +public class CustomerCacheWriter extends CacheWriterAdapter { + + @Override + public void beforeCreate(EntryEvent event) throws CacheWriterException { + EntryEventImpl e = (EntryEventImpl) event; + super.beforeCreate(e); + } +} diff --git a/geode/events/src/main/java/example/springdata/geode/server/events/CustomerRepository.java b/geode/events/src/main/java/example/springdata/geode/server/events/CustomerRepository.java new file mode 100755 index 00000000..42b321a4 --- /dev/null +++ b/geode/events/src/main/java/example/springdata/geode/server/events/CustomerRepository.java @@ -0,0 +1,22 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import org.springframework.data.repository.CrudRepository; + +public interface CustomerRepository extends CrudRepository { +} diff --git a/geode/events/src/main/java/example/springdata/geode/server/events/EmailAddress.java b/geode/events/src/main/java/example/springdata/geode/server/events/EmailAddress.java new file mode 100755 index 00000000..501f222b --- /dev/null +++ b/geode/events/src/main/java/example/springdata/geode/server/events/EmailAddress.java @@ -0,0 +1,37 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import lombok.Data; + +import java.io.Serializable; + +/** + * Value object to represent email addresses. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +public class EmailAddress implements Serializable { + private String value; + + public EmailAddress(String value) { + + this.value = value; + } +} \ No newline at end of file diff --git a/geode/events/src/main/java/example/springdata/geode/server/events/EventServer.java b/geode/events/src/main/java/example/springdata/geode/server/events/EventServer.java new file mode 100755 index 00000000..c687d8d6 --- /dev/null +++ b/geode/events/src/main/java/example/springdata/geode/server/events/EventServer.java @@ -0,0 +1,96 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import org.apache.geode.cache.Region; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.boot.ApplicationRunner; +import org.springframework.boot.WebApplicationType; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.boot.builder.SpringApplicationBuilder; +import org.springframework.context.annotation.Bean; + +import java.math.BigDecimal; +import java.util.List; +import java.util.Random; +import java.util.stream.IntStream; +import java.util.stream.LongStream; + +@SpringBootApplication(scanBasePackageClasses = EventServerConfig.class) +public class EventServer { + + private Logger logger = LoggerFactory.getLogger(this.getClass()); + + public static void main(String[] args) { + new SpringApplicationBuilder(EventServer.class) + .web(WebApplicationType.NONE) + .build() + .run(args); + } + + @Bean + public ApplicationRunner runner(CustomerRepository customerRepository, OrderRepository orderRepository, + ProductRepository productRepository, OrderProductSummaryRepository orderProductSummaryRepository, @Qualifier("Products") Region products) { + return args -> { + createCustomerData(customerRepository); + + createProducts(productRepository); + + createOrders(productRepository, orderRepository); + + logger.info("Completed creating orders "); + + final List allForProductID = orderProductSummaryRepository.findAllForProductID(3L); + allForProductID.forEach(orderProductSummary -> logger.info("orderProductSummary = " + orderProductSummary)); + }; + } + + private void createOrders(ProductRepository productRepository, OrderRepository orderRepository) { + Random random = new Random(System.nanoTime()); + Address address = new Address("it", "doesn't", "matter"); + LongStream.rangeClosed(1, 10).forEach((orderId) -> + LongStream.rangeClosed(1, 300).forEach((customerId) -> { + Order order = new Order(orderId, customerId, address); + IntStream.rangeClosed(0, random.nextInt(3) + 1).forEach((lineItemCount) -> { + int quantity = random.nextInt(3) + 1; + long productId = random.nextInt(3) + 1; + order.add(new LineItem(productRepository.findById(productId).get(), quantity)); + }); + orderRepository.save(order); + })); + } + + private void createProducts(ProductRepository productRepository) { + productRepository.save(new Product(1L, "Apple iPod", new BigDecimal("99.99"), + "An Apple portable music player")); + productRepository.save(new Product(2L, "Apple iPad", new BigDecimal("499.99"), + "An Apple tablet device")); + Product macbook = new Product(3L, "Apple macBook", new BigDecimal("899.99"), + "An Apple notebook computer"); + macbook.addAttribute("warranty", "included"); + productRepository.save(macbook); + } + + private void createCustomerData(CustomerRepository customerRepository) { + LongStream.rangeClosed(0, 300) + .parallel() + .forEach(customerId -> + customerRepository.save(new Customer(customerId, new EmailAddress(customerId + "@2.com"), "John" + customerId, "Smith" + customerId))); + } +} \ No newline at end of file diff --git a/geode/events/src/main/java/example/springdata/geode/server/events/EventServerConfig.java b/geode/events/src/main/java/example/springdata/geode/server/events/EventServerConfig.java new file mode 100755 index 00000000..f1c240c7 --- /dev/null +++ b/geode/events/src/main/java/example/springdata/geode/server/events/EventServerConfig.java @@ -0,0 +1,101 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import org.apache.geode.cache.Cache; +import org.apache.geode.cache.CacheListener; +import org.apache.geode.cache.CacheLoader; +import org.apache.geode.cache.CacheWriter; +import org.apache.geode.cache.DataPolicy; +import org.apache.geode.cache.GemFireCache; +import org.apache.geode.cache.Region; +import org.apache.geode.cache.asyncqueue.AsyncEventListener; +import org.apache.geode.cache.asyncqueue.AsyncEventQueue; +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.context.annotation.Configuration; +import org.springframework.data.gemfire.PartitionedRegionFactoryBean; +import org.springframework.data.gemfire.ReplicatedRegionFactoryBean; +import org.springframework.data.gemfire.config.annotation.CacheServerApplication; +import org.springframework.data.gemfire.repository.config.EnableGemfireRepositories; +import org.springframework.data.gemfire.wan.AsyncEventQueueFactoryBean; + +@Configuration +@ComponentScan +@CacheServerApplication(logLevel = "error") +@EnableGemfireRepositories(basePackageClasses = CustomerRepository.class) +public class EventServerConfig { + + @Bean + AsyncEventListener orderAsyncEventListener(@Qualifier("OrderProductSummary") Region orderProductSummary) { + return new OrderAsyncQueueListener(orderProductSummary); + } + + @Bean + AsyncEventQueueFactoryBean orderAsyncEventQueue(GemFireCache gemFireCache, AsyncEventListener orderAsyncEventListener) { + final AsyncEventQueueFactoryBean asyncEventQueueFactoryBean = new AsyncEventQueueFactoryBean((Cache) gemFireCache); + asyncEventQueueFactoryBean.setBatchTimeInterval(1000); + asyncEventQueueFactoryBean.setBatchSize(5); + asyncEventQueueFactoryBean.setAsyncEventListener(orderAsyncEventListener); + return asyncEventQueueFactoryBean; + } + + @Bean(name = "OrderProductSummary") + PartitionedRegionFactoryBean createOrderProductSummaryRegion(GemFireCache gemFireCache) { + final PartitionedRegionFactoryBean partitionedRegionFactoryBean = new PartitionedRegionFactoryBean<>(); + partitionedRegionFactoryBean.setCache(gemFireCache); + partitionedRegionFactoryBean.setRegionName("OrderProductSummary"); + partitionedRegionFactoryBean.setDataPolicy(DataPolicy.PARTITION); + return partitionedRegionFactoryBean; + } + + @Bean("Orders") + PartitionedRegionFactoryBean createOrderRegion(GemFireCache gemFireCache, AsyncEventQueue orderAsyncEventQueue) { + final PartitionedRegionFactoryBean partitionedRegionFactoryBean = new PartitionedRegionFactoryBean<>(); + partitionedRegionFactoryBean.setCache(gemFireCache); + partitionedRegionFactoryBean.setRegionName("Orders"); + partitionedRegionFactoryBean.setDataPolicy(DataPolicy.PARTITION); + partitionedRegionFactoryBean.setAsyncEventQueues(new AsyncEventQueue[]{orderAsyncEventQueue}); + return partitionedRegionFactoryBean; + } + + @Bean("Products") + ReplicatedRegionFactoryBean createProductRegion(GemFireCache gemFireCache, CacheListener loggingCacheListener, + CacheLoader productCacheLoader) { + final ReplicatedRegionFactoryBean replicatedRegionFactoryBean = new ReplicatedRegionFactoryBean<>(); + replicatedRegionFactoryBean.setCache(gemFireCache); + replicatedRegionFactoryBean.setRegionName("Products"); + replicatedRegionFactoryBean.setDataPolicy(DataPolicy.REPLICATE); + replicatedRegionFactoryBean.setCacheLoader(productCacheLoader); + replicatedRegionFactoryBean.setCacheListeners(new CacheListener[]{loggingCacheListener}); + return replicatedRegionFactoryBean; + } + + @Bean("Customers") + ReplicatedRegionFactoryBean createCustomerRegion(GemFireCache gemFireCache, + CacheWriter customerCacheWriter, + CacheListener loggingCacheListener) { + final ReplicatedRegionFactoryBean replicatedRegionFactoryBean = new ReplicatedRegionFactoryBean<>(); + replicatedRegionFactoryBean.setCache(gemFireCache); + replicatedRegionFactoryBean.setRegionName("Customers"); + replicatedRegionFactoryBean.setDataPolicy(DataPolicy.REPLICATE); + replicatedRegionFactoryBean.setCacheListeners(new CacheListener[]{loggingCacheListener}); + replicatedRegionFactoryBean.setCacheWriter(customerCacheWriter); + return replicatedRegionFactoryBean; + } +} \ No newline at end of file diff --git a/geode/events/src/main/java/example/springdata/geode/server/events/LineItem.java b/geode/events/src/main/java/example/springdata/geode/server/events/LineItem.java new file mode 100755 index 00000000..0d353247 --- /dev/null +++ b/geode/events/src/main/java/example/springdata/geode/server/events/LineItem.java @@ -0,0 +1,48 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import lombok.Data; + +import java.io.Serializable; +import java.math.BigDecimal; + +/** + * A LineItem used in the examples + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +public class LineItem implements Serializable { + + private Product product; + private Integer amount; + + public LineItem(Product product, Integer amount) { + this.product = product; + this.amount = amount; + } + + public BigDecimal calcTotal() { + return product.getPrice().multiply(BigDecimal.valueOf(amount)); + } + + public Long getProductId() { + return product.getId(); + } +} \ No newline at end of file diff --git a/geode/events/src/main/java/example/springdata/geode/server/events/LoggingCacheListener.java b/geode/events/src/main/java/example/springdata/geode/server/events/LoggingCacheListener.java new file mode 100644 index 00000000..eb669e8b --- /dev/null +++ b/geode/events/src/main/java/example/springdata/geode/server/events/LoggingCacheListener.java @@ -0,0 +1,44 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.apache.geode.cache.EntryEvent; +import org.apache.geode.cache.util.CacheListenerAdapter; +import org.springframework.stereotype.Component; + +@Component +public class LoggingCacheListener extends CacheListenerAdapter { + + private Log logger = LogFactory.getLog(LoggingCacheListener.class); + + @Override + public void afterCreate(EntryEvent event) { + logger.info("In region [" + event.getRegion().getName() + "] created key [" + event.getKey() + "] value [" + event.getNewValue() + "]"); + } + + @Override + public void afterDestroy(EntryEvent event) { + logger.info("In region [" + event.getRegion().getName() + "] destroyed key [" + event.getKey() + "] "); + } + + @Override + public void afterUpdate(EntryEvent event) { + logger.info("In region [" + event.getRegion().getName() + "] updated key [" + event.getNewValue() + "] [oldValue [" + event.getOldValue() + "]] new value [" + event.getNewValue() + "]"); + } +} \ No newline at end of file diff --git a/geode/events/src/main/java/example/springdata/geode/server/events/Order.java b/geode/events/src/main/java/example/springdata/geode/server/events/Order.java new file mode 100755 index 00000000..9ff04a20 --- /dev/null +++ b/geode/events/src/main/java/example/springdata/geode/server/events/Order.java @@ -0,0 +1,72 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import lombok.Data; +import org.springframework.data.annotation.Id; +import org.springframework.data.gemfire.mapping.annotation.Region; + +import java.io.Serializable; +import java.math.BigDecimal; +import java.util.ArrayList; +import java.util.List; + +/** + * Orders object used in the examples + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +@Region("Orders") +public class Order implements Serializable { + @Id + private Long id; + private Long customerId; + private Address billingAddress; + private Address shippingAddress; + private List lineItems = new ArrayList<>(); + + public Order(Long orderId, Long customerId, Address address) { + this.id = orderId; + this.customerId = customerId; + this.billingAddress = address; + this.shippingAddress = address; + } + + /** + * Returns the total of the [Order]. + * + * @return + */ + public BigDecimal calcTotal() { + if (lineItems.size() == 0) { + return BigDecimal.ZERO; + } else { + return lineItems.stream().map(LineItem::calcTotal).reduce(BigDecimal::add).get(); + } + } + + /** + * Adds the given [LineItem] to the [Order]. + * + * @param lineItem + */ + public void add(LineItem lineItem) { + lineItems.add(lineItem); + } +} \ No newline at end of file diff --git a/geode/events/src/main/java/example/springdata/geode/server/events/OrderAsyncQueueListener.java b/geode/events/src/main/java/example/springdata/geode/server/events/OrderAsyncQueueListener.java new file mode 100755 index 00000000..37dbee2a --- /dev/null +++ b/geode/events/src/main/java/example/springdata/geode/server/events/OrderAsyncQueueListener.java @@ -0,0 +1,63 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import org.apache.geode.cache.Region; +import org.apache.geode.cache.asyncqueue.AsyncEvent; +import org.apache.geode.cache.asyncqueue.AsyncEventListener; + +import java.math.BigDecimal; +import java.util.HashMap; +import java.util.List; + +public class OrderAsyncQueueListener implements AsyncEventListener { + + private Region summaryRegion; + + public OrderAsyncQueueListener(Region summaryRegion) { + this.summaryRegion = summaryRegion; + } + + @Override + public boolean processEvents(List list) { + HashMap summaryMap = new HashMap<>(); + list.forEach(asyncEvent -> { + final Order order = (Order) asyncEvent.getDeserializedValue(); + if (order != null) { + order.getLineItems().forEach(lineItem -> { + OrderProductSummary orderProductSummary = summaryMap.get(lineItem.getProductId()); + if (orderProductSummary == null) { + orderProductSummary = new OrderProductSummary(lineItem.getProductId(), new BigDecimal("0.00")); + } + orderProductSummary.setSummaryAmount(orderProductSummary.getSummaryAmount().add(lineItem.calcTotal())); + summaryMap.put(lineItem.getProductId(), orderProductSummary); + }); + } + }); + + summaryMap.forEach((orderProductSummaryKey, orderProductSummary) -> { + final OrderProductSummary productSummary = summaryRegion.get(orderProductSummaryKey); + if (productSummary != null) { + final BigDecimal newSummaryAmount = productSummary.getSummaryAmount().add(orderProductSummary.getSummaryAmount()); + summaryRegion.put(orderProductSummaryKey, new OrderProductSummary(orderProductSummaryKey, newSummaryAmount)); + } else { + summaryRegion.put(orderProductSummaryKey, orderProductSummary); + } + }); + return true; + } +} \ No newline at end of file diff --git a/geode/events/src/main/java/example/springdata/geode/server/events/OrderProductSummary.java b/geode/events/src/main/java/example/springdata/geode/server/events/OrderProductSummary.java new file mode 100644 index 00000000..f27512bd --- /dev/null +++ b/geode/events/src/main/java/example/springdata/geode/server/events/OrderProductSummary.java @@ -0,0 +1,46 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import lombok.Data; +import org.springframework.data.annotation.Id; +import org.springframework.data.gemfire.mapping.annotation.Region; + +import java.io.Serializable; +import java.math.BigDecimal; + +/** + * OrderProductSummary is an object used in the examples to show a summary of all Orders on a per product basis, on a per + * timeframe shard (every 10s, or every 1hr) + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +@Region("OrderProductSummary") +public class OrderProductSummary implements Serializable { + + @Id + private Long summaryKey; + + private BigDecimal summaryAmount; + + public OrderProductSummary(Long summaryKey, BigDecimal summaryAmount) { + this.summaryKey = summaryKey; + this.summaryAmount = summaryAmount; + } +} \ No newline at end of file diff --git a/geode/events/src/main/java/example/springdata/geode/server/events/OrderProductSummaryRepository.java b/geode/events/src/main/java/example/springdata/geode/server/events/OrderProductSummaryRepository.java new file mode 100755 index 00000000..eb1525d4 --- /dev/null +++ b/geode/events/src/main/java/example/springdata/geode/server/events/OrderProductSummaryRepository.java @@ -0,0 +1,31 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import org.springframework.data.gemfire.mapping.annotation.Region; +import org.springframework.data.gemfire.repository.Query; +import org.springframework.data.gemfire.repository.query.annotation.Hint; +import org.springframework.data.repository.CrudRepository; + +import java.util.List; + +@Region("OrderProductSummary") +public interface OrderProductSummaryRepository extends CrudRepository { + @Hint("emailAddressIndex") + @Query("select orderSummary.value from /OrderProductSummary.entrySet orderSummary where orderSummary.key = $1") + List findAllForProductID(long l); +} diff --git a/geode/events/src/main/java/example/springdata/geode/server/events/OrderRepository.java b/geode/events/src/main/java/example/springdata/geode/server/events/OrderRepository.java new file mode 100755 index 00000000..be877760 --- /dev/null +++ b/geode/events/src/main/java/example/springdata/geode/server/events/OrderRepository.java @@ -0,0 +1,22 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import org.springframework.data.repository.CrudRepository; + +public interface OrderRepository extends CrudRepository { +} diff --git a/geode/events/src/main/java/example/springdata/geode/server/events/Product.java b/geode/events/src/main/java/example/springdata/geode/server/events/Product.java new file mode 100755 index 00000000..e9cb21e2 --- /dev/null +++ b/geode/events/src/main/java/example/springdata/geode/server/events/Product.java @@ -0,0 +1,68 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import lombok.Data; +import org.springframework.data.annotation.Id; +import org.springframework.data.annotation.PersistenceConstructor; +import org.springframework.data.annotation.Transient; +import org.springframework.data.gemfire.mapping.annotation.Region; + +import java.io.Serializable; +import java.math.BigDecimal; +import java.util.HashMap; +import java.util.Map; + +/** + * A product used in the examples. + * + * @author Oliver Gierke + * @author David Turanski + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +@Region("Products") +public class Product implements Serializable { + + @Id + private Long id; + private String name; + private BigDecimal price; + private String description; + + @Transient + private Map attributes = new HashMap<>(); + + @PersistenceConstructor + public Product(Long id, String name, BigDecimal price, String description) { + this.id = id; + this.name = name; + this.price = price; + this.description = description; + } + + /** + * Sets the attribute with the given name to the given value. + * + * @param name must not be null or empty. + * @param value + */ + public void addAttribute(String name, String value) { + this.attributes.put(name, value); + } +} diff --git a/geode/events/src/main/java/example/springdata/geode/server/events/ProductCacheLoader.java b/geode/events/src/main/java/example/springdata/geode/server/events/ProductCacheLoader.java new file mode 100755 index 00000000..6aca0394 --- /dev/null +++ b/geode/events/src/main/java/example/springdata/geode/server/events/ProductCacheLoader.java @@ -0,0 +1,43 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import com.github.javafaker.Faker; +import org.apache.geode.cache.CacheLoader; +import org.apache.geode.cache.CacheLoaderException; +import org.apache.geode.cache.LoaderHelper; +import org.springframework.stereotype.Component; + +import java.math.BigDecimal; + +@Component +public class ProductCacheLoader implements CacheLoader { + private Faker faker = new Faker(); + + @Override + public Product load(LoaderHelper loaderHelper) throws CacheLoaderException { + return new Product((long) loaderHelper.getKey(), randomStringName(), randomPrice(), ""); + } + + private BigDecimal randomPrice() { + return new BigDecimal(faker.commerce().price()); + } + + private String randomStringName() { + return faker.commerce().productName(); + } +} diff --git a/geode/events/src/main/java/example/springdata/geode/server/events/ProductRepository.java b/geode/events/src/main/java/example/springdata/geode/server/events/ProductRepository.java new file mode 100755 index 00000000..4f28a25f --- /dev/null +++ b/geode/events/src/main/java/example/springdata/geode/server/events/ProductRepository.java @@ -0,0 +1,22 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import org.springframework.data.repository.CrudRepository; + +public interface ProductRepository extends CrudRepository { +} diff --git a/geode/events/src/test/java/example/springdata/geode/server/events/EventServerTests.java b/geode/events/src/test/java/example/springdata/geode/server/events/EventServerTests.java new file mode 100755 index 00000000..d6840d81 --- /dev/null +++ b/geode/events/src/test/java/example/springdata/geode/server/events/EventServerTests.java @@ -0,0 +1,55 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.events; + +import org.apache.geode.cache.Cache; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.annotation.DirtiesContext; +import org.springframework.test.context.junit4.SpringRunner; + +import static org.assertj.core.api.Assertions.assertThat; + +@RunWith(SpringRunner.class) +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.NONE, classes = EventServer.class) +@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS) +public class EventServerTests { + + @Autowired + Cache cache; + + @Autowired + private ProductRepository productRepository; + + @Autowired + private OrderProductSummaryRepository orderProductSummaryRepository; + + @Test + public void asyncEventQueueEasConfiguredCorrectly() { + assertThat(this.orderProductSummaryRepository.count()).isEqualTo(3); + } + + @Test + public void productCacheLoaderWorks() { + long size = productRepository.count(); + assertThat(this.productRepository.findById(777L)).isNotNull(); + assertThat(productRepository.count()).isEqualTo(size + 1); + productRepository.deleteById(777L); + } +} \ No newline at end of file diff --git a/geode/events/src/test/resources/logback.xml b/geode/events/src/test/resources/logback.xml new file mode 100644 index 00000000..f3b82068 --- /dev/null +++ b/geode/events/src/test/resources/logback.xml @@ -0,0 +1,11 @@ + + + + %msg%n + + + + + + + \ No newline at end of file diff --git a/geode/expiration-eviction/README.md b/geode/expiration-eviction/README.md new file mode 100755 index 00000000..b7f95b2f --- /dev/null +++ b/geode/expiration-eviction/README.md @@ -0,0 +1,12 @@ +# Expiration and Eviction Example + +In this example we will show you ways to automatically remove data from your region. There are two ways to do this; Expiration and Eviction. + +1. Expiration removes data after it has existed for a certain amount of time or after it has been unused for a certain amount of time. There are multiple ways to configure Expiration that will be shown in this example. + 1. Configure an eviction policy on the region using the `@EnableExpiration` and `@ExpirationPolicy` annotations. + 2. Configure a custom eviction policy to extending `CustomExpiry`. + 3. Entity defined expiration using the `@IdleTimeoutExpiration` and `@TimeToLiveExpiration` annotations. + +Entity defined expiration has its own test class because it has a lower priority and is trumped by the expiration policy defined on the `@EnableExpiration` annotation. The polices defined on the `@EnableExpiration` annotation can be found in ExpirationPolicyConfig. + +NOTE: Inorder to see output, you must change the loglevel from "error" to "info" in the `logback.xml` file located under src/test/resources. \ No newline at end of file diff --git a/geode/expiration-eviction/pom.xml b/geode/expiration-eviction/pom.xml new file mode 100755 index 00000000..6d1bd957 --- /dev/null +++ b/geode/expiration-eviction/pom.xml @@ -0,0 +1,23 @@ + + + + example.springdata.geode + spring-data-geode-examples + 1.0-SNAPSHOT + + 4.0.0 + + expiration-eviction + + + + com.jayway.awaitility + awaitility + 1.7.0 + + + + + \ No newline at end of file diff --git a/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/Address.java b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/Address.java new file mode 100755 index 00000000..330611ca --- /dev/null +++ b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/Address.java @@ -0,0 +1,41 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.expiration.eviction; + +import lombok.Data; + +import java.io.Serializable; + +/** + * An address used in the examples. + * + * @author Oliver Gierke + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +public class Address implements Serializable { + private String street; + private String city; + private String country; + + public Address(String street, String city, String country) { + this.street = street; + this.city = city; + this.country = country; + } +} diff --git a/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/CustomCustomerExpiry.java b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/CustomCustomerExpiry.java new file mode 100755 index 00000000..9f68657a --- /dev/null +++ b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/CustomCustomerExpiry.java @@ -0,0 +1,40 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.expiration.eviction; + +import org.apache.geode.cache.CustomExpiry; +import org.apache.geode.cache.ExpirationAction; +import org.apache.geode.cache.ExpirationAttributes; +import org.apache.geode.cache.Region; + + +public class CustomCustomerExpiry implements CustomExpiry { + + private int timeout; + + public CustomCustomerExpiry(int timeout) { + this.timeout = timeout; + } + + @Override + public ExpirationAttributes getExpiry(Region.Entry entry) { + if (entry.getKey() % 3 == 0) { + return new ExpirationAttributes(timeout, ExpirationAction.DESTROY); + } + return null; + } +} \ No newline at end of file diff --git a/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/Customer.java b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/Customer.java new file mode 100755 index 00000000..7da9f4c3 --- /dev/null +++ b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/Customer.java @@ -0,0 +1,51 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.expiration.eviction; + +import lombok.Data; +import org.springframework.data.annotation.Id; +import org.springframework.data.gemfire.mapping.annotation.Region; + +import java.io.Serializable; +import java.util.Arrays; +import java.util.List; + +/** + * A customer used for Lucene examples. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +@Region(name = "Customers") +public class Customer implements Serializable { + + @Id + private Long id; + private EmailAddress emailAddress; + private String firstName; + private String lastName; + private List
addresses; + + public Customer(Long id, EmailAddress emailAddress, String firstName, String lastName, Address... addresses) { + this.id = id; + this.emailAddress = emailAddress; + this.firstName = firstName; + this.lastName = lastName; + this.addresses = Arrays.asList(addresses); + } +} \ No newline at end of file diff --git a/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/CustomerRepository.java b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/CustomerRepository.java new file mode 100755 index 00000000..a0d0f0d8 --- /dev/null +++ b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/CustomerRepository.java @@ -0,0 +1,24 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.expiration.eviction; + +import org.springframework.data.gemfire.mapping.annotation.Region; +import org.springframework.data.repository.CrudRepository; + +@Region("Customers") +public interface CustomerRepository extends CrudRepository { +} diff --git a/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/EmailAddress.java b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/EmailAddress.java new file mode 100755 index 00000000..6d3780b9 --- /dev/null +++ b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/EmailAddress.java @@ -0,0 +1,37 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.expiration.eviction; + +import lombok.Data; + +import java.io.Serializable; + +/** + * Value object to represent email addresses. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +public class EmailAddress implements Serializable { + private String value; + + public EmailAddress(String value) { + + this.value = value; + } +} \ No newline at end of file diff --git a/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/ExpirationEvictionServer.java b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/ExpirationEvictionServer.java new file mode 100755 index 00000000..e1ec74c8 --- /dev/null +++ b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/ExpirationEvictionServer.java @@ -0,0 +1,29 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.expiration.eviction; + +import org.springframework.boot.WebApplicationType; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.boot.builder.SpringApplicationBuilder; + +@SpringBootApplication(scanBasePackageClasses = ExpirationEvictionServerConfig.class) +public class ExpirationEvictionServer { + + public static void main(String[] args) { + new SpringApplicationBuilder(ExpirationEvictionServer.class).web(WebApplicationType.NONE).build().run(args); + } +} diff --git a/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/ExpirationEvictionServerConfig.java b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/ExpirationEvictionServerConfig.java new file mode 100755 index 00000000..8e574900 --- /dev/null +++ b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/ExpirationEvictionServerConfig.java @@ -0,0 +1,97 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.expiration.eviction; + +import com.github.javafaker.Faker; +import org.apache.geode.cache.CustomExpiry; +import org.apache.geode.cache.DataPolicy; +import org.apache.geode.cache.GemFireCache; +import org.apache.geode.cache.Scope; +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Import; +import org.springframework.data.gemfire.ReplicatedRegionFactoryBean; +import org.springframework.data.gemfire.config.annotation.CacheServerApplication; +import org.springframework.data.gemfire.config.annotation.EnableEviction; +import org.springframework.data.gemfire.config.annotation.EnableExpiration; +import org.springframework.data.gemfire.config.annotation.EnableLocator; +import org.springframework.data.gemfire.eviction.EvictionActionType; +import org.springframework.data.gemfire.eviction.EvictionPolicyType; +import org.springframework.data.gemfire.repository.config.EnableGemfireRepositories; + +@Configuration +@CacheServerApplication(logLevel = "error") +@EnableLocator +@EnableGemfireRepositories(basePackageClasses = CustomerRepository.class) +@EnableExpiration +@Import(ExpirationPolicyConfig.class) +@EnableEviction(policies = @EnableEviction.EvictionPolicy(regionNames = "Orders", + maximum = 10, + action = EvictionActionType.LOCAL_DESTROY, + type = EvictionPolicyType.ENTRY_COUNT)) +public class ExpirationEvictionServerConfig { + + @Bean + public Faker createDataFaker() { + return new Faker(); + } + + @Bean("IDLE") + CustomExpiry createIdleExpiration() { + return new CustomCustomerExpiry(2); + } + + @Bean("TTL") + CustomExpiry createTtlExpiration() { + return new CustomCustomerExpiry(4); + } + + @Bean("Products") + public ReplicatedRegionFactoryBean createProductRegion(GemFireCache gemFireCache, + @Qualifier("IDLE") CustomExpiry idleExpiry, + @Qualifier("TTL") CustomExpiry ttlExpiry) { + final ReplicatedRegionFactoryBean regionFactoryBean = new ReplicatedRegionFactoryBean<>(); + regionFactoryBean.setCache(gemFireCache); + regionFactoryBean.setScope(Scope.DISTRIBUTED_ACK); + regionFactoryBean.setDataPolicy(DataPolicy.REPLICATE); + regionFactoryBean.setName("Products"); + regionFactoryBean.setCustomEntryIdleTimeout(idleExpiry); + regionFactoryBean.setCustomEntryTimeToLive(ttlExpiry); + return regionFactoryBean; + } + + @Bean("Customers") + public ReplicatedRegionFactoryBean createCustomerRegion(GemFireCache gemFireCache) { + final ReplicatedRegionFactoryBean regionFactoryBean = new ReplicatedRegionFactoryBean<>(); + regionFactoryBean.setCache(gemFireCache); + regionFactoryBean.setScope(Scope.DISTRIBUTED_ACK); + regionFactoryBean.setDataPolicy(DataPolicy.REPLICATE); + regionFactoryBean.setName("Customers"); + return regionFactoryBean; + } + + @Bean("Orders") + public ReplicatedRegionFactoryBean createOrderRegion(GemFireCache gemFireCache) { + final ReplicatedRegionFactoryBean regionFactoryBean = new ReplicatedRegionFactoryBean<>(); + regionFactoryBean.setCache(gemFireCache); + regionFactoryBean.setScope(Scope.DISTRIBUTED_ACK); + regionFactoryBean.setDataPolicy(DataPolicy.REPLICATE); + regionFactoryBean.setName("Orders"); + return regionFactoryBean; + } +} diff --git a/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/ExpirationPolicyConfig.java b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/ExpirationPolicyConfig.java new file mode 100644 index 00000000..ea5b5cdf --- /dev/null +++ b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/ExpirationPolicyConfig.java @@ -0,0 +1,31 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.expiration.eviction; + +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Profile; +import org.springframework.data.gemfire.config.annotation.EnableExpiration; +import org.springframework.data.gemfire.expiration.ExpirationActionType; + +@Profile("!default") +@Configuration +@EnableExpiration(policies = { + @EnableExpiration.ExpirationPolicy(timeout = 4, action = ExpirationActionType.DESTROY, + regionNames = {"Customers"}, types = {EnableExpiration.ExpirationType.TIME_TO_LIVE}), + @EnableExpiration.ExpirationPolicy(timeout = 2, action = ExpirationActionType.DESTROY, + regionNames = {"Customers"}, types = {EnableExpiration.ExpirationType.IDLE_TIMEOUT})}) +public class ExpirationPolicyConfig { +} diff --git a/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/Order.java b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/Order.java new file mode 100755 index 00000000..1cde9eb5 --- /dev/null +++ b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/Order.java @@ -0,0 +1,50 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.expiration.eviction; + +import lombok.Data; +import org.springframework.data.annotation.Id; +import org.springframework.data.gemfire.expiration.IdleTimeoutExpiration; +import org.springframework.data.gemfire.expiration.TimeToLiveExpiration; +import org.springframework.data.gemfire.mapping.annotation.Region; + +import java.io.Serializable; + +/** + * Orders object used in the examples + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +@IdleTimeoutExpiration(action = "DESTROY", timeout = "2") +@TimeToLiveExpiration(action = "DESTROY", timeout = "4") +@Region("Orders") +public class Order implements Serializable { + @Id + private Long id; + private Long total; + private Address billingAddress; + private Address shippingAddress; + + public Order(Long orderId, Long total, Address address) { + this.id = orderId; + this.total = total; + this.billingAddress = address; + this.shippingAddress = address; + } +} \ No newline at end of file diff --git a/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/OrderRepository.java b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/OrderRepository.java new file mode 100644 index 00000000..3f8d18cf --- /dev/null +++ b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/OrderRepository.java @@ -0,0 +1,24 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.expiration.eviction; + +import org.springframework.data.gemfire.mapping.annotation.Region; +import org.springframework.data.repository.CrudRepository; + +@Region("Orders") +public interface OrderRepository extends CrudRepository { +} diff --git a/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/Product.java b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/Product.java new file mode 100755 index 00000000..9b766c0d --- /dev/null +++ b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/Product.java @@ -0,0 +1,52 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.expiration.eviction; + +import lombok.Data; +import org.springframework.data.annotation.Id; +import org.springframework.data.annotation.PersistenceConstructor; +import org.springframework.data.gemfire.mapping.annotation.Region; + +import java.io.Serializable; +import java.math.BigDecimal; + +/** + * A product used in the examples. + * + * @author Oliver Gierke + * @author David Turanski + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +@Region("Products") +public class Product implements Serializable { + + @Id + private Long id; + private String name; + private BigDecimal price; + private String description; + + @PersistenceConstructor + public Product(Long id, String name, BigDecimal price, String description) { + this.id = id; + this.name = name; + this.price = price; + this.description = description; + } +} diff --git a/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/ProductRepository.java b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/ProductRepository.java new file mode 100644 index 00000000..49f5d48d --- /dev/null +++ b/geode/expiration-eviction/src/main/java/example/springdata/geode/server/expiration/eviction/ProductRepository.java @@ -0,0 +1,22 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.expiration.eviction; + +import org.springframework.data.repository.CrudRepository; + +public interface ProductRepository extends CrudRepository { +} diff --git a/geode/expiration-eviction/src/test/java/example/springdata/geode/server/expiration/eviction/EntityDefinedExpirationTests.java b/geode/expiration-eviction/src/test/java/example/springdata/geode/server/expiration/eviction/EntityDefinedExpirationTests.java new file mode 100644 index 00000000..209b9fd3 --- /dev/null +++ b/geode/expiration-eviction/src/test/java/example/springdata/geode/server/expiration/eviction/EntityDefinedExpirationTests.java @@ -0,0 +1,84 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.expiration.eviction; + +import com.github.javafaker.Faker; +import com.jayway.awaitility.Awaitility; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.annotation.DirtiesContext; +import org.springframework.test.context.junit4.SpringRunner; + +import java.text.SimpleDateFormat; +import java.util.Date; +import java.util.concurrent.TimeUnit; + +import static org.assertj.core.api.Assertions.assertThat; + +@RunWith(SpringRunner.class) +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.NONE, classes = ExpirationEvictionServer.class) +@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS) +public class EntityDefinedExpirationTests { + + @Autowired + private OrderRepository orderRepository; + + @Autowired + Faker faker; + + private Logger logger = LoggerFactory.getLogger(this.getClass()); + + @Test + public void entityDefinedExpirationIsConfiguredCorrectly() { + orderRepository.save(new Order(1L, 50L, new Address(faker.address().streetAddress(), faker.address().city(), faker.address().country()))); + + assertThat(orderRepository.count()).isEqualTo(1); + + final SimpleDateFormat simpleDateFormat = new SimpleDateFormat("dd/MM/yyyy hh:mm:ss:SSS"); + logger.info("Starting TTL wait period: " + simpleDateFormat.format(new Date())); + //Due to the constant "getting" of the entry, the idle expiry timeout will not be met and the time-to-live + // will be used. + Awaitility.await() + .pollInterval(1, TimeUnit.SECONDS) + .atMost(10, TimeUnit.SECONDS) + .until(() -> !orderRepository.findById(1L).isPresent()); + + assertThat(orderRepository.count()).isEqualTo(0); + + logger.info("Ending TTL wait period: " + simpleDateFormat.format(new Date())); + + orderRepository.save(new Order(1L, 50L, new Address(faker.address().streetAddress(), faker.address().city(), faker.address().country()))); + + assertThat(orderRepository.count()).isEqualTo(1); + + logger.info("Starting Idle wait period: " + simpleDateFormat.format(new Date())); + + //Due to the delay in "getting" the entry, the idle timeout of 2s should delete the entry. + Awaitility.await() + .pollDelay(2, TimeUnit.SECONDS) + .pollInterval(100, TimeUnit.MILLISECONDS) + .atMost(10, TimeUnit.SECONDS) + .until(() -> !orderRepository.findById(1L).isPresent()); + + assertThat(orderRepository.count()).isEqualTo(0); + + logger.info("Ending Idle wait period: " + simpleDateFormat.format(new Date())); + } +} diff --git a/geode/expiration-eviction/src/test/java/example/springdata/geode/server/expiration/eviction/ExpirationEvictionServerTests.java b/geode/expiration-eviction/src/test/java/example/springdata/geode/server/expiration/eviction/ExpirationEvictionServerTests.java new file mode 100755 index 00000000..0b29c798 --- /dev/null +++ b/geode/expiration-eviction/src/test/java/example/springdata/geode/server/expiration/eviction/ExpirationEvictionServerTests.java @@ -0,0 +1,148 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.expiration.eviction; + +import com.github.javafaker.Faker; +import com.jayway.awaitility.Awaitility; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.annotation.DirtiesContext; +import org.springframework.test.context.ActiveProfiles; +import org.springframework.test.context.junit4.SpringRunner; + +import java.math.BigDecimal; +import java.text.SimpleDateFormat; +import java.util.Date; +import java.util.concurrent.TimeUnit; + +import static org.assertj.core.api.Assertions.assertThat; + +@RunWith(SpringRunner.class) +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.NONE, classes = ExpirationEvictionServer.class) +@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS) +@ActiveProfiles("expiration_policy") +public class ExpirationEvictionServerTests { + + @Autowired + private CustomerRepository customerRepository; + + @Autowired + private ProductRepository productRepository; + + @Autowired + private OrderRepository orderRepository; + + @Autowired + Faker faker; + + private Logger logger = LoggerFactory.getLogger(this.getClass()); + + @Test + public void cacheDefinedExpirationIsConfiguredCorrectly() { + customerRepository.save(new Customer(1L, new EmailAddress(faker.internet().emailAddress()), + faker.name().firstName(), faker.name().lastName(), + new Address(faker.address().streetAddress(), faker.address().city(), faker.address().country()))); + + assertThat(customerRepository.count()).isEqualTo(1); + + final SimpleDateFormat simpleDateFormat = new SimpleDateFormat("dd/MM/yyyy hh:mm:ss:SSS"); + logger.info("Starting TTL wait period: " + simpleDateFormat.format(new Date())); + //Due to the constant "getting" of the entry, the idle expiry timeout will not be met and the time-to-live + // will be used. + Awaitility.await() + .pollInterval(1, TimeUnit.SECONDS) + .atMost(10, TimeUnit.SECONDS) + .until(() -> !customerRepository.findById(1L).isPresent()); + + assertThat(customerRepository.count()).isEqualTo(0); + + logger.info("Ending TTL wait period: " + simpleDateFormat.format(new Date())); + + customerRepository.save(new Customer(1L, new EmailAddress(faker.internet().emailAddress()), + faker.name().firstName(), faker.name().lastName(), + new Address(faker.address().streetAddress(), faker.address().city(), faker.address().country()))); + + assertThat(customerRepository.count()).isEqualTo(1); + + logger.info("Starting Idle wait period: " + simpleDateFormat.format(new Date())); + + //Due to the delay in "getting" the entry, the idle timeout of 2s should delete the entry. + Awaitility.await() + .pollDelay(2, TimeUnit.SECONDS) + .pollInterval(100, TimeUnit.MILLISECONDS) + .atMost(10, TimeUnit.SECONDS) + .until(() -> !customerRepository.findById(1L).isPresent()); + + assertThat(customerRepository.count()).isEqualTo(0); + + logger.info("Ending Idle wait period: " + simpleDateFormat.format(new Date())); + } + + @Test + public void customExpirationIsConfiguredCorrectly() { + productRepository.save(new Product(3L, "MacBook Pro", BigDecimal.valueOf(20), "A cool computing device")); + + assertThat(productRepository.count()).isEqualTo(1); + + + final SimpleDateFormat simpleDateFormat = new SimpleDateFormat("dd/MM/yyyy hh:mm:ss:SSS"); + logger.info("Starting TTL wait period: " + simpleDateFormat.format(new Date())); + //Due to the constant "getting" of the entry, the idle expiry timeout will not be met and the time-to-live + // will be used. + Awaitility.await() + .pollInterval(1, TimeUnit.SECONDS) + .atMost(10, TimeUnit.SECONDS) + .until(() -> !productRepository.findById(3L).isPresent()); + + assertThat(productRepository.count()).isEqualTo(0); + + logger.info("Ending TTL wait period: " + simpleDateFormat.format(new Date())); + + productRepository.save(new Product(3L, "MacBook Pro", BigDecimal.valueOf(20), "A cool computing device")); + + assertThat(productRepository.count()).isEqualTo(1); + + logger.info("Starting Idle wait period: " + simpleDateFormat.format(new Date())); + + //Due to the delay in "getting" the entry, the idle timeout of 2s should delete the entry. + Awaitility.await() + .pollDelay(2, TimeUnit.SECONDS) + .pollInterval(100, TimeUnit.MILLISECONDS) + .atMost(10, TimeUnit.SECONDS) + .until(() -> !productRepository.findById(3L).isPresent()); + + assertThat(productRepository.count()).isEqualTo(0); + + logger.info("Ending Idle wait period: " + simpleDateFormat.format(new Date())); + } + + @Test + public void evictionIsConfiguredCorrectly() { + + final int evictionThreshold = 10; + for (long i = 0; i < evictionThreshold + 1; i++) { + orderRepository.save(new Order(i, i, new Address(faker.address().streetName(), faker.address().city(), faker.address().country()))); + } + + assertThat(orderRepository.count()).isEqualTo(evictionThreshold); + orderRepository.deleteAll(); + } +} \ No newline at end of file diff --git a/geode/expiration-eviction/src/test/resources/logback.xml b/geode/expiration-eviction/src/test/resources/logback.xml new file mode 100644 index 00000000..f3b82068 --- /dev/null +++ b/geode/expiration-eviction/src/test/resources/logback.xml @@ -0,0 +1,11 @@ + + + + %msg%n + + + + + + + \ No newline at end of file diff --git a/geode/function-invocation/README.md b/geode/function-invocation/README.md new file mode 100755 index 00000000..8b497e3e --- /dev/null +++ b/geode/function-invocation/README.md @@ -0,0 +1,37 @@ +# Function Invocation Example + +In this example a [Pivotal GemFire](https://pivotal.io/pivotal-gemfire) / [Apache Geode](http://geode.apache.org/) client will invoke remote functions registered on the server. + +To run the example simply run the tests located under function-invocation/src/test in your IDE. + +The client is configured to connect to the deployed/started server on `localhost` port `40404`. + +## Running the example + +The example is broken up into multiple steps: +1. Insert (Put) three Customer entries into the `Customers` region using the repositories `save` method. +2. Insert (Put) three Product entries into the `Products` region using the repositories `save` method. +3. Insert (Put) 100 Order entries into the `Orders` region using the repositories `save` method. + +Your output from the test `functionsExecuteCorrectly` should look similar to the following: + + Inserting 3 entries for keys: 1, 2, 3 + [FORK] - [info 2019/09/06 09:24:49.274 PDT tid=0x47] In region [Customers] created key [1] value [Customer(id=1, emailAddress=EmailAddress(value=2@2.com), firstName=John, lastName=Smith)] + [FORK] - + [FORK] - [info 2019/09/06 09:24:49.278 PDT tid=0x47] In region [Customers] created key [2] value [Customer(id=2, emailAddress=EmailAddress(value=3@3.com), firstName=Frank, lastName=Lamport)] + [FORK] - + [FORK] - [info 2019/09/06 09:24:49.279 PDT tid=0x47] In region [Customers] created key [3] value [Customer(id=3, emailAddress=EmailAddress(value=5@5.com), firstName=Jude, lastName=Simmons)] + [FORK] - + All customers for emailAddresses:3@3.com,2@2.com using function invocation: + [Customer(id=2, emailAddress=EmailAddress(value=3@3.com), firstName=Frank, lastName=Lamport), Customer(id=1, emailAddress=EmailAddress(value=2@2.com), firstName=John, lastName=Smith)] + Running function to sum up all product prices: + 1499.97 + Running function to sum up all order lineItems prices for order 1: + 2399.96 + For order: + Order(id=1, customerId=3, billingAddress=Address(street=it, city=doesn't, country=matter), shippingAddress=Address(street=it, city=doesn't, country=matter)) + LineItems:[Purchased 1 of Product Apple macBook at 899.99 for total of 899.99, Purchased 3 of Product Apple iPad at 499.99 for total of 1499.97] + +NOTE: Inorder to see output, you must change the loglevel from "error" to "info" in the `logback.xml` file located under src/test/resources. + +NOTE: Number of products purchased and total cost may vary from the above run as they are determined randomly. \ No newline at end of file diff --git a/geode/function-invocation/pom.xml b/geode/function-invocation/pom.xml new file mode 100755 index 00000000..79694888 --- /dev/null +++ b/geode/function-invocation/pom.xml @@ -0,0 +1,18 @@ + + + + example.springdata.geode + spring-data-geode-examples + 1.0-SNAPSHOT + + 4.0.0 + function-invocation + 1.0-SNAPSHOT + + + + + + \ No newline at end of file diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/Address.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/Address.java new file mode 100755 index 00000000..ccdf1fdd --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/Address.java @@ -0,0 +1,41 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function; + +import lombok.Data; + +import java.io.Serializable; + +/** + * An address used in the examples. + * + * @author Oliver Gierke + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +public class Address implements Serializable { + private String street; + private String city; + private String country; + + public Address(String street, String city, String country) { + this.street = street; + this.city = city; + this.country = country; + } +} diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/Customer.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/Customer.java new file mode 100755 index 00000000..e24b3d92 --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/Customer.java @@ -0,0 +1,58 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function; + +import lombok.Data; +import org.springframework.data.annotation.Id; +import org.springframework.data.gemfire.mapping.annotation.Region; + +import java.io.Serializable; +import java.util.Arrays; +import java.util.List; + +/** + * A customer used for Lucene examples. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +@Region(name = "Customers") +public class Customer implements Serializable { + + @Id + private Long id; + private EmailAddress emailAddress; + private String firstName; + private String lastName; + private List
addresses; + + public Customer(Long id, EmailAddress emailAddress, String firstName, String lastName, Address... addresses) { + this.id = id; + this.emailAddress = emailAddress; + this.firstName = firstName; + this.lastName = lastName; + this.addresses = Arrays.asList(addresses); + } + + /** + * Adds the given [Address] to the [Customer]. + */ + public void add(Address address) { + this.addresses.add(address); + } +} \ No newline at end of file diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/EmailAddress.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/EmailAddress.java new file mode 100755 index 00000000..145ed6d4 --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/EmailAddress.java @@ -0,0 +1,37 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function; + +import lombok.Data; + +import java.io.Serializable; + +/** + * Value object to represent email addresses. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +public class EmailAddress implements Serializable { + private String value; + + public EmailAddress(String value) { + + this.value = value; + } +} \ No newline at end of file diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/LineItem.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/LineItem.java new file mode 100755 index 00000000..4055db5b --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/LineItem.java @@ -0,0 +1,44 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function; + +import lombok.Data; + +import java.io.Serializable; +import java.math.BigDecimal; + +/** + * A LineItem used in the examples + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +public class LineItem implements Serializable { + + private Product product; + private Integer amount; + + public LineItem(Product product, Integer amount) { + this.product = product; + this.amount = amount; + } + + public BigDecimal calcTotal() { + return product.getPrice().multiply(BigDecimal.valueOf(amount)); + } +} \ No newline at end of file diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/Order.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/Order.java new file mode 100755 index 00000000..69550e8b --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/Order.java @@ -0,0 +1,73 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function; + +import lombok.Data; +import org.springframework.data.annotation.Id; +import org.springframework.data.gemfire.mapping.annotation.Region; + +import java.io.Serializable; +import java.math.BigDecimal; +import java.util.ArrayList; +import java.util.List; + +/** + * Orders object used in the examples + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +@Region("Orders") +public class Order implements Serializable { + @Id + private Long id; + private Long customerId; + private Address billingAddress; + private Address shippingAddress; + private List lineItems = new ArrayList<>(); + + public Order(Long orderId, Long customerId, Address address) { + this.id = orderId; + this.customerId = customerId; + this.billingAddress = address; + this.shippingAddress = address; + } + + /** + * Returns the total of the [Order]. + * + * @return + */ + + public BigDecimal calcTotal() { + if (lineItems.size() == 0) { + return BigDecimal.ZERO; + } else { + return lineItems.stream().map(LineItem::calcTotal).reduce(BigDecimal::add).get(); + } + } + + /** + * Adds the given [LineItem] to the [Order]. + * + * @param lineItem + */ + public void add(LineItem lineItem) { + lineItems.add(lineItem); + } +} \ No newline at end of file diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/Product.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/Product.java new file mode 100755 index 00000000..c10dfb0e --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/Product.java @@ -0,0 +1,68 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function; + +import lombok.Data; +import org.springframework.data.annotation.Id; +import org.springframework.data.annotation.PersistenceConstructor; +import org.springframework.data.annotation.Transient; +import org.springframework.data.gemfire.mapping.annotation.Region; + +import java.io.Serializable; +import java.math.BigDecimal; +import java.util.HashMap; +import java.util.Map; + +/** + * A product used in the examples. + * + * @author Oliver Gierke + * @author David Turanski + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +@Region("Products") +public class Product implements Serializable { + + @Id + private Long id; + private String name; + private BigDecimal price; + private String description; + + @Transient + private Map attributes = new HashMap<>(); + + @PersistenceConstructor + public Product(Long id, String name, BigDecimal price, String description) { + this.id = id; + this.name = name; + this.price = price; + this.description = description; + } + + /** + * Sets the attribute with the given name to the given value. + * + * @param name must not be null or empty. + * @param value + */ + public void addAttribute(String name, String value) { + this.attributes.put(name, value); + } +} diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/CustomerFunctionExecutions.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/CustomerFunctionExecutions.java new file mode 100755 index 00000000..7ad8f320 --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/CustomerFunctionExecutions.java @@ -0,0 +1,30 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function.client; + +import example.springdata.geode.client.function.Customer; +import org.springframework.data.gemfire.function.annotation.FunctionId; +import org.springframework.data.gemfire.function.annotation.OnRegion; + +import java.util.List; + +@OnRegion(region = "Customers") +public interface CustomerFunctionExecutions { + + @FunctionId("listConsumersForEmailAddressesFnc") + List> listAllCustomersForEmailAddress(String... emailAddresses); +} \ No newline at end of file diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/CustomerRepository.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/CustomerRepository.java new file mode 100755 index 00000000..b2154535 --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/CustomerRepository.java @@ -0,0 +1,42 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function.client; + +import example.springdata.geode.client.function.Customer; +import org.springframework.data.gemfire.mapping.annotation.ClientRegion; +import org.springframework.data.gemfire.repository.Query; +import org.springframework.data.gemfire.repository.query.annotation.Hint; +import org.springframework.data.gemfire.repository.query.annotation.Limit; +import org.springframework.data.gemfire.repository.query.annotation.Trace; +import org.springframework.data.repository.CrudRepository; + +import java.util.List; + +@ClientRegion("Customers") +public interface CustomerRepository extends CrudRepository { + + @Trace + @Limit(100) + @Hint("emailAddressIndex") + @Query("select * from /Customers customer where customer.emailAddress.value = $1") + List findByEmailAddressUsingIndex(String emailAddress); + + @Trace + @Limit(100) + @Query("select * from /Customers customer where customer.firstName = $1") + List findByFirstNameUsingIndex(String firstName); +} \ No newline at end of file diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/FunctionInvocationClientApplicationConfig.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/FunctionInvocationClientApplicationConfig.java new file mode 100755 index 00000000..ddc0ff89 --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/FunctionInvocationClientApplicationConfig.java @@ -0,0 +1,72 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function.client; + +import example.springdata.geode.client.function.Customer; +import example.springdata.geode.client.function.Order; +import example.springdata.geode.client.function.Product; +import org.apache.geode.cache.GemFireCache; +import org.apache.geode.cache.client.ClientRegionShortcut; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.data.gemfire.client.ClientRegionFactoryBean; +import org.springframework.data.gemfire.config.annotation.ClientCacheApplication; +import org.springframework.data.gemfire.function.config.EnableGemfireFunctionExecutions; +import org.springframework.data.gemfire.repository.config.EnableGemfireRepositories; +import org.springframework.data.gemfire.transaction.config.EnableGemfireCacheTransactions; + +/** + * Spring JavaConfig configuration class to setup a Spring container and infrastructure components. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ + +@Configuration +@EnableGemfireRepositories(basePackageClasses = CustomerRepository.class) +@EnableGemfireFunctionExecutions(basePackageClasses = CustomerFunctionExecutions.class) +@ClientCacheApplication(name = "FunctionInvocationClient", logLevel = "error", pingInterval = 5000L, readTimeout = 15000, retryAttempts = 1) +@EnableGemfireCacheTransactions +public class FunctionInvocationClientApplicationConfig { + + @Bean("Customers") + protected ClientRegionFactoryBean configureProxyClientCustomerRegion(GemFireCache gemFireCache) { + ClientRegionFactoryBean clientRegionFactoryBean = new ClientRegionFactoryBean<>(); + clientRegionFactoryBean.setCache(gemFireCache); + clientRegionFactoryBean.setName("Customers"); + clientRegionFactoryBean.setShortcut(ClientRegionShortcut.PROXY); + return clientRegionFactoryBean; + } + + @Bean("Products") + protected ClientRegionFactoryBean configureProxyClientProductRegion(GemFireCache gemFireCache) { + ClientRegionFactoryBean clientRegionFactoryBean = new ClientRegionFactoryBean<>(); + clientRegionFactoryBean.setCache(gemFireCache); + clientRegionFactoryBean.setName("Products"); + clientRegionFactoryBean.setShortcut(ClientRegionShortcut.PROXY); + return clientRegionFactoryBean; + } + + @Bean("Orders") + protected ClientRegionFactoryBean configureProxyClientOrderRegion(GemFireCache gemFireCache) { + ClientRegionFactoryBean clientRegionFactoryBean = new ClientRegionFactoryBean<>(); + clientRegionFactoryBean.setCache(gemFireCache); + clientRegionFactoryBean.setName("Orders"); + clientRegionFactoryBean.setShortcut(ClientRegionShortcut.PROXY); + return clientRegionFactoryBean; + } +} \ No newline at end of file diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/OrderFunctionExecutions.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/OrderFunctionExecutions.java new file mode 100755 index 00000000..38c41541 --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/OrderFunctionExecutions.java @@ -0,0 +1,30 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function.client; + +import org.springframework.data.gemfire.function.annotation.FunctionId; +import org.springframework.data.gemfire.function.annotation.OnRegion; + +import java.math.BigDecimal; +import java.util.List; + +@OnRegion(region = "Orders") +public interface OrderFunctionExecutions { + + @FunctionId("sumPricesForAllProductsForOrderFnc") + List sumPricesForAllProductsForOrder(Long orderId); +} \ No newline at end of file diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/OrderRepository.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/OrderRepository.java new file mode 100755 index 00000000..22b80fc5 --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/OrderRepository.java @@ -0,0 +1,26 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function.client; + +import example.springdata.geode.client.function.Order; +import org.springframework.data.gemfire.mapping.annotation.ClientRegion; +import org.springframework.data.repository.CrudRepository; + +@ClientRegion("Orders") +public interface OrderRepository extends CrudRepository { + +} diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/ProductFunctionExecutions.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/ProductFunctionExecutions.java new file mode 100755 index 00000000..ef9cac47 --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/ProductFunctionExecutions.java @@ -0,0 +1,30 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function.client; + +import org.springframework.data.gemfire.function.annotation.FunctionId; +import org.springframework.data.gemfire.function.annotation.OnRegion; + +import java.math.BigDecimal; +import java.util.List; + +@OnRegion(region = "Products") +public interface ProductFunctionExecutions { + + @FunctionId("sumPricesForAllProductsFnc") + List sumPricesForAllProducts(); +} \ No newline at end of file diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/ProductRepository.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/ProductRepository.java new file mode 100755 index 00000000..c7159880 --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/client/ProductRepository.java @@ -0,0 +1,26 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function.client; + +import example.springdata.geode.client.function.Product; +import org.springframework.data.gemfire.mapping.annotation.ClientRegion; +import org.springframework.data.repository.CrudRepository; + +@ClientRegion("Products") +public interface ProductRepository extends CrudRepository { + +} diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/server/CustomerFunctions.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/server/CustomerFunctions.java new file mode 100755 index 00000000..48642fbc --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/server/CustomerFunctions.java @@ -0,0 +1,41 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function.server; + +import example.springdata.geode.client.function.Customer; +import org.springframework.data.gemfire.function.annotation.GemfireFunction; +import org.springframework.data.gemfire.function.annotation.RegionData; +import org.springframework.stereotype.Component; + +import java.util.Arrays; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; + +@Component +public class CustomerFunctions { + + @GemfireFunction(id = "listConsumersForEmailAddressesFnc", HA = true, optimizeForWrite = true, batchSize = 3, hasResult = true) + public List listAllCustomersForEmailAddress(@RegionData Map customerData, + String... emailAddresses) { + List emailAddressesAsList = Arrays.asList(emailAddresses); + List collect = customerData.values().parallelStream() + .filter((customer) -> emailAddressesAsList.contains(customer.getEmailAddress().getValue())) + .collect(Collectors.toList()); + return collect; + } +} diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/server/FunctionServer.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/server/FunctionServer.java new file mode 100755 index 00000000..d93642ee --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/server/FunctionServer.java @@ -0,0 +1,29 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function.server; + +import org.springframework.boot.WebApplicationType; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.boot.builder.SpringApplicationBuilder; + +@SpringBootApplication(scanBasePackageClasses = FunctionServerApplicationConfig.class) +public class FunctionServer { + + public static void main(String[] args) { + new SpringApplicationBuilder(FunctionServer.class).web(WebApplicationType.NONE).build().run(args); + } +} diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/server/FunctionServerApplicationConfig.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/server/FunctionServerApplicationConfig.java new file mode 100755 index 00000000..62830acb --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/server/FunctionServerApplicationConfig.java @@ -0,0 +1,74 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function.server; + +import example.springdata.geode.client.function.Customer; +import example.springdata.geode.client.function.Order; +import example.springdata.geode.client.function.Product; +import example.springdata.geode.client.function.client.CustomerRepository; +import org.apache.geode.cache.DataPolicy; +import org.apache.geode.cache.GemFireCache; +import org.apache.geode.cache.Scope; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.context.annotation.Configuration; +import org.springframework.data.gemfire.ReplicatedRegionFactoryBean; +import org.springframework.data.gemfire.config.annotation.CacheServerApplication; +import org.springframework.data.gemfire.config.annotation.EnableIndexing; +import org.springframework.data.gemfire.config.annotation.EnableLocator; +import org.springframework.data.gemfire.config.annotation.EnableManager; +import org.springframework.data.gemfire.function.config.EnableGemfireFunctions; +import org.springframework.data.gemfire.repository.config.EnableGemfireRepositories; + +@Configuration +@ComponentScan(basePackageClasses = CustomerFunctions.class) +@EnableGemfireFunctions +@EnableGemfireRepositories(basePackageClasses = CustomerRepository.class) +@EnableLocator +@EnableIndexing +@EnableManager +@CacheServerApplication(port = 0, logLevel = "error") +public class FunctionServerApplicationConfig { + + @Bean("Customers") + ReplicatedRegionFactoryBean createCustomerRegion(GemFireCache gemfireCache) { + ReplicatedRegionFactoryBean replicatedRegionFactoryBean = new ReplicatedRegionFactoryBean<>(); + replicatedRegionFactoryBean.setCache(gemfireCache); + replicatedRegionFactoryBean.setRegionName("Customers"); + replicatedRegionFactoryBean.setDataPolicy(DataPolicy.REPLICATE); + replicatedRegionFactoryBean.setScope(Scope.DISTRIBUTED_ACK); + return replicatedRegionFactoryBean; + } + + @Bean("Orders") + ReplicatedRegionFactoryBean createOrderRegion(GemFireCache gemfireCache) { + ReplicatedRegionFactoryBean replicatedRegionFactoryBean = new ReplicatedRegionFactoryBean<>(); + replicatedRegionFactoryBean.setCache(gemfireCache); + replicatedRegionFactoryBean.setRegionName("Orders"); + replicatedRegionFactoryBean.setDataPolicy(DataPolicy.REPLICATE); + return replicatedRegionFactoryBean; + } + + @Bean("Products") + ReplicatedRegionFactoryBean createProductRegion(GemFireCache gemfireCache) { + ReplicatedRegionFactoryBean replicatedRegionFactoryBean = new ReplicatedRegionFactoryBean<>(); + replicatedRegionFactoryBean.setCache(gemfireCache); + replicatedRegionFactoryBean.setRegionName("Products"); + replicatedRegionFactoryBean.setDataPolicy(DataPolicy.REPLICATE); + return replicatedRegionFactoryBean; + } +} diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/server/OrderFunctions.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/server/OrderFunctions.java new file mode 100755 index 00000000..686395e6 --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/server/OrderFunctions.java @@ -0,0 +1,34 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function.server; + +import example.springdata.geode.client.function.Order; +import org.springframework.data.gemfire.function.annotation.GemfireFunction; +import org.springframework.data.gemfire.function.annotation.RegionData; +import org.springframework.stereotype.Component; + +import java.math.BigDecimal; +import java.util.Map; + +@Component +public class OrderFunctions { + + @GemfireFunction(id = "sumPricesForAllProductsForOrderFnc", HA = true, optimizeForWrite = false, hasResult = true) + public BigDecimal sumPricesForAllProductsForOrderFnc(Long orderId, @RegionData Map orderData) { + return orderData.get(orderId).calcTotal(); + } +} diff --git a/geode/function-invocation/src/main/java/example/springdata/geode/client/function/server/ProductFunctions.java b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/server/ProductFunctions.java new file mode 100755 index 00000000..8a9fda9e --- /dev/null +++ b/geode/function-invocation/src/main/java/example/springdata/geode/client/function/server/ProductFunctions.java @@ -0,0 +1,34 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function.server; + +import example.springdata.geode.client.function.Product; +import org.springframework.data.gemfire.function.annotation.GemfireFunction; +import org.springframework.data.gemfire.function.annotation.RegionData; +import org.springframework.stereotype.Component; + +import java.math.BigDecimal; +import java.util.Map; + +@Component +public class ProductFunctions { + + @GemfireFunction(id = "sumPricesForAllProductsFnc", HA = true, optimizeForWrite = false, hasResult = true) + public BigDecimal sumPricesForAllProductsFnc(@RegionData Map productData) { + return productData.values().stream().map(Product::getPrice).reduce(BigDecimal::add).get(); + } +} diff --git a/geode/function-invocation/src/test/java/example/springdata/geode/client/function/client/FunctionInvocationClientTests.java b/geode/function-invocation/src/test/java/example/springdata/geode/client/function/client/FunctionInvocationClientTests.java new file mode 100755 index 00000000..e2f60715 --- /dev/null +++ b/geode/function-invocation/src/test/java/example/springdata/geode/client/function/client/FunctionInvocationClientTests.java @@ -0,0 +1,145 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.function.client; + +import example.springdata.geode.client.function.Address; +import example.springdata.geode.client.function.Customer; +import example.springdata.geode.client.function.EmailAddress; +import example.springdata.geode.client.function.LineItem; +import example.springdata.geode.client.function.Order; +import example.springdata.geode.client.function.Product; +import example.springdata.geode.client.function.server.FunctionServer; +import org.apache.geode.cache.Region; +import org.junit.BeforeClass; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.data.gemfire.tests.integration.ForkingClientServerIntegrationTestsSupport; +import org.springframework.test.annotation.DirtiesContext; +import org.springframework.test.context.junit4.SpringRunner; + +import javax.annotation.Resource; +import java.io.IOException; +import java.math.BigDecimal; +import java.util.List; +import java.util.Random; +import java.util.stream.IntStream; +import java.util.stream.LongStream; + +import static org.assertj.core.api.Assertions.assertThat; + +@RunWith(SpringRunner.class) +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.NONE, classes = FunctionInvocationClientApplicationConfig.class) +@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS) +public class FunctionInvocationClientTests extends ForkingClientServerIntegrationTestsSupport { + + @Autowired + private CustomerRepository customerRepository; + + @Autowired + private OrderRepository orderRepository; + + @Autowired + private ProductRepository productRepository; + + @Autowired + private CustomerFunctionExecutions customerFunctionExecutions; + + @Autowired + private OrderFunctionExecutions orderFunctionExecutions; + + @Autowired + private ProductFunctionExecutions productFunctionExecutions; + + @Resource(name = "Customers") + private Region customers; + + @Resource(name = "Orders") + private Region orders; + + @Resource(name = "Products") + private Region products; + + private Logger logger = LoggerFactory.getLogger(this.getClass()); + + @BeforeClass + public static void setup() throws IOException { + startGemFireServer(FunctionServer.class); + } + + @Test + public void functionsExecuteCorrectly() { + createCustomerData(); + + List cust = customerFunctionExecutions.listAllCustomersForEmailAddress("2@2.com", "3@3.com").get(0); + assertThat(cust.size()).isEqualTo(2); + logger.info("All customers for emailAddresses:3@3.com,2@2.com using function invocation: \n\t " + cust); + + createProducts(); + BigDecimal sum = productFunctionExecutions.sumPricesForAllProducts().get(0); + assertThat(sum).isEqualTo(BigDecimal.valueOf(1499.97)); + logger.info("Running function to sum up all product prices: \n\t" + sum); + + createOrders(); + + sum = orderFunctionExecutions.sumPricesForAllProductsForOrder(1L).get(0); + assertThat(sum).isGreaterThanOrEqualTo(BigDecimal.valueOf(99.99)); + logger.info("Running function to sum up all order lineItems prices for order 1: \n\t" + sum); + Order order = orderRepository.findById(1L).get(); + logger.info("For order: \n\t " + order); + } + + public void createCustomerData() { + + logger.info("Inserting 3 entries for keys: 1, 2, 3"); + customerRepository.save(new Customer(1L, new EmailAddress("2@2.com"), "John", "Smith")); + customerRepository.save(new Customer(2L, new EmailAddress("3@3.com"), "Frank", "Lamport")); + customerRepository.save(new Customer(3L, new EmailAddress("5@5.com"), "Jude", "Simmons")); + assertThat(customers.keySetOnServer().size()).isEqualTo(3); + } + + public void createProducts() { + productRepository.save(new Product(1L, "Apple iPod", new BigDecimal("99.99"), + "An Apple portable music player")); + productRepository.save(new Product(2L, "Apple iPad", new BigDecimal("499.99"), + "An Apple tablet device")); + Product macbook = new Product(3L, "Apple macBook", new BigDecimal("899.99"), + "An Apple notebook computer"); + macbook.addAttribute("warranty", "included"); + productRepository.save(macbook); + assertThat(products.keySetOnServer().size()).isEqualTo(3); + } + + public void createOrders() { + Random random = new Random(); + Address address = new Address("it", "doesn't", "matter"); + LongStream.rangeClosed(1, 100).forEach((orderId) -> + LongStream.rangeClosed(1, 3).forEach((customerId) -> { + Order order = new Order(orderId, customerId, address); + IntStream.rangeClosed(0, random.nextInt(3) + 1).forEach((lineItemCount) -> { + int quantity = random.nextInt(3) + 1; + long productId = random.nextInt(3) + 1; + order.add(new LineItem(productRepository.findById(productId).get(), quantity)); + }); + orderRepository.save(order); + })); + assertThat(orders.keySetOnServer().size()).isEqualTo(100); + } +} \ No newline at end of file diff --git a/geode/function-invocation/src/test/resources/logback.xml b/geode/function-invocation/src/test/resources/logback.xml new file mode 100644 index 00000000..f3b82068 --- /dev/null +++ b/geode/function-invocation/src/test/resources/logback.xml @@ -0,0 +1,11 @@ + + + + %msg%n + + + + + + + \ No newline at end of file diff --git a/geode/pom.xml b/geode/pom.xml new file mode 100755 index 00000000..c780f93f --- /dev/null +++ b/geode/pom.xml @@ -0,0 +1,128 @@ + + + 4.0.0 + + example.springdata.geode + spring-data-geode-examples + 1.0-SNAPSHOT + https://github.com/spring-projects/spring-geode-examples + pom + + + events + expiration-eviction + function-invocation + queries + security + storage + transactions + wan + + + + SpringSource + http://springsource.org + + + + + The Apache Software License, Version 2.0 + http://www.apache.org/licenses/LICENSE-2.0.txt + repo + + + + + org.springframework.data.build + spring-data-parent + 2.2.5.BUILD-SNAPSHOT + + + + 2.12.1 + 1.7.28 + 2.2.4.BUILD-SNAPSHOT + 0.0.12.RELEASE + Moore-RELEASE + + + + + + org.springframework.data + spring-data-releasetrain + ${spring.data.releasetrain.version} + pom + import + + + + + + + org.projectlombok + lombok + 1.18.12 + provided + + + com.github.javafaker + javafaker + 1.0.1 + + + org.springframework.data + spring-data-geode + ${spring.boot.version} + + + org.springframework.data + spring-data-geode-test + ${spring.test.data.geode.version} + test + + + org.springframework.boot + spring-boot-starter + ${spring.boot.version} + + + org.springframework.boot + spring-boot-starter-logging + + + + + org.springframework.boot + spring-boot-starter-test + ${spring.boot.version} + test + + + org.slf4j + slf4j-api + ${slf4j.log4j.version} + compile + + + + + + + org.springframework.boot + spring-boot-maven-plugin + ${spring.boot.version} + + + maven-compiler-plugin + + 1.8 + 1.8 + + + + + + \ No newline at end of file diff --git a/geode/queries/README.md b/geode/queries/README.md new file mode 100755 index 00000000..fb464edf --- /dev/null +++ b/geode/queries/README.md @@ -0,0 +1,8 @@ +# Queries Example + +In this example we will demonstrate different kinds of queries. The kinds of queries we will demonstrate are listed below. +1. OQL Queries - OQL is similar to SQl and can be used to query regions like SQl queries tables in a relational database. +2. Continuous Queries - Continuous queries are special OQl queries that run continuously and are updated when th returned result set changes (like then more data is added/removed on the region) +3. Lucene Queries - Lucene Queries allow you ot query data that has been indexed with Apache Geode's Apache Lucene support. + +NOTE: Inorder to see output, you must change the loglevel from "error" to "info" in the `logback.xml` file located under src/test/resources. \ No newline at end of file diff --git a/geode/queries/pom.xml b/geode/queries/pom.xml new file mode 100755 index 00000000..f4c942c3 --- /dev/null +++ b/geode/queries/pom.xml @@ -0,0 +1,24 @@ + + + + example.springdata.geode + spring-data-geode-examples + 1.0-SNAPSHOT + + 4.0.0 + + example.springdata.geode.client + queries + 1.0-SNAPSHOT + + + org.awaitility + awaitility + 3.1.6 + test + + + + \ No newline at end of file diff --git a/geode/queries/src/main/java/example/springdata/geode/client/queries/Customer.java b/geode/queries/src/main/java/example/springdata/geode/client/queries/Customer.java new file mode 100755 index 00000000..babebc0a --- /dev/null +++ b/geode/queries/src/main/java/example/springdata/geode/client/queries/Customer.java @@ -0,0 +1,52 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.queries; + +import lombok.Data; +import org.springframework.data.annotation.Id; +import org.springframework.data.gemfire.mapping.annotation.LuceneIndexed; +import org.springframework.data.gemfire.mapping.annotation.PartitionRegion; + +import java.io.Serializable; + +/** + * A customer used for Lucene examples. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ + +@Data +@PartitionRegion(name = "Customers") +public class Customer implements Serializable { + @Id + private Long id; + + private EmailAddress emailAddress; + + private String firstName; + + @LuceneIndexed(name = "lastName_lucene") + private String lastName; + + public Customer(long id, EmailAddress emailAddress, String firstName, String lastName) { + this.id = id; + this.emailAddress = emailAddress; + this.firstName = firstName; + this.lastName = lastName; + } +} \ No newline at end of file diff --git a/geode/queries/src/main/java/example/springdata/geode/client/queries/EmailAddress.java b/geode/queries/src/main/java/example/springdata/geode/client/queries/EmailAddress.java new file mode 100755 index 00000000..5e07ca50 --- /dev/null +++ b/geode/queries/src/main/java/example/springdata/geode/client/queries/EmailAddress.java @@ -0,0 +1,37 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.queries; + +import lombok.Data; + +import java.io.Serializable; + +/** + * Value object to represent email addresses. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +public class EmailAddress implements Serializable { + private String value; + + public EmailAddress(String value) { + + this.value = value; + } +} \ No newline at end of file diff --git a/geode/queries/src/main/java/example/springdata/geode/client/queries/client/CustomerRepository.java b/geode/queries/src/main/java/example/springdata/geode/client/queries/client/CustomerRepository.java new file mode 100755 index 00000000..81424cd7 --- /dev/null +++ b/geode/queries/src/main/java/example/springdata/geode/client/queries/client/CustomerRepository.java @@ -0,0 +1,41 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.queries.client; + +import example.springdata.geode.client.queries.Customer; +import org.springframework.data.gemfire.mapping.annotation.ClientRegion; +import org.springframework.data.gemfire.repository.Query; +import org.springframework.data.gemfire.repository.query.annotation.Hint; +import org.springframework.data.gemfire.repository.query.annotation.Limit; +import org.springframework.data.gemfire.repository.query.annotation.Trace; +import org.springframework.data.repository.CrudRepository; + +import java.util.List; + +@ClientRegion(name = "Customers") +public interface CustomerRepository extends CrudRepository { + @Trace + @Limit(100) + @Hint("emailAddressIndex") + @Query("select * from /Customers customer where customer.emailAddress.value = $1") + List findByEmailAddressUsingIndex(String emailAddress); + + @Trace + @Limit(100) + @Query("select * from /Customers customer where customer.firstName = $1") + List findByFirstNameUsingIndex(String firstName); +} diff --git a/geode/queries/src/main/java/example/springdata/geode/client/queries/client/QueryClientConfig.java b/geode/queries/src/main/java/example/springdata/geode/client/queries/client/QueryClientConfig.java new file mode 100755 index 00000000..5b3de4c1 --- /dev/null +++ b/geode/queries/src/main/java/example/springdata/geode/client/queries/client/QueryClientConfig.java @@ -0,0 +1,48 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.queries.client; + +import org.apache.geode.cache.GemFireCache; +import org.apache.geode.cache.client.ClientRegionShortcut; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.DependsOn; +import org.springframework.data.gemfire.GemfireTemplate; +import org.springframework.data.gemfire.config.annotation.ClientCacheApplication; +import org.springframework.data.gemfire.config.annotation.EnableClusterDefinedRegions; +import org.springframework.data.gemfire.config.annotation.EnableContinuousQueries; +import org.springframework.data.gemfire.repository.config.EnableGemfireRepositories; +import org.springframework.data.gemfire.search.lucene.LuceneTemplate; + +@Configuration +@EnableGemfireRepositories(basePackageClasses = CustomerRepository.class) +@ClientCacheApplication(name = "CQClientCache", logLevel = "error", pingInterval = 5000L, readTimeout = 15000, subscriptionEnabled = true, readyForEvents = true) +@EnableContinuousQueries +@EnableClusterDefinedRegions(clientRegionShortcut = ClientRegionShortcut.PROXY) +public class QueryClientConfig { + + @Bean("customerTemplate") + @DependsOn("Customers") + protected GemfireTemplate configureCustomerTemplate(GemFireCache gemfireCache) { + return new GemfireTemplate(gemfireCache.getRegion("Customers")); + } + + @Bean + LuceneTemplate createCustomerLuceneTemplate() { + return new LuceneTemplate("lastName_lucene", "/Customers"); + } +} \ No newline at end of file diff --git a/geode/queries/src/main/java/example/springdata/geode/client/queries/server/QueryServer.java b/geode/queries/src/main/java/example/springdata/geode/client/queries/server/QueryServer.java new file mode 100755 index 00000000..cc95bce9 --- /dev/null +++ b/geode/queries/src/main/java/example/springdata/geode/client/queries/server/QueryServer.java @@ -0,0 +1,29 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.queries.server; + +import org.springframework.boot.WebApplicationType; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.boot.builder.SpringApplicationBuilder; + +@SpringBootApplication(scanBasePackageClasses = QueryServerConfig.class) +public class QueryServer { + + public static void main(String[] args) { + new SpringApplicationBuilder(QueryServer.class).web(WebApplicationType.NONE).build().run(args); + } +} \ No newline at end of file diff --git a/geode/queries/src/main/java/example/springdata/geode/client/queries/server/QueryServerConfig.java b/geode/queries/src/main/java/example/springdata/geode/client/queries/server/QueryServerConfig.java new file mode 100755 index 00000000..441e4760 --- /dev/null +++ b/geode/queries/src/main/java/example/springdata/geode/client/queries/server/QueryServerConfig.java @@ -0,0 +1,42 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.queries.server; + +import example.springdata.geode.client.queries.Customer; +import example.springdata.geode.client.queries.client.CustomerRepository; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.DependsOn; +import org.springframework.data.gemfire.config.annotation.CacheServerApplication; +import org.springframework.data.gemfire.config.annotation.EnableEntityDefinedRegions; +import org.springframework.data.gemfire.config.annotation.EnableIndexing; +import org.springframework.data.gemfire.repository.config.EnableGemfireRepositories; +import org.springframework.data.gemfire.search.lucene.LuceneTemplate; + +@Configuration +@CacheServerApplication(logLevel = "error") +@EnableGemfireRepositories(basePackageClasses = CustomerRepository.class) +@EnableEntityDefinedRegions(basePackageClasses = Customer.class) +@EnableIndexing +public class QueryServerConfig { + + @Bean + @DependsOn("lastName_lucene") + LuceneTemplate createCustomerLuceneTemplate() { + return new LuceneTemplate("lastName_lucene", "/Customers"); + } +} \ No newline at end of file diff --git a/geode/queries/src/test/java/example/springdata/geode/client/queries/QueryTests.java b/geode/queries/src/test/java/example/springdata/geode/client/queries/QueryTests.java new file mode 100755 index 00000000..b026f237 --- /dev/null +++ b/geode/queries/src/test/java/example/springdata/geode/client/queries/QueryTests.java @@ -0,0 +1,158 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.queries; + +import example.springdata.geode.client.queries.client.CustomerRepository; +import example.springdata.geode.client.queries.client.QueryClientConfig; +import example.springdata.geode.client.queries.server.QueryServer; +import org.apache.geode.cache.Region; +import org.apache.geode.cache.lucene.LuceneResultStruct; +import org.apache.geode.cache.query.CqEvent; +import org.awaitility.Awaitility; +import org.junit.After; +import org.junit.BeforeClass; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.data.gemfire.GemfireTemplate; +import org.springframework.data.gemfire.listener.ContinuousQueryListenerContainer; +import org.springframework.data.gemfire.listener.annotation.ContinuousQuery; +import org.springframework.data.gemfire.search.lucene.LuceneTemplate; +import org.springframework.data.gemfire.tests.integration.ForkingClientServerIntegrationTestsSupport; +import org.springframework.test.annotation.DirtiesContext; +import org.springframework.test.context.junit4.SpringRunner; + +import javax.annotation.Resource; +import java.io.IOException; +import java.util.List; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicInteger; + +import static org.assertj.core.api.Assertions.assertThat; + +@RunWith(SpringRunner.class) +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.NONE, classes = QueryClientConfig.class) +@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS) +public class QueryTests extends ForkingClientServerIntegrationTestsSupport { + + @Autowired + private ContinuousQueryListenerContainer container; + + @Autowired + private CustomerRepository customerRepository; + + @Autowired + private GemfireTemplate customerTemplate; + + @Resource(name = "Customers") + private Region customers; + + @Autowired + private LuceneTemplate luceneTemplate; + + private AtomicInteger counter = new AtomicInteger(0); + + private Logger logger = LoggerFactory.getLogger(this.getClass()); + + @BeforeClass + public static void setup() throws IOException { + startGemFireServer(QueryServer.class); + } + + @Test + public void luceneIsConfiguredCorrectly() { + + customerRepository.save(new Customer(1L, new EmailAddress("name@internet.com"), "Stephanie", "Demarco")); + customerRepository.save(new Customer(2L, new EmailAddress("cool_Guy57@mail.com"), "Patrick", "Dunham")); + customerRepository.save(new Customer(3L, new EmailAddress("scientist@mail.com"), "Jasmine", "Oliander")); + customerRepository.save(new Customer(4L, new EmailAddress("catlover42@mail.com"), "Erica", "Shu")); + customerRepository.save(new Customer(5L, new EmailAddress("zolander@mail.com"), "Tom", "Darude")); + + List> lastName = luceneTemplate.query("D*", "lastName", 10); + + assertThat(lastName.size()).isEqualTo(3); + logger.info("Customers with last names beginning with 'D':"); + lastName.forEach(result -> logger.info(result.getValue().toString())); + } + + @Test + public void oqlQueriesConfiguredCorrectly() { + + logger.info("Inserting 3 entries for keys: 1, 2, 3"); + Customer john = new Customer(1L, new EmailAddress("2@2.com"), "John", "Smith"); + Customer frank = new Customer(2L, new EmailAddress("3@3.com"), "Frank", "Lamport"); + Customer jude = new Customer(3L, new EmailAddress("5@5.com"), "Jude", "Simmons"); + customerRepository.save(john); + customerRepository.save(frank); + customerRepository.save(jude); + assertThat(customers.keySetOnServer().size()).isEqualTo(3); + + Customer customer = customerRepository.findById(2L).get(); + assertThat(customer).isEqualTo(frank); + logger.info("Find customer with key=2 using GemFireRepository: " + customer); + List customerList = customerTemplate.find("select * from /Customers where id=$1", 2L).asList(); + assertThat(customerList.size()).isEqualTo(1); + assertThat(customerList.contains(frank)).isTrue(); + logger.info("Find customer with key=2 using GemFireTemplate: " + customerList); + + customer = new Customer(1L, new EmailAddress("3@3.com"), "Jude", "Smith"); + customerRepository.save(customer); + assertThat(customers.keySetOnServer().size()).isEqualTo(3); + + customerList = customerRepository.findByEmailAddressUsingIndex("3@3.com"); + assertThat(customerList.size()).isEqualTo(2); + assertThat(customerList.contains(frank)).isTrue(); + assertThat(customerList.contains(customer)).isTrue(); + logger.info("Find customers with emailAddress=3@3.com: " + customerList); + + customerList = customerRepository.findByFirstNameUsingIndex("Frank"); + assertThat(customerList.get(0)).isEqualTo(frank); + logger.info("Find customers with firstName=Frank: " + customerList); + customerList = customerRepository.findByFirstNameUsingIndex("Jude"); + assertThat(customerList.size()).isEqualTo(2); + assertThat(customerList.contains(jude)).isTrue(); + assertThat(customerList.contains(customer)).isTrue(); + logger.info("Find customers with firstName=Jude: " + customerList); + } + + @Test + public void continuousQueryWorkingCorrectly() { + assertThat(this.customers).isEmpty(); + logger.info("Inserting 3 entries for keys: 1, 2, 3"); + customerRepository.save(new Customer(1L, new EmailAddress("2@2.com"), "John", "Smith")); + customerRepository.save(new Customer(2L, new EmailAddress("3@3.com"), "Frank", "Lamport")); + customerRepository.save(new Customer(3L, new EmailAddress("5@5.com"), "Jude", "Simmons")); + assertThat(customers.keySetOnServer().size()).isEqualTo(3); + + Awaitility.await().atMost(30, TimeUnit.SECONDS).until(() -> this.counter.get() == 3); + } + + @ContinuousQuery(name = "CustomerCQ", query = "SELECT * FROM /Customers") + public void handleEvent(CqEvent event) { + logger.info("Received message for CQ 'CustomerCQ'" + event); + counter.incrementAndGet(); + } + + @After + public void cleanup() { + customerRepository.deleteAll(customerRepository.findAll()); + container.getQueryService().closeCqs(); + } +} \ No newline at end of file diff --git a/geode/queries/src/test/resources/logback.xml b/geode/queries/src/test/resources/logback.xml new file mode 100644 index 00000000..f3b82068 --- /dev/null +++ b/geode/queries/src/test/resources/logback.xml @@ -0,0 +1,11 @@ + + + + %msg%n + + + + + + + \ No newline at end of file diff --git a/geode/security/README.md b/geode/security/README.md new file mode 100755 index 00000000..af8732ed --- /dev/null +++ b/geode/security/README.md @@ -0,0 +1,15 @@ +# Security Example + +In this example a [Pivotal GemFire](https://pivotal.io/pivotal-gemfire) / [Apache Geode](http://geode.apache.org/) client and server will set up with security (username/password) authentication using Geode Security and Apache Shiro. + +To run the example simply run the tests located under security/src/test in your IDE. There are two test files; one uses Geode Security and the other uses Apache Shiro. Both versions should behave the same. + +The client is configured to connect to the server on `localhost` port `40404`. There is no need to start the server separately, as that is taken care of by the test. + +## Running the example + +The example is broken up into multiple steps: +1. Insert (Put) three Customer entries into the `Customers` region using the repositories `save` method. +2. Print the customers on the server. + +NOTE: Inorder to see output, you must change the loglevel from "error" to "info" in the `logback.xml` file located under src/test/resources. \ No newline at end of file diff --git a/geode/security/pom.xml b/geode/security/pom.xml new file mode 100755 index 00000000..c5663e94 --- /dev/null +++ b/geode/security/pom.xml @@ -0,0 +1,42 @@ + + + + example.springdata.geode + spring-data-geode-examples + 1.0-SNAPSHOT + + + 4.0.0 + security + + + + org.springframework + spring-jdbc + 5.2.3.RELEASE + + + org.springframework.data + spring-data-jpa + 2.2.4.RELEASE + + + org.codeprimate + cp-elements + 1.0.0.M5 + + + org.hsqldb + hsqldb + 2.4.1 + + + javax.persistence + javax.persistence-api + 2.2 + + + + \ No newline at end of file diff --git a/geode/security/src/main/java/example/springdata/geode/client/security/Constants.java b/geode/security/src/main/java/example/springdata/geode/client/security/Constants.java new file mode 100755 index 00000000..de045712 --- /dev/null +++ b/geode/security/src/main/java/example/springdata/geode/client/security/Constants.java @@ -0,0 +1,30 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.security; + +/** + * The [Constants] class contains properties and other constants used in the Apache Geode Integrated Security + * framework. + * + * @author John Blum + * @since 1.0.0 + */ +public class Constants { + + public static final String SECURITY_PASSWORD_PROPERTY = "security-password"; + public static final String SECURITY_USERNAME_PROPERTY = "security-username"; +} diff --git a/geode/security/src/main/java/example/springdata/geode/client/security/Customer.java b/geode/security/src/main/java/example/springdata/geode/client/security/Customer.java new file mode 100755 index 00000000..39dd25e2 --- /dev/null +++ b/geode/security/src/main/java/example/springdata/geode/client/security/Customer.java @@ -0,0 +1,47 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.security; + +import lombok.Data; +import org.springframework.data.annotation.Id; +import org.springframework.data.gemfire.mapping.annotation.Region; + +import java.io.Serializable; + +/** + * A customer used for Lucene examples. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +@Region(name = "Customers") +public class Customer implements Serializable { + + @Id + private Long id; + private EmailAddress emailAddress; + private String firstName; + private String lastName; + + public Customer(Long id, EmailAddress emailAddress, String firstName, String lastName) { + this.id = id; + this.emailAddress = emailAddress; + this.firstName = firstName; + this.lastName = lastName; + } +} \ No newline at end of file diff --git a/geode/security/src/main/java/example/springdata/geode/client/security/EmailAddress.java b/geode/security/src/main/java/example/springdata/geode/client/security/EmailAddress.java new file mode 100755 index 00000000..bc222121 --- /dev/null +++ b/geode/security/src/main/java/example/springdata/geode/client/security/EmailAddress.java @@ -0,0 +1,37 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.security; + +import lombok.Data; + +import java.io.Serializable; + +/** + * Value object to represent email addresses. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +public class EmailAddress implements Serializable { + private String value; + + public EmailAddress(String value) { + + this.value = value; + } +} \ No newline at end of file diff --git a/geode/security/src/main/java/example/springdata/geode/client/security/Role.java b/geode/security/src/main/java/example/springdata/geode/client/security/Role.java new file mode 100755 index 00000000..dd9fc6be --- /dev/null +++ b/geode/security/src/main/java/example/springdata/geode/client/security/Role.java @@ -0,0 +1,122 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.security; + +import lombok.Data; +import org.apache.geode.security.ResourcePermission; +import org.cp.elements.lang.Identifiable; + +import java.io.Serializable; +import java.util.Arrays; +import java.util.Collection; +import java.util.HashSet; +import java.util.Iterator; + +/** + * The [Role] class is an Abstract Data Type (ADT) modeling a role of a user (e.g. Admin). + * + * @author John Blum + * @see Serializable + * @see Comparable + * @see Iterable + * @see ResourcePermission + * @see org.cp.elements.lang.Identifiable + * @since 1.0.0 + */ +@Data +public class Role implements Comparable, Identifiable, Iterable, Serializable { + + private String name; + private HashSet permissions = new HashSet<>(); + + public Role(String name) { + this.name = name; + } + + @Override + public String getId() { + return name; + } + + @Override + public void setId(String id) { + throw new UnsupportedOperationException("Operation Not Supported"); + } + + /** + * @inheritDoc + */ + @Override + public int compareTo(Role other) { + return name.compareTo(other.name); + } + + /** + * Determines whether this [Role] has been assigned (granted) the given [permission][ResourcePermission]. + * + * @param permission [ResourcePermission] to evaluate. + * @return a boolean value indicating whether this [Role] has been assigned (granted) + * the given [permission][ResourcePermission]. + * @see ResourcePermission + */ + public boolean hasPermission(ResourcePermission permission) { + return this.permissions.contains(permission); + } + + /** + * @inheritDoc + */ + @Override + public Iterator iterator() { + return this.permissions.iterator(); + } + + /** + * Adds (assigns/grants) all given [persmissions][ResourcePermission] to this [Role]. + * + * @param permissions [ResourcePermission]s to assign/grant to this [Role]. + * @return this [Role]. + * @see ResourcePermission + */ + public Role withPermissions(ResourcePermission... permissions) { + this.permissions.addAll((Arrays.asList(permissions))); + return this; + } + + /** + * Adds (assigns/grants) all given [persmissions][ResourcePermission] to this [Role]. + * + * @param permissions [ResourcePermission]s to assign/grant to this [Role]. + * @return this [Role]. + * @see ResourcePermission + */ + public Role withPersmissions(Iterable permissions) { + this.permissions.addAll((Collection) permissions); + return this; + } + + /** + * Factory method used to construct a new instance of [Role] initialized with the given name. + * + * @param name [String] indicating the name of the new [Role]. + * @return a new [Role] initialized with the given name. + * @see Role + */ + public static Role newRole(String name) { + return new Role(name); + } +} diff --git a/geode/security/src/main/java/example/springdata/geode/client/security/User.java b/geode/security/src/main/java/example/springdata/geode/client/security/User.java new file mode 100755 index 00000000..b72d8f0f --- /dev/null +++ b/geode/security/src/main/java/example/springdata/geode/client/security/User.java @@ -0,0 +1,144 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.security; + +import lombok.Data; +import org.apache.geode.security.ResourcePermission; +import org.cp.elements.lang.Identifiable; + +import java.io.Serializable; +import java.security.Principal; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Iterator; +import java.util.List; + +@Data +public class User implements Comparable, Cloneable, Principal, Serializable, Iterable, Identifiable { + + private String name; + private List roles; + + private String credentials = null; + + public User(String name, List roles) { + this.name = name; + this.roles = roles; + } + + public User(String name) { + this(name, new ArrayList()); + } + + @Override + public void setId(String id) { + throw new UnsupportedOperationException("Operation Not Supported"); + } + + @Override + public String getId() { + return name; + } + + @Override + public Iterator iterator() { + return roles.iterator(); + } + + /** + * @inheritDoc + */ + @Override + public Object clone() { + return newUser(name).withCredentials(credentials).withRoles(roles); + } + + /** + * @inheritDoc + */ + @Override + public int compareTo(User other) { + return this.getName().compareTo(other.getName()); + } + + /** + * Determines whether this [User] has been granted (assigned) the given [permission][ResourcePermission]. + * + * @param permission [ResourcePermission] to evalute. + * @return a boolean value indicating whether this [User] has been granted (assigned) + * the given [ResourcePermission]. + * @see ResourcePermission + */ + public boolean hasPermission(ResourcePermission permission) { + for (Role role : roles) { + if (role.hasPermission(permission)) { + return true; + } + } + return false; + } + + /** + * Determines whether this [User] has the specified [Role]. + * + * @param role [Role] to evaluate. + * @return a boolean value indicating whether this [User] has the specified [Role]. + * @see Role + */ + public boolean hasRole(Role role) { + return roles.contains(role); + } + + /** + * Adds the array of [Roles][Role] granting (resource) permissions to this [User]. + * + * @param roles array of [Roles][Role] granting (resource) permissions to this [User]. + * @return this [User]. + * @see Role + */ + public User withRoles(Role... roles) { + this.roles.addAll(Arrays.asList(roles)); + return this; + } + + public User withRoles(Collection roles) { + this.roles.addAll(roles); + return this; + } + + /** + * Sets this [User's][User] credentials (e.g. password) to the given value. + * + * @param credentials [String] containing this [User's][User] credentials (e.g. password). + * @return this [User]. + * @see User + */ + public User withCredentials(String credentials) { + this.credentials = credentials; + return this; + } + + public static User newUser(String name) { + return new User(name); + } + + @Override + public String getName() { + return name; + } +} diff --git a/geode/security/src/main/java/example/springdata/geode/client/security/client/CustomerRepository.java b/geode/security/src/main/java/example/springdata/geode/client/security/client/CustomerRepository.java new file mode 100755 index 00000000..dacd8e9d --- /dev/null +++ b/geode/security/src/main/java/example/springdata/geode/client/security/client/CustomerRepository.java @@ -0,0 +1,26 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.security.client; + +import example.springdata.geode.client.security.Customer; +import org.springframework.data.repository.CrudRepository; + +import java.util.List; + +public interface CustomerRepository extends CrudRepository { + List findAll(); +} diff --git a/geode/security/src/main/java/example/springdata/geode/client/security/client/SecurityEnabledClientConfiguration.java b/geode/security/src/main/java/example/springdata/geode/client/security/client/SecurityEnabledClientConfiguration.java new file mode 100755 index 00000000..88754f38 --- /dev/null +++ b/geode/security/src/main/java/example/springdata/geode/client/security/client/SecurityEnabledClientConfiguration.java @@ -0,0 +1,33 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.security.client; + +import example.springdata.geode.client.security.Customer; +import org.apache.geode.cache.client.ClientRegionShortcut; +import org.springframework.context.annotation.Configuration; +import org.springframework.data.gemfire.config.annotation.ClientCacheApplication; +import org.springframework.data.gemfire.config.annotation.EnableEntityDefinedRegions; +import org.springframework.data.gemfire.config.annotation.EnableSecurity; +import org.springframework.data.gemfire.repository.config.EnableGemfireRepositories; + +@Configuration +@EnableSecurity +@EnableGemfireRepositories(basePackageClasses = CustomerRepository.class) +@ClientCacheApplication(name = "SecurityClient", logLevel = "error", pingInterval = 5000L, readTimeout = 15000, retryAttempts = 1) +@EnableEntityDefinedRegions(basePackageClasses = Customer.class, clientRegionShortcut = ClientRegionShortcut.CACHING_PROXY) +public class SecurityEnabledClientConfiguration { +} \ No newline at end of file diff --git a/geode/security/src/main/java/example/springdata/geode/client/security/server/ApacheShiroIniConfiguration.java b/geode/security/src/main/java/example/springdata/geode/client/security/server/ApacheShiroIniConfiguration.java new file mode 100644 index 00000000..fd9f187d --- /dev/null +++ b/geode/security/src/main/java/example/springdata/geode/client/security/server/ApacheShiroIniConfiguration.java @@ -0,0 +1,11 @@ +package example.springdata.geode.client.security.server; + +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Profile; +import org.springframework.data.gemfire.config.annotation.EnableSecurity; + +@Configuration +@EnableSecurity(shiroIniResourcePath = "shiro.ini") +@Profile("shiro-ini-configuration") +public class ApacheShiroIniConfiguration { +} diff --git a/geode/security/src/main/java/example/springdata/geode/client/security/server/CachingSecurityRepository.java b/geode/security/src/main/java/example/springdata/geode/client/security/server/CachingSecurityRepository.java new file mode 100755 index 00000000..94ac8202 --- /dev/null +++ b/geode/security/src/main/java/example/springdata/geode/client/security/server/CachingSecurityRepository.java @@ -0,0 +1,54 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.security.server; + +import example.springdata.geode.client.security.User; + +import java.util.HashMap; +import java.util.Map; + +/** + * The [CachingSecurityRepository] class caches Security Configuration Meta-Data and is meant to be extended + * by classes that are data store specified (e.g. JDBC/RDBMS, LDAP, etc). + * + * @author John Blum + * @see User + * @see SecurityRepository + * @since 1.0.0 + */ +public abstract class CachingSecurityRepository implements SecurityRepository { + private Map users = new HashMap<>(); + + @Override + public Iterable findAll() { + return users.values(); + } + + @Override + public boolean delete(User user) { + if (user != null) { + return users.remove(user.getName()) != null; + } + return false; + } + + @Override + public User save(User user) { + User putUser = users.put(user.getName(), user); + return putUser != null ? putUser : user; + } +} diff --git a/geode/security/src/main/java/example/springdata/geode/client/security/server/GeodeIntegratedSecurityProxyConfiguration.java b/geode/security/src/main/java/example/springdata/geode/client/security/server/GeodeIntegratedSecurityProxyConfiguration.java new file mode 100644 index 00000000..05faf3b7 --- /dev/null +++ b/geode/security/src/main/java/example/springdata/geode/client/security/server/GeodeIntegratedSecurityProxyConfiguration.java @@ -0,0 +1,13 @@ +package example.springdata.geode.client.security.server; + +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Profile; +import org.springframework.data.gemfire.config.annotation.EnableSecurity; + + +@Configuration +@EnableSecurity(securityManagerClassName = "example.springdata.geode.client.security.server.SecurityManagerProxy") +@Profile({"default", "geode-security-manager-proxy-configuration"}) +public class GeodeIntegratedSecurityProxyConfiguration { + +} diff --git a/geode/security/src/main/java/example/springdata/geode/client/security/server/JdbcSecurityRepository.java b/geode/security/src/main/java/example/springdata/geode/client/security/server/JdbcSecurityRepository.java new file mode 100644 index 00000000..b8608524 --- /dev/null +++ b/geode/security/src/main/java/example/springdata/geode/client/security/server/JdbcSecurityRepository.java @@ -0,0 +1,87 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.security.server; + +import example.springdata.geode.client.security.Role; +import example.springdata.geode.client.security.User; +import org.apache.geode.security.ResourcePermission; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.InitializingBean; +import org.springframework.jdbc.core.JdbcTemplate; +import org.springframework.jdbc.core.RowMapper; +import org.springframework.stereotype.Repository; + +import java.util.Collections; +import java.util.HashMap; +import java.util.List; + +@Repository +public class JdbcSecurityRepository extends CachingSecurityRepository implements InitializingBean { + + private Logger logger = LoggerFactory.getLogger(this.getClass()); + + private final JdbcTemplate jdbcTemplate; + private static final String ROLES_QUERY = "SELECT name FROM geode_security.roles"; + private static final String ROLE_PERMISSIONS_QUERY = "" + + " SELECT rolePerms.resource, rolePerms.operation, rolePerms.region_name, rolePerms.key_name" + + " FROM geode_security.roles_permissions rolePerms" + + " INNER JOIN geode_security.roles roles ON roles.id = rolePerms.role_id " + + " WHERE roles.name = ?"; + private static final String USERS_QUERY = "SELECT name, credentials FROM geode_security.users"; + private static final String USER_ROLES_QUERY = "" + + " SELECT roles.name" + + " FROM geode_security.roles roles" + + " INNER JOIN geode_security.users_roles userRoles ON roles.id = userRoles.role_id" + + " INNER JOIN geode_security.users users ON userRoles.user_id = users.id" + + " WHERE users.name = ?"; + + public JdbcSecurityRepository(JdbcTemplate jdbcTemplate) { + this.jdbcTemplate = jdbcTemplate; + } + + public void afterPropertiesSet() { + + List roles = this.jdbcTemplate.query(ROLES_QUERY, (resultSet, i) -> Role.newRole(resultSet.getString(1))); + HashMap roleMapping = new HashMap<>(roles.size()); + + roles.forEach((role) -> { + this.jdbcTemplate.query(ROLE_PERMISSIONS_QUERY, Collections.singleton(role.getName()).toArray(), + (RowMapper) (resultSet, i) -> role.withPermissions(newResourcePermission( + resultSet.getString(1), resultSet.getString(2), + resultSet.getString(3), resultSet.getString(4)))); + + roleMapping.put(role.getName(), role); + }); + + List users = this.jdbcTemplate.query(USERS_QUERY, (resultSet, i) -> + createUser(resultSet.getString(1)).withCredentials(resultSet.getString(2))); + + users.forEach((role) -> { + this.jdbcTemplate.query(USER_ROLES_QUERY, Collections.singleton(role.getName()).toArray(), + (RowMapper) (resultSet, i) -> role.withRoles(roleMapping.get(resultSet.getString(1)))); + + save(role); + }); + + logger.debug("Users {}", users); + } + + protected ResourcePermission newResourcePermission(String resource, String operation, String region, String key) { + return new ResourcePermission(resource, operation, region, key); + } +} diff --git a/geode/security/src/main/java/example/springdata/geode/client/security/server/SecurityEnabledServer.java b/geode/security/src/main/java/example/springdata/geode/client/security/server/SecurityEnabledServer.java new file mode 100755 index 00000000..d3d5f6ef --- /dev/null +++ b/geode/security/src/main/java/example/springdata/geode/client/security/server/SecurityEnabledServer.java @@ -0,0 +1,31 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.security.server; + +import org.springframework.boot.WebApplicationType; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.boot.builder.SpringApplicationBuilder; + +@SpringBootApplication(scanBasePackageClasses = SecurityEnabledServerConfiguration.class) +public class SecurityEnabledServer { + public static void main(String[] args) { + new SpringApplicationBuilder(SecurityEnabledServer.class) + .web(WebApplicationType.NONE) + .build() + .run(args); + } +} \ No newline at end of file diff --git a/geode/security/src/main/java/example/springdata/geode/client/security/server/SecurityEnabledServerConfiguration.java b/geode/security/src/main/java/example/springdata/geode/client/security/server/SecurityEnabledServerConfiguration.java new file mode 100755 index 00000000..3bc188d2 --- /dev/null +++ b/geode/security/src/main/java/example/springdata/geode/client/security/server/SecurityEnabledServerConfiguration.java @@ -0,0 +1,60 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.security.server; + +import example.springdata.geode.client.security.Customer; +import org.apache.geode.cache.RegionShortcut; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Import; +import org.springframework.data.gemfire.config.annotation.CacheServerApplication; +import org.springframework.data.gemfire.config.annotation.EnableEntityDefinedRegions; +import org.springframework.data.gemfire.config.annotation.EnableIndexing; +import org.springframework.data.gemfire.config.annotation.EnableLocator; +import org.springframework.data.gemfire.config.annotation.EnableManager; +import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder; +import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType; + +import javax.sql.DataSource; + +@Configuration +@EnableLocator +@EnableIndexing +@EnableManager +@Import({ApacheShiroIniConfiguration.class, GeodeIntegratedSecurityProxyConfiguration.class}) +@CacheServerApplication(port = 0, logLevel = "error") +@EnableEntityDefinedRegions(basePackageClasses = Customer.class, serverRegionShortcut = RegionShortcut.REPLICATE) +public class SecurityEnabledServerConfiguration { + + @Bean + DataSource hsqlDataSource() { + return new EmbeddedDatabaseBuilder() + .setName("geode_security") + .setScriptEncoding("UTF-8") + .setType(EmbeddedDatabaseType.HSQL) + .addScript("sql/geode-security-schema-ddl.sql") + .addScript("sql/define-roles-table-ddl.sql") + .addScript("sql/define-roles-permissions-table-ddl.sql") + .addScript("sql/define-users-table-ddl.sql") + .addScript("sql/define-users-roles-table-ddl.sql") + .addScript("sql/insert-roles-dml.sql") + .addScript("sql/insert-roles-permissions-dml.sql") + .addScript("sql/insert-users-dml.sql") + .addScript("sql/insert-users-roles-dml.sql") + .build(); + } +} diff --git a/geode/security/src/main/java/example/springdata/geode/client/security/server/SecurityManagerProxy.java b/geode/security/src/main/java/example/springdata/geode/client/security/server/SecurityManagerProxy.java new file mode 100644 index 00000000..69fa1d97 --- /dev/null +++ b/geode/security/src/main/java/example/springdata/geode/client/security/server/SecurityManagerProxy.java @@ -0,0 +1,112 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.security.server; + +import org.apache.geode.security.AuthenticationFailedException; +import org.apache.geode.security.ResourcePermission; +import org.cp.elements.lang.Assert; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.data.gemfire.support.LazyWiringDeclarableSupport; + +import java.util.Properties; + +/** + * The {@link SecurityManagerProxy} class is a Proxy delegating to an underlying Apache Geode + * {@link org.apache.geode.security.SecurityManager} implementation, that maybe a Spring managed bean + * in a Spring context that may have been configured and auto-wired the Spring container, or possibly + * other managed environment (Cloud or Java EE Server, etc). + * + * @author John Blum + * @see org.apache.geode.security.SecurityManager + * @see org.springframework.data.gemfire.support.LazyWiringDeclarableSupport + * @since 1.0.0 + */ +@SuppressWarnings("unused") +public class SecurityManagerProxy extends LazyWiringDeclarableSupport + implements org.apache.geode.security.SecurityManager { + + private org.apache.geode.security.SecurityManager securityManager; + + /** + * Constructs an instance of the {@link SecurityManagerProxy}, whick will delegate all Apache Geode + * security operations to a Spring managed {@link org.apache.geode.security.SecurityManager} bean. + */ + public SecurityManagerProxy() { + // TODO remove init() call when GEODE-2083 (https://issues.apache.org/jira/browse/GEODE-2083) is resolved! + // NOTE the init(:Properties) call in the constructor is less than ideal since... + // 1) it allows the *this* reference to escape, and... + // 2) it is Geode's responsibility to identify Geode Declarable objects and invoke their init(:Properties) method + // However, the init(:Properties) method invocation in the constructor is necessary to enable this Proxy to be + // identified and auto-wired in a Spring context. + init(new Properties()); + } + + /** + * Returns a reference to the Apache Geode {@link org.apache.geode.security.SecurityManager} instance + * delegated to by this {@link SecurityManagerProxy}. + * + * @return a reference to the underlying, Apache Geode {@link org.apache.geode.security.SecurityManager} + * instance delegated to by this {@link SecurityManagerProxy}. + * @throws IllegalStateException if the configured Apache Geode {@link org.apache.geode.security.SecurityManager} + * was not properly initialized. + * @see org.apache.geode.security.SecurityManager + */ + protected org.apache.geode.security.SecurityManager getSecurityManager() { + Assert.state(this.securityManager != null, "SecurityManager was not properly initialized"); + return this.securityManager; + } + + /** + * Sets a reference to the Apache Geode {@link org.apache.geode.security.SecurityManager} instance + * delegated to by this {@link SecurityManagerProxy}. + * + * @param securityManager reference to the underlying, Apache Geode {@link org.apache.geode.security.SecurityManager} + * instance delegated to by this {@link SecurityManagerProxy}. + * @throws IllegalArgumentException if the Apache Geode {@link org.apache.geode.security.SecurityManager} reference + * is {@literal null}. + * @see org.apache.geode.security.SecurityManager + */ + @Autowired + public void setSecurityManager(org.apache.geode.security.SecurityManager securityManager) { + Assert.notNull(securityManager, "SecurityManager must not be null"); + this.securityManager = securityManager; + } + + /** + * @inheritDoc + */ + @Override + public Object authenticate(Properties properties) throws AuthenticationFailedException { + return getSecurityManager().authenticate(properties); + } + + /** + * @inheritDoc + */ + @Override + public boolean authorize(Object principal, ResourcePermission permission) { + return getSecurityManager().authorize(principal, permission); + } + + /** + * @inheritDoc + */ + @Override + public void close() { + getSecurityManager().close(); + } +} diff --git a/geode/security/src/main/java/example/springdata/geode/client/security/server/SecurityManagerSupport.java b/geode/security/src/main/java/example/springdata/geode/client/security/server/SecurityManagerSupport.java new file mode 100755 index 00000000..5b0645d7 --- /dev/null +++ b/geode/security/src/main/java/example/springdata/geode/client/security/server/SecurityManagerSupport.java @@ -0,0 +1,107 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.security.server; + +import example.springdata.geode.client.security.Constants; +import org.apache.geode.security.ResourcePermission; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.security.Principal; +import java.util.Properties; + +/** + * The [SecurityManagerSupport] class is an Apache Geode [SecurityManager] interface adapter providing + * default implementations of the [SecurityManager] interface operations. + * + * @author John Blum + * @see Principal + * @see ResourcePermission + * @see org.apache.geode.security.SecurityManager + * @since 1.0.0 + */ +public abstract class SecurityManagerSupport implements org.apache.geode.security.SecurityManager { + + protected Logger logger = LoggerFactory.getLogger(this.getClass()); + + /* (non-Javadoc)*/ + protected String getName(Object principal) { + if (principal instanceof Principal) { + return ((Principal) principal).getName(); + } else { + return principal.toString(); + } + } + + /* (non-Javadoc)*/ + protected String getPassword(Properties securityProperties) { + return getPropertyValue(securityProperties, Constants.SECURITY_PASSWORD_PROPERTY); + } + + /* (non-Javadoc)*/ + protected String getUsername(Properties securityProperties) { + return getPropertyValue(securityProperties, Constants.SECURITY_USERNAME_PROPERTY); + } + + /* (non-Javadoc)*/ + protected String getPropertyValue(Properties properties, String propertyName) { + return properties.getProperty(propertyName); + } + + /* (non-Javadoc)*/ + protected void logDebug(String message, Object... args) { + if (logger.isDebugEnabled()) { + logger.debug(message, args); + } + } + + /** + * @inheritDoc + */ + @Override + public void init(Properties securityProperties) { + if (logger.isDebugEnabled()) { + logger.debug("Security Properties [{}]", securityProperties); + } + } + + /** + * @inheritDoc + */ + @Override + public Object authenticate(Properties securityProperties) { + return null; + } + + /** + * @inheritDoc + */ + @Override + public boolean authorize(Object principal, ResourcePermission permission) { + return principal != null; + } + + /** + * @inheritDoc + */ + @Override + public void close() { + if (logger.isDebugEnabled()) { + logger.debug("Closing SecurityManager [{}]", this.getClass().getName()); + } + } +} diff --git a/geode/security/src/main/java/example/springdata/geode/client/security/server/SecurityRepository.java b/geode/security/src/main/java/example/springdata/geode/client/security/server/SecurityRepository.java new file mode 100755 index 00000000..9a4ac2a0 --- /dev/null +++ b/geode/security/src/main/java/example/springdata/geode/client/security/server/SecurityRepository.java @@ -0,0 +1,157 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.security.server; + +import example.springdata.geode.client.security.Role; +import example.springdata.geode.client.security.User; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +/** + * The [SecurityRepository] interface is a contract for Data Access Objects (DAO) implementing this interface + * to perform CRUD and query operations on [User] information, pertinent to the security of the system. + * + * @author John Blum + * @author Udo Kohlmeyer + * @see Role + * @see User + * @see org.springframework.stereotype.Repository + * @since 1.0.0 + */ +public interface SecurityRepository { + /** + * Finds all [Users][User] of the system. + * + * @return an [Iterable] of [Users][User] of the system. + * @see User + * @see Iterable + */ + Iterable findAll(); + + /** + * Deletes the given [User] from the system. + * + * @param user [User] to delete. + * @return a boolean value indicating if the [User] was deleted successfully. + * @see User + */ + boolean delete(User user); + + /** + * Records (persist) the information (state) of the [User]. + * + * @param user [User] to store. + * @return the [User]. + * @see User + */ + User save(User user); + + /* (non-Javadoc) */ + default int count() { + int count = 0; + Iterable users = findAll(); + for (User user : users) { + count++; + } + return count; + } + + /* (non-Javadoc) */ + default User createUser(String username, Role... roles) { + return save(User.newUser(username).withRoles(roles)); + } + + /* (non-Javadoc) */ + default boolean delete(String username) { + User user = findBy(username); + if (user != null) { + return delete(user); + } + return false; + } + + /* (non-Javadoc) */ + default boolean deleteAll(String... username) { + return deleteAll(findAll(username)); + } + + /* (non-Javadoc) */ + default boolean deleteAll(User... users) { + return deleteAll(Arrays.asList(users)); + } + + /* (non-Javadoc) */ + default boolean deleteAll(Iterable users) { + for (User user : users) { + if (!delete(user)) { + return false; + } + } + return true; + } + + /* (non-Javadoc) */ + default boolean deleteAll() { + return deleteAll(findAll()); + } + + /* (non-Javadoc) */ + default boolean exists(String username) { + return findBy(username) != null; + } + + /* (non-Javadoc) */ + default Iterable findAll(String... username) { + return findAll(Arrays.asList(username)); + } + + /* (non-Javadoc) */ + default Iterable findAll(Iterable username) { + List all = new ArrayList<>(); + username.forEach(u -> { + if (u != null) { + all.add(findBy(u)); + } + }); + return all; + } + + /* (non-Javadoc) */ + default User findBy(String username) { + for (User user : findAll()) { + if (user.getName().equals(username)) { + return user; + } + } + return null; + } + + /* (non-Javadoc) */ + default Iterable saveAll(User... users) { + return saveAll(Arrays.asList(users)); + } + + /* (non-Javadoc) */ + default Iterable saveAll(Iterable users) { + List saved = new ArrayList<>(); + users.forEach(user -> saved.add(save(user))); + return saved; + } +} + diff --git a/geode/security/src/main/java/example/springdata/geode/client/security/server/SimpleSecurityManager.java b/geode/security/src/main/java/example/springdata/geode/client/security/server/SimpleSecurityManager.java new file mode 100644 index 00000000..a0280947 --- /dev/null +++ b/geode/security/src/main/java/example/springdata/geode/client/security/server/SimpleSecurityManager.java @@ -0,0 +1,126 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.security.server; + +import example.springdata.geode.client.security.Role; +import example.springdata.geode.client.security.User; +import org.apache.geode.security.AuthenticationFailedException; +import org.apache.geode.security.ResourcePermission; +import org.springframework.stereotype.Service; + +import java.util.Properties; + +/** + * The [SimpleSecurityManager] class is an example Apache Geode [SecurityManager] provider implementation + * used to secure Apache Geode. + * + * @author John Blum + * @see SecurityManagerSupport + * @see Role + * @see User + * @see SecurityRepository + * @see ResourcePermission + * @see org.apache.geode.security.SecurityManager + * @see org.springframework.stereotype.Service + * @since 1.0.0 + */ +@Service +public class SimpleSecurityManager extends SecurityManagerSupport { + + protected SecurityRepository securityRepository; + + public SimpleSecurityManager(SecurityRepository securityRepository) { + this.securityRepository = securityRepository; + } + + /** + * @inheritDoc + */ + @Override + public Object authenticate(Properties securityProperties) { + String username = getUsername(securityProperties); + String password = getPassword(securityProperties); + + logDebug("User with name [{}] is attempting to login with password [{}]", username, password); + + User user = securityRepository.findBy(username); + + if (isNotAuthentic(user, password)) { + throw new AuthenticationFailedException(String.format("Failed to authenticate user [%s]", username)); + } + + return user; + } + + /* (non-Javadoc) */ + protected boolean isAuthentic(User user, String credentials) { + return user != null && user.getCredentials().equals(credentials); + } + + /* (non-Javadoc) */ + protected boolean isNotAuthentic(User user, String credentials) { + return !isAuthentic(user, credentials); + } + + /** + * @inheritDoc + */ + @Override + public boolean authorize(Object principal, ResourcePermission permission) { + logDebug("Principal [{}] is requesting access to a Resource {} with the required Permission [{}]", + principal, permission.getResource(), permission); + + return isAuthorized(principal, permission); + } + + /* (non-Javadoc) */ + protected boolean isAuthorized(Object principal, ResourcePermission permission) { + User user = resolveUser(principal); + + return user != null && isAuthorized(user, permission); + } + + /* (non-Javadoc) */ + protected User resolveUser(Object principal) { + if (principal instanceof User) { + return (User) principal; + } else { + return securityRepository.findBy(getName(principal)); + } + } + + /* (non-Javadoc) */ + protected boolean isAuthorized(User user, ResourcePermission requiredPermission) { + if (!user.hasPermission(requiredPermission)) { + for (Role role : user.getRoles()) { + for (ResourcePermission userPermission : role.getPermissions()) { + if (isPermitted(userPermission, requiredPermission)) { + return true; + } + } + } + return false; + } + return true; + } + + /* (non-Javadoc) */ + protected boolean isPermitted(ResourcePermission userPermission, ResourcePermission resourcePermission) { + return userPermission.implies(resourcePermission); + } + +} diff --git a/geode/security/src/main/resources/application.properties b/geode/security/src/main/resources/application.properties new file mode 100755 index 00000000..c2759850 --- /dev/null +++ b/geode/security/src/main/resources/application.properties @@ -0,0 +1,2 @@ +spring.data.gemfire.security.username=scientist +spring.data.gemfire.security.password=w0rk!ng4u \ No newline at end of file diff --git a/geode/security/src/main/resources/shiro.ini b/geode/security/src/main/resources/shiro.ini new file mode 100755 index 00000000..2cd25350 --- /dev/null +++ b/geode/security/src/main/resources/shiro.ini @@ -0,0 +1,42 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You 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. + +# Shiro INI configuration + +# Objects and their properties are defined here, such as the securityManager, Realms and anything else needed +# to build the SecurityManager +[main] + +# The 'users' section is for simple deployments when you only need a small number of statically-defined +# set of User accounts. +# username = password, roleName1, roleName2, …, roleNameN +[users] +root = s3cr3t!, ADMIN, DBA +scientist = w0rk!ng4u, DATA_SCIENTIST +analyst = p@55w0rd, DATA_ANALYST +guest = guest, GUEST + +# The 'roles' section is for simple deployments when you only need a small number of statically-defined roles. +# rolename = permissionDefinition1, permissionDefinition2, …, permissionDefinitionN +[roles] +ADMIN = CLUSTER:MANAGE, CLUSTER:READ, CLUSTER:WRITE +DBA = DATA:MANAGE, DATA:READ, DATA:WRITE +DATA_SCIENTIST = DATA:READ, DATA:WRITE +DATA_ANALYST = DATA:READ +GUEST = NULL + +# The 'urls' section is used for url-based security in web applications. We'll discuss this section +# in the Web documentation +[urls] diff --git a/geode/security/src/main/resources/sql/define-roles-permissions-table-ddl.sql b/geode/security/src/main/resources/sql/define-roles-permissions-table-ddl.sql new file mode 100755 index 00000000..73a35e1b --- /dev/null +++ b/geode/security/src/main/resources/sql/define-roles-permissions-table-ddl.sql @@ -0,0 +1,7 @@ +CREATE TABLE IF NOT EXISTS geode_security.roles_permissions ( + role_id INTEGER REFERENCES geode_security.roles(id), + resource VARCHAR(32) NOT NUll, + operation VARCHAR(32) NOT NULL, + region_name VARCHAR(255), + key_name VARCHAR(255) +); diff --git a/geode/security/src/main/resources/sql/define-roles-table-ddl.sql b/geode/security/src/main/resources/sql/define-roles-table-ddl.sql new file mode 100755 index 00000000..ca8198a0 --- /dev/null +++ b/geode/security/src/main/resources/sql/define-roles-table-ddl.sql @@ -0,0 +1,4 @@ +CREATE TABLE IF NOT EXISTS geode_security.roles ( + id INTEGER PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY(START WITH 1, INCREMENT BY 1), + name VARCHAR(32) NOT NULL +); diff --git a/geode/security/src/main/resources/sql/define-users-roles-table-ddl.sql b/geode/security/src/main/resources/sql/define-users-roles-table-ddl.sql new file mode 100755 index 00000000..eb540d2c --- /dev/null +++ b/geode/security/src/main/resources/sql/define-users-roles-table-ddl.sql @@ -0,0 +1,4 @@ +CREATE TABLE IF NOT EXISTS geode_security.users_roles ( + user_id INTEGER REFERENCES geode_security.users(id), + role_id INTEGER REFERENCES geode_security.roles(id) +); diff --git a/geode/security/src/main/resources/sql/define-users-table-ddl.sql b/geode/security/src/main/resources/sql/define-users-table-ddl.sql new file mode 100755 index 00000000..e6bfc568 --- /dev/null +++ b/geode/security/src/main/resources/sql/define-users-table-ddl.sql @@ -0,0 +1,5 @@ +CREATE TABLE IF NOT EXISTS geode_security.users ( + id INTEGER PRIMARY KEY GENERATED BY DEFAULT AS IDENTITY(START WITH 1, INCREMENT BY 1), + name VARCHAR(255) NOT NULL, + credentials VARCHAR(255) +); diff --git a/geode/security/src/main/resources/sql/geode-security-schema-ddl.sql b/geode/security/src/main/resources/sql/geode-security-schema-ddl.sql new file mode 100755 index 00000000..6a7e3967 --- /dev/null +++ b/geode/security/src/main/resources/sql/geode-security-schema-ddl.sql @@ -0,0 +1 @@ +CREATE SCHEMA geode_security diff --git a/geode/security/src/main/resources/sql/insert-roles-dml.sql b/geode/security/src/main/resources/sql/insert-roles-dml.sql new file mode 100755 index 00000000..93f2b2bd --- /dev/null +++ b/geode/security/src/main/resources/sql/insert-roles-dml.sql @@ -0,0 +1,5 @@ +INSERT INTO geode_security.roles (name) VALUES ('ADMIN'); +INSERT INTO geode_security.roles (name) VALUES ('DBA'); +INSERT INTO geode_security.roles (name) VALUES ('DATA_SCIENTIST'); +INSERT INTO geode_security.roles (name) VALUES ('DATA_ANALYST'); +INSERT INTO geode_security.roles (name) VALUES ('GUEST'); diff --git a/geode/security/src/main/resources/sql/insert-roles-permissions-dml.sql b/geode/security/src/main/resources/sql/insert-roles-permissions-dml.sql new file mode 100755 index 00000000..0261d108 --- /dev/null +++ b/geode/security/src/main/resources/sql/insert-roles-permissions-dml.sql @@ -0,0 +1,11 @@ +INSERT INTO geode_security.roles_permissions (role_id, resource, operation) VALUES ((SELECT id FROM geode_security.roles WHERE name = 'ADMIN'), 'CLUSTER', 'MANAGE'); +INSERT INTO geode_security.roles_permissions (role_id, resource, operation) VALUES ((SELECT id FROM geode_security.roles WHERE name = 'ADMIN'), 'CLUSTER', 'READ'); +INSERT INTO geode_security.roles_permissions (role_id, resource, operation) VALUES ((SELECT id FROM geode_security.roles WHERE name = 'ADMIN'), 'CLUSTER', 'WRITE'); +INSERT INTO geode_security.roles_permissions (role_id, resource, operation) VALUES ((SELECT id FROM geode_security.roles WHERE name = 'DBA'), 'DATA', 'MANAGE'); +INSERT INTO geode_security.roles_permissions (role_id, resource, operation) VALUES ((SELECT id FROM geode_security.roles WHERE name = 'DBA'), 'DATA', 'READ'); +INSERT INTO geode_security.roles_permissions (role_id, resource, operation) VALUES ((SELECT id FROM geode_security.roles WHERE name = 'DBA'), 'DATA', 'WRITE'); +INSERT INTO geode_security.roles_permissions (role_id, resource, operation) VALUES ((SELECT id FROM geode_security.roles WHERE name = 'DATA_SCIENTIST'), 'DATA', 'READ'); +INSERT INTO geode_security.roles_permissions (role_id, resource, operation) VALUES ((SELECT id FROM geode_security.roles WHERE name = 'DATA_SCIENTIST'), 'DATA', 'WRITE'); +INSERT INTO geode_security.roles_permissions (role_id, resource, operation) VALUES ((SELECT id FROM geode_security.roles WHERE name = 'DATA_ANALYST'), 'DATA', 'READ'); +INSERT INTO geode_security.roles_permissions (role_id, resource, operation) VALUES ((SELECT id FROM geode_security.roles WHERE name = 'GUEST'), 'CLUSTER', 'NULL'); +INSERT INTO geode_security.roles_permissions (role_id, resource, operation) VALUES ((SELECT id FROM geode_security.roles WHERE name = 'GUEST'), 'DATA', 'NULL'); diff --git a/geode/security/src/main/resources/sql/insert-users-dml.sql b/geode/security/src/main/resources/sql/insert-users-dml.sql new file mode 100755 index 00000000..0afd2cb9 --- /dev/null +++ b/geode/security/src/main/resources/sql/insert-users-dml.sql @@ -0,0 +1,4 @@ +INSERT INTO geode_security.users (name, credentials) VALUES ('root', 's3cr3t!'); +INSERT INTO geode_security.users (name, credentials) VALUES ('scientist', 'w0rk!ng4u'); +INSERT INTO geode_security.users (name, credentials) VALUES ('analyst', 'p@55w0rd'); +INSERT INTO geode_security.users (name, credentials) VALUES ('guest', 'guest'); diff --git a/geode/security/src/main/resources/sql/insert-users-roles-dml.sql b/geode/security/src/main/resources/sql/insert-users-roles-dml.sql new file mode 100755 index 00000000..7d0da905 --- /dev/null +++ b/geode/security/src/main/resources/sql/insert-users-roles-dml.sql @@ -0,0 +1,5 @@ +INSERT INTO geode_security.users_roles (user_id, role_id) VALUES ((SELECT id FROM geode_security.users WHERE name = 'root'), (SELECT id FROM geode_security.roles WHERE name = 'ADMIN')); +INSERT INTO geode_security.users_roles (user_id, role_id) VALUES ((SELECT id FROM geode_security.users WHERE name = 'root'), (SELECT id FROM geode_security.roles WHERE name = 'DBA')); +INSERT INTO geode_security.users_roles (user_id, role_id) VALUES ((SELECT id FROM geode_security.users WHERE name = 'scientist'), (SELECT id FROM geode_security.roles WHERE name = 'DATA_SCIENTIST')); +INSERT INTO geode_security.users_roles (user_id, role_id) VALUES ((SELECT id FROM geode_security.users WHERE name = 'analyst'), (SELECT id FROM geode_security.roles WHERE name = 'DATA_ANALYST')); +INSERT INTO geode_security.users_roles (user_id, role_id) VALUES ((SELECT id FROM geode_security.users WHERE name = 'guest'), (SELECT id FROM geode_security.roles WHERE name = 'GUEST')); diff --git a/geode/security/src/test/java/example/springdata/geode/client/security/client/SecurityEnabledClientShiroTests.java b/geode/security/src/test/java/example/springdata/geode/client/security/client/SecurityEnabledClientShiroTests.java new file mode 100755 index 00000000..8ae28b4f --- /dev/null +++ b/geode/security/src/test/java/example/springdata/geode/client/security/client/SecurityEnabledClientShiroTests.java @@ -0,0 +1,76 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.security.client; + +import example.springdata.geode.client.security.Customer; +import example.springdata.geode.client.security.EmailAddress; +import example.springdata.geode.client.security.server.SecurityEnabledServer; +import org.apache.geode.cache.Region; +import org.junit.BeforeClass; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.data.gemfire.tests.integration.ForkingClientServerIntegrationTestsSupport; +import org.springframework.test.annotation.DirtiesContext; +import org.springframework.test.context.junit4.SpringRunner; + +import javax.annotation.Resource; +import java.io.IOException; +import java.util.List; + +import static org.assertj.core.api.Assertions.assertThat; + +@RunWith(SpringRunner.class) +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.NONE, classes = SecurityEnabledClientConfiguration.class) +@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS) +public class SecurityEnabledClientShiroTests extends ForkingClientServerIntegrationTestsSupport { + + @Autowired + private CustomerRepository customerRepository; + + @Resource(name = "Customers") + private Region customers; + + private Logger logger = LoggerFactory.getLogger(this.getClass()); + + @BeforeClass + public static void setup() throws IOException { + startGemFireServer(SecurityEnabledServer.class, "-Dspring.profiles.active=shiro-ini-configuration"); + } + + @Test + public void securityWasConfiguredCorrectly() { + logger.info("Inserting 3 entries for keys: 1, 2, 3"); + Customer john = new Customer(1L, new EmailAddress("2@2.com"), "John", "Smith"); + Customer frank = new Customer(2L, new EmailAddress("3@3.com"), "Frank", "Lamport"); + Customer jude = new Customer(3L, new EmailAddress("5@5.com"), "Jude", "Simmons"); + customerRepository.save(john); + customerRepository.save(frank); + customerRepository.save(jude); + assertThat(customers.keySetOnServer().size()).isEqualTo(3); + logger.info("Customers saved on server:"); + List customerList = customerRepository.findAll(); + assertThat(customerList.size()).isEqualTo(3); + assertThat(customerList.contains(john)).isTrue(); + assertThat(customerList.contains(frank)).isTrue(); + assertThat(customerList.contains(jude)).isTrue(); + customerList.forEach(customer -> logger.info("\t Entry: \n \t\t " + customer)); + } +} \ No newline at end of file diff --git a/geode/security/src/test/java/example/springdata/geode/client/security/client/SecurityEnabledClientTests.java b/geode/security/src/test/java/example/springdata/geode/client/security/client/SecurityEnabledClientTests.java new file mode 100755 index 00000000..003c89f8 --- /dev/null +++ b/geode/security/src/test/java/example/springdata/geode/client/security/client/SecurityEnabledClientTests.java @@ -0,0 +1,76 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.security.client; + +import example.springdata.geode.client.security.Customer; +import example.springdata.geode.client.security.EmailAddress; +import example.springdata.geode.client.security.server.SecurityEnabledServer; +import org.apache.geode.cache.Region; +import org.junit.BeforeClass; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.data.gemfire.tests.integration.ForkingClientServerIntegrationTestsSupport; +import org.springframework.test.annotation.DirtiesContext; +import org.springframework.test.context.junit4.SpringRunner; + +import javax.annotation.Resource; +import java.io.IOException; +import java.util.List; + +import static org.assertj.core.api.Assertions.assertThat; + +@RunWith(SpringRunner.class) +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.NONE, classes = SecurityEnabledClientConfiguration.class) +@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS) +public class SecurityEnabledClientTests extends ForkingClientServerIntegrationTestsSupport { + + @Autowired + private CustomerRepository customerRepository; + + @Resource(name = "Customers") + private Region customers; + + private Logger logger = LoggerFactory.getLogger(this.getClass()); + + @BeforeClass + public static void setup() throws IOException { + startGemFireServer(SecurityEnabledServer.class); + } + + @Test + public void SecurityWasConfiguredCorrectly() { + logger.info("Inserting 3 entries for keys: 1, 2, 3"); + Customer john = new Customer(1L, new EmailAddress("2@2.com"), "John", "Smith"); + Customer frank = new Customer(2L, new EmailAddress("3@3.com"), "Frank", "Lamport"); + Customer jude = new Customer(3L, new EmailAddress("5@5.com"), "Jude", "Simmons"); + customerRepository.save(john); + customerRepository.save(frank); + customerRepository.save(jude); + assertThat(customers.keySetOnServer().size()).isEqualTo(3); + logger.info("Customers saved on server:"); + List customerList = customerRepository.findAll(); + assertThat(customerList.size()).isEqualTo(3); + assertThat(customerList.contains(john)).isTrue(); + assertThat(customerList.contains(frank)).isTrue(); + assertThat(customerList.contains(jude)).isTrue(); + customerList.forEach(customer -> logger.info("\t Entry: \n \t\t " + customer)); + } +} \ No newline at end of file diff --git a/geode/security/src/test/resources/logback.xml b/geode/security/src/test/resources/logback.xml new file mode 100644 index 00000000..f3b82068 --- /dev/null +++ b/geode/security/src/test/resources/logback.xml @@ -0,0 +1,11 @@ + + + + %msg%n + + + + + + + \ No newline at end of file diff --git a/geode/storage/README.md b/geode/storage/README.md new file mode 100644 index 00000000..5a13064c --- /dev/null +++ b/geode/storage/README.md @@ -0,0 +1,5 @@ +# Storage Example + +In this example you will see how to configure your server to compress regions, store data off-heap, and customize the way region is stored in the region, such as the number of buckets and duplicate copies. + +NOTE: Inorder to see output, you must change the loglevel from "error" to "info" in the `logback.xml` file located under src/test/resources. \ No newline at end of file diff --git a/geode/storage/pom.xml b/geode/storage/pom.xml new file mode 100644 index 00000000..649af983 --- /dev/null +++ b/geode/storage/pom.xml @@ -0,0 +1,22 @@ + + + + spring-data-geode-examples + example.springdata.geode + 1.0-SNAPSHOT + + 4.0.0 + + storage + + + + org.iq80.snappy + snappy + 0.4 + + + + \ No newline at end of file diff --git a/geode/storage/src/main/java/example/springdata/geode/server/storage/Address.java b/geode/storage/src/main/java/example/springdata/geode/server/storage/Address.java new file mode 100755 index 00000000..44544bbf --- /dev/null +++ b/geode/storage/src/main/java/example/springdata/geode/server/storage/Address.java @@ -0,0 +1,41 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.storage; + +import lombok.Data; + +import java.io.Serializable; + +/** + * An address used in the examples. + * + * @author Oliver Gierke + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +public class Address implements Serializable { + private String street; + private String city; + private String country; + + public Address(String street, String city, String country) { + this.street = street; + this.city = city; + this.country = country; + } +} diff --git a/geode/storage/src/main/java/example/springdata/geode/server/storage/Customer.java b/geode/storage/src/main/java/example/springdata/geode/server/storage/Customer.java new file mode 100755 index 00000000..100f5b3c --- /dev/null +++ b/geode/storage/src/main/java/example/springdata/geode/server/storage/Customer.java @@ -0,0 +1,51 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.storage; + +import lombok.Data; +import org.springframework.data.annotation.Id; +import org.springframework.data.gemfire.mapping.annotation.Region; + +import java.io.Serializable; +import java.util.Arrays; +import java.util.List; + +/** + * A customer used for Lucene examples. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +@Region(name = "Customers") +public class Customer implements Serializable { + + @Id + private Long id; + private EmailAddress emailAddress; + private String firstName; + private String lastName; + private List
addresses; + + public Customer(Long id, EmailAddress emailAddress, String firstName, String lastName, Address... addresses) { + this.id = id; + this.emailAddress = emailAddress; + this.firstName = firstName; + this.lastName = lastName; + this.addresses = Arrays.asList(addresses); + } +} \ No newline at end of file diff --git a/geode/storage/src/main/java/example/springdata/geode/server/storage/CustomerRepository.java b/geode/storage/src/main/java/example/springdata/geode/server/storage/CustomerRepository.java new file mode 100755 index 00000000..2d61b8a4 --- /dev/null +++ b/geode/storage/src/main/java/example/springdata/geode/server/storage/CustomerRepository.java @@ -0,0 +1,22 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.storage; + +import org.springframework.data.repository.CrudRepository; + +public interface CustomerRepository extends CrudRepository { +} diff --git a/geode/storage/src/main/java/example/springdata/geode/server/storage/EmailAddress.java b/geode/storage/src/main/java/example/springdata/geode/server/storage/EmailAddress.java new file mode 100755 index 00000000..68a91b88 --- /dev/null +++ b/geode/storage/src/main/java/example/springdata/geode/server/storage/EmailAddress.java @@ -0,0 +1,37 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.storage; + +import lombok.Data; + +import java.io.Serializable; + +/** + * Value object to represent email addresses. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +public class EmailAddress implements Serializable { + private String value; + + public EmailAddress(String value) { + + this.value = value; + } +} \ No newline at end of file diff --git a/geode/storage/src/main/java/example/springdata/geode/server/storage/LineItem.java b/geode/storage/src/main/java/example/springdata/geode/server/storage/LineItem.java new file mode 100755 index 00000000..ae7b088b --- /dev/null +++ b/geode/storage/src/main/java/example/springdata/geode/server/storage/LineItem.java @@ -0,0 +1,44 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.storage; + +import lombok.Data; + +import java.io.Serializable; +import java.math.BigDecimal; + +/** + * A LineItem used in the examples + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +public class LineItem implements Serializable { + + private Product product; + private Integer amount; + + public LineItem(Product product, Integer amount) { + this.product = product; + this.amount = amount; + } + + public BigDecimal calcTotal() { + return product.getPrice().multiply(BigDecimal.valueOf(amount)); + } +} \ No newline at end of file diff --git a/geode/storage/src/main/java/example/springdata/geode/server/storage/Order.java b/geode/storage/src/main/java/example/springdata/geode/server/storage/Order.java new file mode 100755 index 00000000..01753d7d --- /dev/null +++ b/geode/storage/src/main/java/example/springdata/geode/server/storage/Order.java @@ -0,0 +1,72 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.storage; + +import lombok.Data; +import org.springframework.data.annotation.Id; +import org.springframework.data.gemfire.mapping.annotation.Region; + +import java.io.Serializable; +import java.math.BigDecimal; +import java.util.ArrayList; +import java.util.List; + +/** + * Orders object used in the examples + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +@Region("Orders") +public class Order implements Serializable { + @Id + private Long id; + private Long customerId; + private Address billingAddress; + private Address shippingAddress; + private List lineItems = new ArrayList<>(); + + public Order(Long orderId, Long customerId, Address address) { + this.id = orderId; + this.customerId = customerId; + this.billingAddress = address; + this.shippingAddress = address; + } + + /** + * Returns the total of the [Order]. + * + * @return + */ + public BigDecimal calcTotal() { + if (lineItems.size() == 0) { + return BigDecimal.ZERO; + } else { + return lineItems.stream().map(LineItem::calcTotal).reduce(BigDecimal::add).get(); + } + } + + /** + * Adds the given [LineItem] to the [Order]. + * + * @param lineItem + */ + public void add(LineItem lineItem) { + lineItems.add(lineItem); + } +} \ No newline at end of file diff --git a/geode/storage/src/main/java/example/springdata/geode/server/storage/OrderRepository.java b/geode/storage/src/main/java/example/springdata/geode/server/storage/OrderRepository.java new file mode 100755 index 00000000..5cdd8c35 --- /dev/null +++ b/geode/storage/src/main/java/example/springdata/geode/server/storage/OrderRepository.java @@ -0,0 +1,22 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.storage; + +import org.springframework.data.repository.CrudRepository; + +public interface OrderRepository extends CrudRepository { +} diff --git a/geode/storage/src/main/java/example/springdata/geode/server/storage/Product.java b/geode/storage/src/main/java/example/springdata/geode/server/storage/Product.java new file mode 100755 index 00000000..9f2e316b --- /dev/null +++ b/geode/storage/src/main/java/example/springdata/geode/server/storage/Product.java @@ -0,0 +1,68 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.storage; + +import lombok.Data; +import org.springframework.data.annotation.Id; +import org.springframework.data.annotation.PersistenceConstructor; +import org.springframework.data.annotation.Transient; +import org.springframework.data.gemfire.mapping.annotation.Region; + +import java.io.Serializable; +import java.math.BigDecimal; +import java.util.HashMap; +import java.util.Map; + +/** + * A product used in the examples. + * + * @author Oliver Gierke + * @author David Turanski + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +@Region("Products") +public class Product implements Serializable { + + @Id + private Long id; + private String name; + private BigDecimal price; + private String description; + + @Transient + private Map attributes = new HashMap<>(); + + @PersistenceConstructor + public Product(Long id, String name, BigDecimal price, String description) { + this.id = id; + this.name = name; + this.price = price; + this.description = description; + } + + /** + * Sets the attribute with the given name to the given value. + * + * @param name must not be null or empty. + * @param value + */ + public void addAttribute(String name, String value) { + this.attributes.put(name, value); + } +} diff --git a/geode/storage/src/main/java/example/springdata/geode/server/storage/ProductRepository.java b/geode/storage/src/main/java/example/springdata/geode/server/storage/ProductRepository.java new file mode 100755 index 00000000..d861dbfb --- /dev/null +++ b/geode/storage/src/main/java/example/springdata/geode/server/storage/ProductRepository.java @@ -0,0 +1,22 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.storage; + +import org.springframework.data.repository.CrudRepository; + +public interface ProductRepository extends CrudRepository { +} diff --git a/geode/storage/src/main/java/example/springdata/geode/server/storage/StorageServer.java b/geode/storage/src/main/java/example/springdata/geode/server/storage/StorageServer.java new file mode 100755 index 00000000..1756415d --- /dev/null +++ b/geode/storage/src/main/java/example/springdata/geode/server/storage/StorageServer.java @@ -0,0 +1,92 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.storage; + +import org.apache.geode.cache.Region; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.boot.ApplicationRunner; +import org.springframework.boot.WebApplicationType; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.boot.builder.SpringApplicationBuilder; +import org.springframework.context.annotation.Bean; + +import java.math.BigDecimal; +import java.util.Random; +import java.util.stream.IntStream; +import java.util.stream.LongStream; + +@SpringBootApplication(scanBasePackageClasses = StorageServerConfig.class) +public class StorageServer { + + private Logger logger = LoggerFactory.getLogger(this.getClass()); + + public static void main(String[] args) { + new SpringApplicationBuilder(StorageServer.class) + .web(WebApplicationType.NONE) + .build() + .run(args); + } + + @Bean + public ApplicationRunner runner(CustomerRepository customerRepository, OrderRepository orderRepository, + ProductRepository productRepository, @Qualifier("Products") Region products) { + return args -> { + createCustomerData(customerRepository); + + createProducts(productRepository); + + createOrders(productRepository, orderRepository); + + logger.info("Completed creating orders "); + }; + } + + private void createOrders(ProductRepository productRepository, OrderRepository orderRepository) { + Random random = new Random(System.nanoTime()); + Address address = new Address("it", "doesn't", "matter"); + LongStream.rangeClosed(1, 10).forEach((orderId) -> + LongStream.rangeClosed(1, 300).forEach((customerId) -> { + Order order = new Order(orderId, customerId, address); + IntStream.rangeClosed(0, random.nextInt(3) + 1).forEach((lineItemCount) -> { + int quantity = random.nextInt(3) + 1; + long productId = random.nextInt(3) + 1; + order.add(new LineItem(productRepository.findById(productId).get(), quantity)); + }); + orderRepository.save(order); + })); + } + + private void createProducts(ProductRepository productRepository) { + productRepository.save(new Product(1L, "Apple iPod", new BigDecimal("99.99"), + "An Apple portable music player")); + productRepository.save(new Product(2L, "Apple iPad", new BigDecimal("499.99"), + "An Apple tablet device")); + Product macbook = new Product(3L, "Apple macBook", new BigDecimal("899.99"), + "An Apple notebook computer"); + macbook.addAttribute("warranty", "included"); + productRepository.save(macbook); + } + + private void createCustomerData(CustomerRepository customerRepository) { + LongStream.rangeClosed(0, 300) + .parallel() + .forEach(customerId -> + customerRepository.save(new Customer(customerId, new EmailAddress(customerId + "@2.com"), "John" + customerId, "Smith" + customerId))); + } +} \ No newline at end of file diff --git a/geode/storage/src/main/java/example/springdata/geode/server/storage/StorageServerConfig.java b/geode/storage/src/main/java/example/springdata/geode/server/storage/StorageServerConfig.java new file mode 100755 index 00000000..f4970b2e --- /dev/null +++ b/geode/storage/src/main/java/example/springdata/geode/server/storage/StorageServerConfig.java @@ -0,0 +1,91 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.storage; + +import org.apache.geode.cache.DataPolicy; +import org.apache.geode.cache.GemFireCache; +import org.apache.geode.cache.PartitionAttributes; +import org.apache.geode.cache.RegionAttributes; +import org.apache.geode.compression.Compressor; +import org.apache.geode.compression.SnappyCompressor; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.context.annotation.Configuration; +import org.springframework.data.gemfire.PartitionAttributesFactoryBean; +import org.springframework.data.gemfire.PartitionedRegionFactoryBean; +import org.springframework.data.gemfire.RegionAttributesFactoryBean; +import org.springframework.data.gemfire.ReplicatedRegionFactoryBean; +import org.springframework.data.gemfire.config.annotation.CacheServerApplication; +import org.springframework.data.gemfire.config.annotation.EnableOffHeap; +import org.springframework.data.gemfire.repository.config.EnableGemfireRepositories; + +@Configuration +@ComponentScan +@CacheServerApplication(logLevel = "error") +@EnableGemfireRepositories(basePackageClasses = CustomerRepository.class) +@EnableOffHeap(memorySize = "8192m", regionNames = "Products") +public class StorageServerConfig { + + @Bean + Compressor createSnappyCompressor() { + return new SnappyCompressor(); + } + + @Bean + RegionAttributesFactoryBean regionAttributes(PartitionAttributes partitionAttributes) { + final RegionAttributesFactoryBean regionAttributesFactoryBean = new RegionAttributesFactoryBean<>(); + regionAttributesFactoryBean.setPartitionAttributes(partitionAttributes); + return regionAttributesFactoryBean; + } + + @Bean + PartitionAttributesFactoryBean partitionAttributes() { + final PartitionAttributesFactoryBean partitionAttributesFactoryBean = new PartitionAttributesFactoryBean<>(); + partitionAttributesFactoryBean.setTotalNumBuckets(11); + partitionAttributesFactoryBean.setRedundantCopies(1); + return partitionAttributesFactoryBean; + } + + @Bean("Orders") + PartitionedRegionFactoryBean createOrderRegion(GemFireCache gemFireCache, RegionAttributes regionAttributes) { + final PartitionedRegionFactoryBean partitionedRegionFactoryBean = new PartitionedRegionFactoryBean<>(); + partitionedRegionFactoryBean.setCache(gemFireCache); + partitionedRegionFactoryBean.setRegionName("Orders"); + partitionedRegionFactoryBean.setDataPolicy(DataPolicy.PARTITION); + partitionedRegionFactoryBean.setAttributes(regionAttributes); + return partitionedRegionFactoryBean; + } + + @Bean("Products") + ReplicatedRegionFactoryBean createProductRegion(GemFireCache gemFireCache) { + final ReplicatedRegionFactoryBean replicatedRegionFactoryBean = new ReplicatedRegionFactoryBean<>(); + replicatedRegionFactoryBean.setCache(gemFireCache); + replicatedRegionFactoryBean.setRegionName("Products"); + replicatedRegionFactoryBean.setDataPolicy(DataPolicy.REPLICATE); + return replicatedRegionFactoryBean; + } + + @Bean("Customers") + ReplicatedRegionFactoryBean createCustomerRegion(GemFireCache gemFireCache, Compressor compressor) { + final ReplicatedRegionFactoryBean replicatedRegionFactoryBean = new ReplicatedRegionFactoryBean<>(); + replicatedRegionFactoryBean.setCache(gemFireCache); + replicatedRegionFactoryBean.setRegionName("Customers"); + replicatedRegionFactoryBean.setDataPolicy(DataPolicy.REPLICATE); + replicatedRegionFactoryBean.setCompressor(compressor); + return replicatedRegionFactoryBean; + } +} \ No newline at end of file diff --git a/geode/storage/src/test/java/example/springdata/geode/server/storage/StorageServerTests.java b/geode/storage/src/test/java/example/springdata/geode/server/storage/StorageServerTests.java new file mode 100755 index 00000000..3857299b --- /dev/null +++ b/geode/storage/src/test/java/example/springdata/geode/server/storage/StorageServerTests.java @@ -0,0 +1,68 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.storage; + +import org.apache.geode.cache.Cache; +import org.apache.geode.cache.Region; +import org.apache.geode.compression.SnappyCompressor; +import org.apache.geode.internal.cache.GemFireCacheImpl; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.annotation.DirtiesContext; +import org.springframework.test.context.junit4.SpringRunner; + +import javax.annotation.Resource; + +import static org.assertj.core.api.Assertions.assertThat; + +@RunWith(SpringRunner.class) +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.NONE, classes = StorageServer.class) +@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS) +public class StorageServerTests { + @Resource(name = "Customers") + private Region customers; + + @Resource(name = "Orders") + private Region orders; + + @Resource(name = "Products") + private Region products; + + @Autowired + Cache cache; + + @Test + public void partitionAttributesConfiguredCorrectly() { + assertThat(this.orders.getAttributes().getPartitionAttributes().getTotalNumBuckets()).isEqualTo(11); + assertThat(this.orders.getAttributes().getPartitionAttributes().getRedundantCopies()).isEqualTo(1); + } + + @Test + public void compressorIsEnabled() { + assertThat(customers.getAttributes().getCompressor()).isInstanceOf(SnappyCompressor.class); + GemFireCacheImpl impl = (GemFireCacheImpl) cache; + assertThat(impl.getCachePerfStats().getTotalPostCompressedBytes()).isLessThan(impl.getCachePerfStats().getTotalPreCompressedBytes()); + } + + @Test + public void offHeapConfiguredCorrectly() { + assertThat(products.getAttributes().getOffHeap()).isTrue(); + assertThat(customers.getAttributes().getOffHeap()).isFalse(); + } +} \ No newline at end of file diff --git a/geode/storage/src/test/resources/logback.xml b/geode/storage/src/test/resources/logback.xml new file mode 100644 index 00000000..f3b82068 --- /dev/null +++ b/geode/storage/src/test/resources/logback.xml @@ -0,0 +1,11 @@ + + + + %msg%n + + + + + + + \ No newline at end of file diff --git a/geode/transactions/README.md b/geode/transactions/README.md new file mode 100755 index 00000000..40b457d0 --- /dev/null +++ b/geode/transactions/README.md @@ -0,0 +1,21 @@ +# Transactions Example + +In this example a [Pivotal GemFire](https://pivotal.io/pivotal-gemfire) / [Apache Geode](http://geode.apache.org/) client will be configured to perform the basic CRUD operations within a transaction. First, it will do a successful transaction where entries are saved to the server, and then a failed transaction where all changes are reverted. + +To run the example simply run the tests located under transactions/src/test in your IDE. + +The client is configured to connect to the server on `localhost` port `40404`. There is no need to start the server separately, as that is taken care of by the test. + +## Running the example + +The example is broken up into multiple steps: +1. Print number of entries on server +3. Insert (Put) five Customer entries into the `Customers` region using the repositories `save` method. +3. Printing out the size of the region on the server +4. Update the Customer for id=2 in a transaction. Recording the before and after Customer detail. +5. Fail a transaction to update the Customer with id=2. Recording the before and after Customer detail. +6. Update the Customer for id=2 with a delay of 1000 ms. +7. Update the Customer for id=2 with a delay of 10 ms. +8. Print customer for id=2 + +NOTE: Inorder to see output, you must change the loglevel from "error" to "info" in the `logback.xml` file located under src/test/resources. \ No newline at end of file diff --git a/geode/transactions/pom.xml b/geode/transactions/pom.xml new file mode 100755 index 00000000..47526744 --- /dev/null +++ b/geode/transactions/pom.xml @@ -0,0 +1,19 @@ + + + + example.springdata.geode + spring-data-geode-examples + 1.0-SNAPSHOT + + + 4.0.0 + transactions + 1.0-SNAPSHOT + + + + + + \ No newline at end of file diff --git a/geode/transactions/src/main/java/example/springdata/geode/client/transactions/Customer.java b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/Customer.java new file mode 100755 index 00000000..e0e9ea86 --- /dev/null +++ b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/Customer.java @@ -0,0 +1,45 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.transactions; + +import lombok.Data; +import org.springframework.data.annotation.Id; +import org.springframework.data.gemfire.mapping.annotation.Region; + +/** + * A customer used for Lucene examples. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +@Region(name = "Customers") +public class Customer { + + @Id + private Long id; + private EmailAddress emailAddress; + private String firstName; + private String lastName; + + public Customer(Long id, EmailAddress emailAddress, String firstName, String lastName) { + this.id = id; + this.emailAddress = emailAddress; + this.firstName = firstName; + this.lastName = lastName; + } +} \ No newline at end of file diff --git a/geode/transactions/src/main/java/example/springdata/geode/client/transactions/EmailAddress.java b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/EmailAddress.java new file mode 100755 index 00000000..16c841cc --- /dev/null +++ b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/EmailAddress.java @@ -0,0 +1,34 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.transactions; + +import lombok.Data; + +/** + * Value object to represent email addresses. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +public class EmailAddress { + private String value; + + public EmailAddress(String value) { + this.value = value; + } +} \ No newline at end of file diff --git a/geode/transactions/src/main/java/example/springdata/geode/client/transactions/client/CustomerRepository.java b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/client/CustomerRepository.java new file mode 100755 index 00000000..1a9f2034 --- /dev/null +++ b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/client/CustomerRepository.java @@ -0,0 +1,29 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.transactions.client; + +import example.springdata.geode.client.transactions.Customer; +import org.springframework.data.gemfire.mapping.annotation.ClientRegion; +import org.springframework.data.repository.CrudRepository; + +import java.util.List; + +@ClientRegion("Customers") +public interface CustomerRepository extends CrudRepository { + + List findAll(); +} diff --git a/geode/transactions/src/main/java/example/springdata/geode/client/transactions/client/CustomerService.java b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/client/CustomerService.java new file mode 100755 index 00000000..676d0baf --- /dev/null +++ b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/client/CustomerService.java @@ -0,0 +1,83 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.transactions.client; + +import example.springdata.geode.client.transactions.Customer; +import example.springdata.geode.client.transactions.EmailAddress; +import org.apache.geode.cache.Region; +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +import javax.annotation.Resource; +import java.util.Arrays; +import java.util.List; +import java.util.Optional; +import java.util.stream.Collectors; + +@Service +public class CustomerService { + private final CustomerRepository customerRepository; + + @Resource(name = "Customers") + private Region customerRegion; + + public CustomerService(CustomerRepository customerRepository, @Qualifier("Customers") Region customerRegion) { + this.customerRepository = customerRepository; + this.customerRegion = customerRegion; + } + + private CustomerRepository getCustomerRepository() { + return customerRepository; + } + + public Optional findById(long id) { + return getCustomerRepository().findById(id); + } + + public int numberEntriesStoredOnServer() { + return customerRegion.keySetOnServer().size(); + } + + @Transactional + public List createFiveCustomers() { + return Arrays.stream(new Customer[]{new Customer(1L, new EmailAddress("1@1.com"), "John", "Melloncamp"), + new Customer(2L, new EmailAddress("2@2.com"), "Franky", "Hamilton"), + new Customer(3L, new EmailAddress("3@3.com"), "Sebastian", "Horner"), + new Customer(4L, new EmailAddress("4@4.com"), "Chris", "Vettel"), + new Customer(5L, new EmailAddress("5@5.com"), "Kimi", "Rosberg")}) + .map(customerRepository::save) + .collect(Collectors.toList()); + } + + @Transactional + public void updateCustomersSuccess() { + customerRepository.save(new Customer(2L, new EmailAddress("2@2.com"), "Humpty", "Hamilton")); + } + + @Transactional + public void updateCustomersWithDelay(int millisDelay, Customer customer) throws InterruptedException { + customerRepository.save(customer); + Thread.sleep(millisDelay); + } + + @Transactional + public void updateCustomersFailure() { + customerRepository.save(new Customer(2L, new EmailAddress("2@2.com"), "Numpty", "Hamilton")); + throw new IllegalArgumentException("This should fail the transactions"); + } +} \ No newline at end of file diff --git a/geode/transactions/src/main/java/example/springdata/geode/client/transactions/client/TransactionalClientConfig.java b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/client/TransactionalClientConfig.java new file mode 100755 index 00000000..c13e159f --- /dev/null +++ b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/client/TransactionalClientConfig.java @@ -0,0 +1,38 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.transactions.client; + +import org.apache.geode.cache.client.ClientRegionShortcut; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.context.annotation.Configuration; +import org.springframework.data.gemfire.config.annotation.ClientCacheApplication; +import org.springframework.data.gemfire.config.annotation.EnableClusterDefinedRegions; +import org.springframework.data.gemfire.config.annotation.EnablePdx; +import org.springframework.data.gemfire.repository.config.EnableGemfireRepositories; +import org.springframework.data.gemfire.transaction.config.EnableGemfireCacheTransactions; +import org.springframework.transaction.annotation.EnableTransactionManagement; + +@EnableClusterDefinedRegions(clientRegionShortcut = ClientRegionShortcut.PROXY) +@EnableTransactionManagement +@EnableGemfireCacheTransactions +@Configuration +@EnablePdx +@ComponentScan(basePackageClasses = CustomerService.class) +@EnableGemfireRepositories(basePackageClasses = CustomerRepository.class) +@ClientCacheApplication(name = "TransactionalClient", logLevel = "error", pingInterval = 5000L, readTimeout = 15000, retryAttempts = 1) +public class TransactionalClientConfig { +} \ No newline at end of file diff --git a/geode/transactions/src/main/java/example/springdata/geode/client/transactions/server/CustomerTransactionListener.java b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/server/CustomerTransactionListener.java new file mode 100644 index 00000000..a97e8d75 --- /dev/null +++ b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/server/CustomerTransactionListener.java @@ -0,0 +1,50 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.transactions.server; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.apache.geode.cache.CacheEvent; +import org.apache.geode.cache.TransactionEvent; +import org.apache.geode.cache.util.TransactionListenerAdapter; +import org.apache.geode.internal.cache.TXEntryState; +import org.springframework.stereotype.Component; + +import java.util.stream.Collectors; + +@Component +public class CustomerTransactionListener extends TransactionListenerAdapter { + private Log log = LogFactory.getLog(CustomerTransactionListener.class); + + @Override + public void afterFailedCommit(TransactionEvent event) { + + } + + @Override + public void afterRollback(TransactionEvent event) { + log.info("In afterRollback for entry(s) [" + event.getEvents().stream().map(this::getEventInfo).collect(Collectors.toList()) + "]"); + } + + private String getEventInfo(CacheEvent cacheEvent) { + if (cacheEvent instanceof TXEntryState.TxEntryEventImpl) { + return ((TXEntryState.TxEntryEventImpl) cacheEvent).getNewValue().toString(); + } else { + return cacheEvent.toString(); + } + } +} \ No newline at end of file diff --git a/geode/transactions/src/main/java/example/springdata/geode/client/transactions/server/CustomerTransactionWriter.java b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/server/CustomerTransactionWriter.java new file mode 100644 index 00000000..09e92796 --- /dev/null +++ b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/server/CustomerTransactionWriter.java @@ -0,0 +1,44 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.transactions.server; + +import org.apache.geode.cache.TransactionEvent; +import org.apache.geode.cache.TransactionWriter; +import org.apache.geode.cache.TransactionWriterException; +import org.apache.geode.internal.cache.TXEntryState; +import org.apache.geode.internal.cache.TXEvent; +import org.springframework.stereotype.Component; + +import java.util.concurrent.atomic.AtomicBoolean; + +@Component +public class CustomerTransactionWriter implements TransactionWriter { + + @Override + public void beforeCommit(TransactionEvent transactionEvent) throws TransactionWriterException { + AtomicBoolean six_found = new AtomicBoolean(false); + ((TXEvent) transactionEvent).getEvents().forEach(event -> { + if (event instanceof TXEntryState.TxEntryEventImpl && ((TXEntryState.TxEntryEventImpl) event).getKey().equals(6L)) { + six_found.set(true); + } + }); + + if (six_found.get()) { + throw new TransactionWriterException("Customer for Key: 6 is being changed. Failing transaction"); + } + } +} \ No newline at end of file diff --git a/geode/transactions/src/main/java/example/springdata/geode/client/transactions/server/TransactionalServer.java b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/server/TransactionalServer.java new file mode 100755 index 00000000..40d45d51 --- /dev/null +++ b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/server/TransactionalServer.java @@ -0,0 +1,31 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.transactions.server; + +import org.springframework.boot.WebApplicationType; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.boot.builder.SpringApplicationBuilder; + +@SpringBootApplication(scanBasePackageClasses = TransactionalServerConfig.class) +public class TransactionalServer { + public static void main(String[] args) { + new SpringApplicationBuilder(TransactionalServer.class) + .web(WebApplicationType.NONE) + .build() + .run(args); + } +} \ No newline at end of file diff --git a/geode/transactions/src/main/java/example/springdata/geode/client/transactions/server/TransactionalServerConfig.java b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/server/TransactionalServerConfig.java new file mode 100755 index 00000000..739454dc --- /dev/null +++ b/geode/transactions/src/main/java/example/springdata/geode/client/transactions/server/TransactionalServerConfig.java @@ -0,0 +1,47 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.transactions.server; + +import example.springdata.geode.client.transactions.Customer; +import org.apache.geode.cache.DataPolicy; +import org.apache.geode.cache.GemFireCache; +import org.apache.geode.cache.Scope; +import org.springframework.context.annotation.Bean; +import org.springframework.data.gemfire.ReplicatedRegionFactoryBean; +import org.springframework.data.gemfire.config.annotation.CacheServerApplication; +import org.springframework.data.gemfire.config.annotation.EnableLocator; +import org.springframework.data.gemfire.config.annotation.EnableManager; +import org.springframework.data.gemfire.transaction.config.EnableGemfireCacheTransactions; +import org.springframework.transaction.annotation.EnableTransactionManagement; + +@EnableLocator +@EnableTransactionManagement +@EnableGemfireCacheTransactions +@EnableManager(start = true) +@CacheServerApplication(logLevel = "error") +public class TransactionalServerConfig { + + @Bean("Customers") + ReplicatedRegionFactoryBean createCustomerRegion(GemFireCache gemfireCache) { + ReplicatedRegionFactoryBean replicatedRegionFactoryBean = new ReplicatedRegionFactoryBean<>(); + replicatedRegionFactoryBean.setCache(gemfireCache); + replicatedRegionFactoryBean.setRegionName("Customers"); + replicatedRegionFactoryBean.setDataPolicy(DataPolicy.REPLICATE); + replicatedRegionFactoryBean.setScope(Scope.DISTRIBUTED_ACK); + return replicatedRegionFactoryBean; + } +} diff --git a/geode/transactions/src/test/java/example/springdata/geode/client/transactions/client/TransactionalClientTests.java b/geode/transactions/src/test/java/example/springdata/geode/client/transactions/client/TransactionalClientTests.java new file mode 100755 index 00000000..69c4da99 --- /dev/null +++ b/geode/transactions/src/test/java/example/springdata/geode/client/transactions/client/TransactionalClientTests.java @@ -0,0 +1,89 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.client.transactions.client; + +import example.springdata.geode.client.transactions.Customer; +import example.springdata.geode.client.transactions.EmailAddress; +import example.springdata.geode.client.transactions.server.TransactionalServer; +import org.apache.geode.cache.Region; +import org.junit.BeforeClass; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.data.gemfire.tests.integration.ForkingClientServerIntegrationTestsSupport; +import org.springframework.test.annotation.DirtiesContext; +import org.springframework.test.context.junit4.SpringRunner; + +import javax.annotation.Resource; +import java.io.IOException; + +import static org.assertj.core.api.Assertions.assertThat; + +@RunWith(SpringRunner.class) +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.NONE, classes = TransactionalClientConfig.class) +@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS) +public class TransactionalClientTests extends ForkingClientServerIntegrationTestsSupport { + + @Autowired + private CustomerService customerService; + + @Resource(name = "Customers") + private Region customers; + + private Logger logger = LoggerFactory.getLogger(this.getClass()); + + @BeforeClass + public static void setup() throws IOException { + startGemFireServer(TransactionalServer.class); + } + + @Test + public void transactionsConfiguredCorrectly() throws InterruptedException { + + logger.info("Number of Entries stored before = " + customerService.numberEntriesStoredOnServer()); + customerService.createFiveCustomers(); + assertThat(customerService.numberEntriesStoredOnServer()).isEqualTo(5); + logger.info("Number of Entries stored after = " + customerService.numberEntriesStoredOnServer()); + logger.info("Customer for ID before (transaction commit success) = " + customerService.findById(2L).get()); + customerService.updateCustomersSuccess(); + assertThat(customerService.numberEntriesStoredOnServer()).isEqualTo(5); + Customer customer = customerService.findById(2L).get(); + assertThat(customer.getFirstName()).isEqualTo("Humpty"); + logger.info("Customer for ID after (transaction commit success) = " + customer); + + try { + customerService.updateCustomersFailure(); + } catch (IllegalArgumentException exception) { + exception.printStackTrace(); + } + + customer = customerService.findById(2L).get(); + assertThat(customer.getFirstName()).isEqualTo("Humpty"); + logger.info("Customer for ID after (transaction commit failure) = " + customerService.findById(2L).get()); + + Customer numpty = new Customer(2L, new EmailAddress("2@2.com"), "Numpty", "Hamilton"); + Customer frumpy = new Customer(2L, new EmailAddress("2@2.com"), "Frumpy", "Hamilton"); + customerService.updateCustomersWithDelay(1000, numpty); + customerService.updateCustomersWithDelay(10, frumpy); + customer = customerService.findById(2L).get(); + assertThat(customer).isEqualTo(frumpy); + logger.info("Customer for ID after 2 updates with delay = " + customer); + } +} \ No newline at end of file diff --git a/geode/transactions/src/test/resources/logback.xml b/geode/transactions/src/test/resources/logback.xml new file mode 100644 index 00000000..f3b82068 --- /dev/null +++ b/geode/transactions/src/test/resources/logback.xml @@ -0,0 +1,11 @@ + + + + %msg%n + + + + + + + \ No newline at end of file diff --git a/geode/wan/README.md b/geode/wan/README.md new file mode 100755 index 00000000..0cd8cb9d --- /dev/null +++ b/geode/wan/README.md @@ -0,0 +1,5 @@ +# WAN Event Filters Example + +In this example two servers (SiteA and SiteB) will use WAN replication to replicate data between them. The example also includes several filters that can customize the replication of data. + +NOTE: Inorder to see output, you must change the loglevel from "error" to "info" in the `logback.xml` file located under src/test/resources. \ No newline at end of file diff --git a/geode/wan/pom.xml b/geode/wan/pom.xml new file mode 100755 index 00000000..fb462688 --- /dev/null +++ b/geode/wan/pom.xml @@ -0,0 +1,23 @@ + + + + example.springdata.geode + spring-data-geode-examples + 1.0-SNAPSHOT + + 4.0.0 + + wan + example.springdata.geode.server + 1.0-SNAPSHOT + + + org.awaitility + awaitility + 3.1.6 + test + + + \ No newline at end of file diff --git a/geode/wan/src/main/java/example/springdata/geode/server/wan/event/Customer.java b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/Customer.java new file mode 100755 index 00000000..71218b19 --- /dev/null +++ b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/Customer.java @@ -0,0 +1,47 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.wan.event; + +import lombok.Data; +import org.springframework.data.annotation.Id; +import org.springframework.data.gemfire.mapping.annotation.Region; + +import java.io.Serializable; + +/** + * A customer used for Lucene examples. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +@Region(name = "Customers") +public class Customer implements Serializable { + + @Id + private Long id; + private EmailAddress emailAddress; + private String firstName; + private String lastName; + + public Customer(Long id, EmailAddress emailAddress, String firstName, String lastName) { + this.id = id; + this.emailAddress = emailAddress; + this.firstName = firstName; + this.lastName = lastName; + } +} \ No newline at end of file diff --git a/geode/wan/src/main/java/example/springdata/geode/server/wan/event/CustomerRepository.java b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/CustomerRepository.java new file mode 100755 index 00000000..f6889855 --- /dev/null +++ b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/CustomerRepository.java @@ -0,0 +1,22 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.wan.event; + +import org.springframework.data.repository.CrudRepository; + +public interface CustomerRepository extends CrudRepository { +} diff --git a/geode/wan/src/main/java/example/springdata/geode/server/wan/event/EmailAddress.java b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/EmailAddress.java new file mode 100755 index 00000000..a82a808b --- /dev/null +++ b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/EmailAddress.java @@ -0,0 +1,36 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.wan.event; + +import lombok.Data; + +import java.io.Serializable; + +/** + * Value object to represent email addresses. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Data +public class EmailAddress implements Serializable { + private String value; + + public EmailAddress(String value) { + this.value = value; + } +} \ No newline at end of file diff --git a/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/EvenNumberedKeyWanEventFilter.java b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/EvenNumberedKeyWanEventFilter.java new file mode 100755 index 00000000..5d8fb9e5 --- /dev/null +++ b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/EvenNumberedKeyWanEventFilter.java @@ -0,0 +1,39 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.wan.event.server; + +import org.apache.geode.cache.wan.GatewayEventFilter; +import org.apache.geode.cache.wan.GatewayQueueEvent; +import org.springframework.stereotype.Component; + +@Component +public class EvenNumberedKeyWanEventFilter implements GatewayEventFilter { + @Override + public boolean beforeEnqueue(GatewayQueueEvent event) { + return (Long) event.getKey() % 2 == 0; + } + + @Override + public boolean beforeTransmit(GatewayQueueEvent event) { + return true; + } + + @Override + public void afterAcknowledgement(GatewayQueueEvent event) { + + } +} diff --git a/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/WanEventSubstitutionFilter.java b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/WanEventSubstitutionFilter.java new file mode 100755 index 00000000..f3c765b5 --- /dev/null +++ b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/WanEventSubstitutionFilter.java @@ -0,0 +1,32 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.wan.event.server; + +import example.springdata.geode.server.wan.event.Customer; +import org.apache.geode.cache.EntryEvent; +import org.apache.geode.cache.wan.GatewayEventSubstitutionFilter; +import org.springframework.stereotype.Component; + +@Component +public class WanEventSubstitutionFilter implements GatewayEventSubstitutionFilter { + + @Override + public Object getSubstituteValue(EntryEvent event) { + Customer customer = event.getNewValue(); + return new Customer(customer.getId(), customer.getEmailAddress(), customer.getFirstName(), customer.getLastName().substring(0, 1)); + } +} diff --git a/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/WanServer.java b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/WanServer.java new file mode 100755 index 00000000..17eaf079 --- /dev/null +++ b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/WanServer.java @@ -0,0 +1,72 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.wan.event.server; + +import com.github.javafaker.Faker; +import com.github.javafaker.Internet; +import com.github.javafaker.Name; +import example.springdata.geode.server.wan.event.Customer; +import example.springdata.geode.server.wan.event.CustomerRepository; +import example.springdata.geode.server.wan.event.EmailAddress; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.boot.ApplicationRunner; +import org.springframework.boot.WebApplicationType; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.boot.builder.SpringApplicationBuilder; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Profile; + +import java.util.Scanner; +import java.util.stream.LongStream; + +@SpringBootApplication(scanBasePackageClasses = WanServerConfig.class) +public class WanServer { + + private Logger logger = LoggerFactory.getLogger(this.getClass()); + + public static void main(String[] args) { + new SpringApplicationBuilder(WanServer.class) + .web(WebApplicationType.NONE) + .build() + .run(args); + } + + @Bean + @Profile({"default", "SiteA"}) + public ApplicationRunner siteARunner() { + return args -> new Scanner(System.in).nextLine(); + } + + @Bean + @Profile("SiteB") + public ApplicationRunner siteBRunner(CustomerRepository customerRepository) { + return args -> { + logger.info("Inserting 300 customers"); + createCustomers(customerRepository); + }; + } + + private void createCustomers(CustomerRepository repository) { + Faker faker = new Faker(); + Name fakerName = faker.name(); + Internet fakerInternet = faker.internet(); + LongStream.range(0, 300).forEach(index -> + repository.save(new Customer(index, + new EmailAddress(fakerInternet.emailAddress()), fakerName.firstName(), fakerName.lastName()))); + } +} diff --git a/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/WanServerConfig.java b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/WanServerConfig.java new file mode 100755 index 00000000..efa23d84 --- /dev/null +++ b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/WanServerConfig.java @@ -0,0 +1,85 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.wan.event.server; + +import com.github.javafaker.Faker; +import example.springdata.geode.server.wan.event.Customer; +import example.springdata.geode.server.wan.event.CustomerRepository; +import example.springdata.geode.server.wan.event.server.siteA.SiteAWanEnabledServerConfig; +import example.springdata.geode.server.wan.event.server.siteB.SiteBWanServerConfig; +import org.apache.geode.cache.DataPolicy; +import org.apache.geode.cache.GemFireCache; +import org.apache.geode.cache.PartitionAttributes; +import org.apache.geode.cache.RegionAttributes; +import org.apache.geode.cache.wan.GatewaySender; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Import; +import org.springframework.data.gemfire.DiskStoreFactoryBean; +import org.springframework.data.gemfire.PartitionAttributesFactoryBean; +import org.springframework.data.gemfire.PartitionedRegionFactoryBean; +import org.springframework.data.gemfire.RegionAttributesFactoryBean; +import org.springframework.data.gemfire.repository.config.EnableGemfireRepositories; + +import java.io.File; +import java.util.Arrays; + +@Configuration +@EnableGemfireRepositories(basePackageClasses = CustomerRepository.class) +@Import({SiteAWanEnabledServerConfig.class, SiteBWanServerConfig.class}) +public class WanServerConfig { + @Bean + Faker faker() { + return new Faker(); + } + + @Bean(name = "DiskStore") + DiskStoreFactoryBean diskStore(GemFireCache gemFireCache, Faker faker) { + final DiskStoreFactoryBean diskStoreFactoryBean = new DiskStoreFactoryBean(); + final boolean completed = new File("/tmp/" + faker.name().firstName()).mkdirs(); + final DiskStoreFactoryBean.DiskDir[] diskDirs = {new DiskStoreFactoryBean.DiskDir("/tmp/" + faker.name().firstName())}; + diskStoreFactoryBean.setDiskDirs(Arrays.asList(diskDirs)); + diskStoreFactoryBean.setCache(gemFireCache); + return diskStoreFactoryBean; + } + + @Bean + RegionAttributesFactoryBean regionAttributes(PartitionAttributes partitionAttributes) { + final RegionAttributesFactoryBean regionAttributesFactoryBean = new RegionAttributesFactoryBean<>(); + regionAttributesFactoryBean.setPartitionAttributes(partitionAttributes); + return regionAttributesFactoryBean; + } + + @Bean + PartitionAttributesFactoryBean partitionAttributes() { + final PartitionAttributesFactoryBean partitionAttributesFactoryBean = new PartitionAttributesFactoryBean<>(); + partitionAttributesFactoryBean.setTotalNumBuckets(13); + partitionAttributesFactoryBean.setRedundantCopies(0); + return partitionAttributesFactoryBean; + } + + @Bean("Customers") + PartitionedRegionFactoryBean createCustomerRegion(GemFireCache gemFireCache, RegionAttributes regionAttributes, GatewaySender gatewaySender) { + final PartitionedRegionFactoryBean partitionedRegionFactoryBean = new PartitionedRegionFactoryBean<>(); + partitionedRegionFactoryBean.setCache(gemFireCache); + partitionedRegionFactoryBean.setRegionName("Customers"); + partitionedRegionFactoryBean.setDataPolicy(DataPolicy.PARTITION); + partitionedRegionFactoryBean.setAttributes(regionAttributes); + partitionedRegionFactoryBean.setGatewaySenders(new GatewaySender[]{gatewaySender}); + return partitionedRegionFactoryBean; + } +} diff --git a/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/WanTransportEncryptionListener.java b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/WanTransportEncryptionListener.java new file mode 100755 index 00000000..c26ec499 --- /dev/null +++ b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/WanTransportEncryptionListener.java @@ -0,0 +1,48 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.wan.event.server; + +import org.apache.geode.cache.wan.GatewayTransportFilter; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.stereotype.Component; + +import java.io.InputStream; +import java.io.OutputStream; +import java.util.zip.Adler32; +import java.util.zip.CheckedInputStream; +import java.util.zip.CheckedOutputStream; + +@Component +public class WanTransportEncryptionListener implements GatewayTransportFilter { + + private final Adler32 CHECKER = new Adler32(); + + private Logger logger = LoggerFactory.getLogger(this.getClass()); + + @Override + public InputStream getInputStream(InputStream stream) { + logger.info("CheckedTransportFilter: Getting input stream"); + return new CheckedInputStream(stream, CHECKER); + } + + @Override + public OutputStream getOutputStream(OutputStream stream) { + logger.info("CheckedTransportFilter: Getting output stream"); + return new CheckedOutputStream(stream, CHECKER); + } +} \ No newline at end of file diff --git a/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/siteA/SiteAWanEnabledServerConfig.java b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/siteA/SiteAWanEnabledServerConfig.java new file mode 100755 index 00000000..70716434 --- /dev/null +++ b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/siteA/SiteAWanEnabledServerConfig.java @@ -0,0 +1,57 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.wan.event.server.siteA; + +import org.apache.geode.cache.Cache; +import org.apache.geode.cache.GemFireCache; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.DependsOn; +import org.springframework.context.annotation.Profile; +import org.springframework.data.gemfire.config.annotation.CacheServerApplication; +import org.springframework.data.gemfire.config.annotation.EnableGemFireProperties; +import org.springframework.data.gemfire.config.annotation.EnableLocator; +import org.springframework.data.gemfire.wan.GatewayReceiverFactoryBean; +import org.springframework.data.gemfire.wan.GatewaySenderFactoryBean; + +@Configuration +@CacheServerApplication(port = 0, locators = "localhost[10334]", name = "SiteA_Server", logLevel = "error") +@Profile({"default", "SiteA"}) +@EnableLocator +@EnableGemFireProperties(distributedSystemId = 1, remoteLocators = "localhost[20334]") +public class SiteAWanEnabledServerConfig { + @Bean + GatewayReceiverFactoryBean createGatewayReceiver(GemFireCache gemFireCache) { + final GatewayReceiverFactoryBean gatewayReceiverFactoryBean = new GatewayReceiverFactoryBean((Cache) gemFireCache); + gatewayReceiverFactoryBean.setStartPort(15000); + gatewayReceiverFactoryBean.setEndPort(15010); + gatewayReceiverFactoryBean.setManualStart(false); + return gatewayReceiverFactoryBean; + } + + @Bean + @DependsOn("DiskStore") + GatewaySenderFactoryBean createGatewaySender(GemFireCache gemFireCache) { + final GatewaySenderFactoryBean gatewaySenderFactoryBean = new GatewaySenderFactoryBean(gemFireCache); + gatewaySenderFactoryBean.setBatchSize(15); + gatewaySenderFactoryBean.setBatchTimeInterval(1000); + gatewaySenderFactoryBean.setRemoteDistributedSystemId(2); + gatewaySenderFactoryBean.setPersistent(false); + gatewaySenderFactoryBean.setDiskStoreRef("DiskStore"); + return gatewaySenderFactoryBean; + } +} \ No newline at end of file diff --git a/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/siteB/SiteBWanServerConfig.java b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/siteB/SiteBWanServerConfig.java new file mode 100755 index 00000000..ade0aaa9 --- /dev/null +++ b/geode/wan/src/main/java/example/springdata/geode/server/wan/event/server/siteB/SiteBWanServerConfig.java @@ -0,0 +1,71 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.wan.event.server.siteB; + +import example.springdata.geode.server.wan.event.Customer; +import example.springdata.geode.server.wan.event.server.EvenNumberedKeyWanEventFilter; +import example.springdata.geode.server.wan.event.server.WanEventSubstitutionFilter; +import example.springdata.geode.server.wan.event.server.WanTransportEncryptionListener; +import org.apache.geode.cache.Cache; +import org.apache.geode.cache.GemFireCache; +import org.apache.geode.cache.wan.GatewayEventFilter; +import org.apache.geode.cache.wan.GatewayEventSubstitutionFilter; +import org.apache.geode.cache.wan.GatewayTransportFilter; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.DependsOn; +import org.springframework.context.annotation.Import; +import org.springframework.context.annotation.Profile; +import org.springframework.data.gemfire.config.annotation.CacheServerApplication; +import org.springframework.data.gemfire.config.annotation.EnableGemFireProperties; +import org.springframework.data.gemfire.config.annotation.EnableLocator; +import org.springframework.data.gemfire.wan.GatewayReceiverFactoryBean; +import org.springframework.data.gemfire.wan.GatewaySenderFactoryBean; + +import java.util.Collections; + +@Configuration +@CacheServerApplication(port = 0, locators = "localhost[20334]", name = "SiteB_Server", logLevel = "error") +@Profile("SiteB") +@EnableLocator(port = 20334) +@EnableGemFireProperties(distributedSystemId = 2, remoteLocators = "localhost[10334]") +@Import({EvenNumberedKeyWanEventFilter.class, WanEventSubstitutionFilter.class, WanTransportEncryptionListener.class}) +public class SiteBWanServerConfig { + @Bean + GatewayReceiverFactoryBean createGatewayReceiver(GemFireCache gemFireCache) { + final GatewayReceiverFactoryBean gatewayReceiverFactoryBean = new GatewayReceiverFactoryBean((Cache) gemFireCache); + gatewayReceiverFactoryBean.setStartPort(25000); + gatewayReceiverFactoryBean.setEndPort(25010); + return gatewayReceiverFactoryBean; + } + + @Bean + @DependsOn("DiskStore") + GatewaySenderFactoryBean createGatewaySender(GemFireCache gemFireCache, GatewayEventFilter gatewayEventFilter, + GatewayTransportFilter gatewayTransportFilter, GatewayEventSubstitutionFilter gatewayEventSubstitutionFilter) { + final GatewaySenderFactoryBean gatewaySenderFactoryBean = new GatewaySenderFactoryBean(gemFireCache); + gatewaySenderFactoryBean.setBatchSize(15); + gatewaySenderFactoryBean.setBatchTimeInterval(1000); + gatewaySenderFactoryBean.setRemoteDistributedSystemId(1); + gatewaySenderFactoryBean.setDiskStoreRef("DiskStore"); + gatewaySenderFactoryBean.setEventFilters(Collections.singletonList(gatewayEventFilter)); + gatewaySenderFactoryBean.setTransportFilters(Collections.singletonList(gatewayTransportFilter)); + gatewaySenderFactoryBean.setEventSubstitutionFilter(gatewayEventSubstitutionFilter); + gatewaySenderFactoryBean.setPersistent(false); + return gatewaySenderFactoryBean; + } +} \ No newline at end of file diff --git a/geode/wan/src/test/java/example/springdata/geode/server/wan/event/WanServerTests.java b/geode/wan/src/test/java/example/springdata/geode/server/wan/event/WanServerTests.java new file mode 100755 index 00000000..2db64de5 --- /dev/null +++ b/geode/wan/src/test/java/example/springdata/geode/server/wan/event/WanServerTests.java @@ -0,0 +1,67 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.wan.event; + +import example.springdata.geode.server.wan.event.client.WanClientConfig; +import example.springdata.geode.server.wan.event.server.WanServer; +import org.apache.geode.cache.Region; +import org.awaitility.Awaitility; +import org.junit.BeforeClass; +import org.junit.Ignore; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.data.gemfire.tests.integration.ForkingClientServerIntegrationTestsSupport; +import org.springframework.test.annotation.DirtiesContext; +import org.springframework.test.context.junit4.SpringRunner; + +import javax.annotation.Resource; +import java.io.IOException; +import java.util.concurrent.TimeUnit; + +import static org.assertj.core.api.Assertions.assertThat; + +@RunWith(SpringRunner.class) +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.NONE, classes = WanClientConfig.class) +@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS) +public class WanServerTests extends ForkingClientServerIntegrationTestsSupport { + + @Resource(name = "Customers") + private Region customers; + + private Logger logger = LoggerFactory.getLogger(this.getClass()); + + @BeforeClass + public static void setup() throws IOException { + startGemFireServer(WanServer.class, "-Dspring.profiles.active=SiteB"); + startGemFireServer(WanServer.class, "-Dspring.profiles.active=SiteA"); + System.getProperties().remove("spring.data.gemfire.pool.servers"); + } + + @Test + @Ignore + public void wanReplicationOccursCorrectly() { + Awaitility.await().atMost(10, TimeUnit.SECONDS).until(() -> customers.keySetOnServer().size() == 150); + assertThat(customers.keySetOnServer().size()).isEqualTo(150); + logger.info(customers.keySetOnServer().size() + " entries replicated to siteA"); + + customers.getAll(customers.keySetOnServer()).forEach((key, value) -> assertThat(value.getLastName().length()).isEqualTo(1)); + logger.info("All customers' last names changed to last initial on siteA"); + } +} diff --git a/geode/wan/src/test/java/example/springdata/geode/server/wan/event/client/WanClientConfig.java b/geode/wan/src/test/java/example/springdata/geode/server/wan/event/client/WanClientConfig.java new file mode 100755 index 00000000..a522baeb --- /dev/null +++ b/geode/wan/src/test/java/example/springdata/geode/server/wan/event/client/WanClientConfig.java @@ -0,0 +1,61 @@ +/* + * Copyright 2020 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 + * + * https://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 example.springdata.geode.server.wan.event.client; + +import example.springdata.geode.server.wan.event.Customer; +import example.springdata.geode.server.wan.event.CustomerRepository; +import org.apache.geode.cache.GemFireCache; +import org.apache.geode.cache.client.ClientRegionShortcut; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.data.gemfire.client.ClientRegionFactoryBean; +import org.springframework.data.gemfire.config.annotation.ClientCacheApplication; +import org.springframework.data.gemfire.config.annotation.ClientCacheConfigurer; +import org.springframework.data.gemfire.repository.config.EnableGemfireRepositories; +import org.springframework.data.gemfire.support.ConnectionEndpoint; + +import java.util.Collections; + +/** + * Spring JavaConfig configuration class to setup a Spring container and infrastructure components. + * + * @author Udo Kohlmeyer + * @author Patrick Johnson + */ +@Configuration +@EnableGemfireRepositories(basePackageClasses = CustomerRepository.class) +@ClientCacheApplication(name = "WanClient", logLevel = "error", pingInterval = 5000L, readTimeout = 15000, retryAttempts = 1) +public class WanClientConfig { + @Bean("Customers") + protected ClientRegionFactoryBean configureProxyClientCustomerRegion(GemFireCache gemFireCache) { + ClientRegionFactoryBean clientRegionFactoryBean = new ClientRegionFactoryBean<>(); + clientRegionFactoryBean.setCache(gemFireCache); + clientRegionFactoryBean.setName("Customers"); + clientRegionFactoryBean.setShortcut(ClientRegionShortcut.PROXY); + return clientRegionFactoryBean; + } + + @Bean + ClientCacheConfigurer clientCacheServerConfigurer( + @Value("${spring.data.geode.locator.host:localhost}") String hostname, + @Value("${spring.data.geode.locator.port:10334}") int port) { + + return (beanName, clientCacheFactoryBean) -> clientCacheFactoryBean.setLocators(Collections.singletonList( + new ConnectionEndpoint(hostname, port))); + } +} diff --git a/geode/wan/src/test/resources/logback.xml b/geode/wan/src/test/resources/logback.xml new file mode 100644 index 00000000..f3b82068 --- /dev/null +++ b/geode/wan/src/test/resources/logback.xml @@ -0,0 +1,11 @@ + + + + %msg%n + + + + + + + \ No newline at end of file diff --git a/pom.xml b/pom.xml index 5f6e4ed6..50adabf9 100644 --- a/pom.xml +++ b/pom.xml @@ -19,6 +19,7 @@ bom couchbase elasticsearch + geode jdbc jpa ldap