News from the Software Smithy: Version 2.0 released

SoftSmithy news: after the release v1.1.1 last year (I didn't blog about it), I've recently released the version v2.0 of the SoftSmithy Utility Library and the SoftSmithy Development Utility Library.

As announced in the blog post about the release v1.0, v2.0 is still based on Java SE 8, but requires JUnit 5 when working with the JUnit helper classes.

This release also introduces an intitial version of the new Context Property Framework, which allows to access properties in a type-safe way accross mulitple map-like contexts.

The newly added ThreadLocalStorage allows to store properties in a ThreadLocal storage and can be used together with the new Context Property Framework.

view plainprint?

1. // given the following foo property with name "foo" and type "Foo".  
2. public static final ContextProperty<Foo> FOO_PROPERTY = new ContextProperty<>("foo", Foo.class);  
3.   
4. [...]  
5.   
6. // and given some map-like contexts like    
7. Map<String, Object> someContextMap = ...;  
8. HttpServletRequest httpServletRequest = ...; // Java EE / Spring MVC  
9. WebTarget someWebTarget = ...; // JAX-RS WebTarget  
10. ClientRequestContext someClientRequestContext = ... ; // JAX-RS ClientRequestContext  
11. // ThreadLocalStorage  
12.   
13. // instead of the following read operations:  
14. Foo foo = (Foo) someContextMap.get("foo");  
15. // or  
16. Foo foo = (Foo) httpServletRequest.getAttribute("foo");  
17. // or  
18. Foo foo = (Foo) someClientRequestContext.getProperty("foo");  
19. // or  
20. Foo foo = (Foo) ThreadLocalStorage.getPropertyValue("foo");  
21.   
22. // with the Context Property Framework you can now access the properties without duplicating the name and type (casting):  
23. Foo foo = FOO_PROPERTY.getValue(someContextMap::get);  
24. // or  
25. Foo foo = FOO_PROPERTY.getValue(httpServletRequest::getAttribute);  
26. // or  
27. Foo foo = FOO_PROPERTY.getValue(someClientRequestContext::getProperty);  
28. // or  
29. Foo foo = FOO_PROPERTY.getValue(ThreadLocalStorage::getPropertyValue);  
30.   
31. // there are similar operations for writing property values:  
32. Foo foo = ...;  
33. FOO_PROPERTY.setValue(someContextMap::put, foo);  
34. FOO_PROPERTY.setValue(httpServletRequest::setAttribute, foo);  
35. FOO_PROPERTY.setValue(someWebTarget::property, foo);  
36. FOO_PROPERTY.setValue(someClientRequestContext::setProperty, foo);  
37. FOO_PROPERTY.setValue(ThreadLocalStorage::setPropertyValue, foo);  
38.   
39. // and remove operations  
40. FOO_PROPERTY.removeProperty(someContextMap::remove);  
41. FOO_PROPERTY.removeProperty(httpServletRequest::removeAttribute);  
42. FOO_PROPERTY.removeProperty(someClientRequestContext::removeProperty);  
43. FOO_PROPERTY.removeProperty(ThreadLocalStorage::removeProperty);  

// given the following foo property with name "foo" and type "Foo". public static final ContextProperty<Foo> FOO_PROPERTY = new ContextProperty<>("foo", Foo.class); [...] // and given some map-like contexts like Map<String, Object> someContextMap = ...; HttpServletRequest httpServletRequest = ...; // Java EE / Spring MVC WebTarget someWebTarget = ...; // JAX-RS WebTarget ClientRequestContext someClientRequestContext = ... ; // JAX-RS ClientRequestContext // ThreadLocalStorage // instead of the following read operations: Foo foo = (Foo) someContextMap.get("foo"); // or Foo foo = (Foo) httpServletRequest.getAttribute("foo"); // or Foo foo = (Foo) someClientRequestContext.getProperty("foo"); // or Foo foo = (Foo) ThreadLocalStorage.getPropertyValue("foo"); // with the Context Property Framework you can now access the properties without duplicating the name and type (casting): Foo foo = FOO_PROPERTY.getValue(someContextMap::get); // or Foo foo = FOO_PROPERTY.getValue(httpServletRequest::getAttribute); // or Foo foo = FOO_PROPERTY.getValue(someClientRequestContext::getProperty); // or Foo foo = FOO_PROPERTY.getValue(ThreadLocalStorage::getPropertyValue); // there are similar operations for writing property values: Foo foo = ...; FOO_PROPERTY.setValue(someContextMap::put, foo); FOO_PROPERTY.setValue(httpServletRequest::setAttribute, foo); FOO_PROPERTY.setValue(someWebTarget::property, foo); FOO_PROPERTY.setValue(someClientRequestContext::setProperty, foo); FOO_PROPERTY.setValue(ThreadLocalStorage::setPropertyValue, foo); // and remove operations FOO_PROPERTY.removeProperty(someContextMap::remove); FOO_PROPERTY.removeProperty(httpServletRequest::removeAttribute); FOO_PROPERTY.removeProperty(someClientRequestContext::removeProperty); FOO_PROPERTY.removeProperty(ThreadLocalStorage::removeProperty);
This very small framework is especially useful when you have to pass around properties e.g. from / to filters and interceptors which use different APIs to manage context properties.

Note that for easier version management the version of the SoftSmithy Development Utility Library is aligned with the version of the SoftSmithy Utility Library. As the SoftSmithy Development Utility Library has a dependency on the SoftSmithy Utility Library it's recommended to use the same version of both libraries!

view plainprint?

1. <dependencyManagement>  
2.     <dependencies>  
3.         [...]   
4.         <dependency>  
5.             <groupId>org.softsmithy.lib</groupId>  
6.             <artifactId>softsmithy-lib</artifactId>  
7.             <version>2.0</version>  
8.             <scope>import</scope>  
9.             <type>pom</type>  
10.         </dependency>  
11.         [...]  
12.     </dependencies>  
13. </dependencyManagement>  

<dependencyManagement> <dependencies> [...] <dependency> <groupId>org.softsmithy.lib</groupId> <artifactId>softsmithy-lib</artifactId> <version>2.0</version> <scope>import</scope> <type>pom</type> </dependency> [...] </dependencies> </dependencyManagement>

You can find the latest Javadoc here: Javadoc

I deployed the artifacts (including the source and javadoc artifacts) to Maven Central.