Configuration for Java EE and the Cloud

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |
Configuration for Java EE
and the Cloud
Dmitry Kornilov
dmitry.kornilov@oracle.com
@m0mus
September 21, 2016

Safe Harbor Statement
The following is intended to outline our general product direction. It is intended for
information purposes only, and may not be incorporated into any contract. It is not a
commitment to deliver any material, code, or functionality, and should not be relied upon
in making purchasing decisions. The development, release, and timing of any features or
functionality described for Oracle’s products remains at the sole discretion of Oracle.
2

Program Agenda
Introduction
Problem Definition
JSR Proposal & Features
Sample Use Case
Q & A
1
2
3
4
3
5

Introduction
4

History & Introduction
• 2003 – Apache Commons Configuration
• 2009 – Spring 3.0
• 2011 – Apache DeltaSpike
• 2013 – Mike Keith on JavaOne
• 2014 – Java EE 8 Survey
• 2014 – Netflix Archaius
• 2015 – Attempt to submit a JSR
• 2015 – Apache Tamaya
5

• 2009 – Spring 3.0
6

• 2009 – Spring 3.0
7

• 2009 – Spring 3.0
8

• 2009 – Spring 3.0
9

• 2009 – Spring 3.0
10

• 2009 – Spring 3.0
11

• 2009 – Spring 3.0
12

• 2009 – Spring 3.0
• 2013 – Mike Keith at JavaOne
13

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 14
DZone and Java EE Guardians Survey Results

Problem Definition
15

What is Configuration?
16
Application server setup?
Runtime parameters?
Deployment descriptors?
Parameters of used frameworks?
Deployment scripts? Used resources?

Problems
• Lack of standard configuration API
• Configuring multiple instances
• Deploying on different environments
• Change configuration without
redeployment
• Configuration of decoupled
microservices
17

Problems
redeployment
microservices
18

Problems
redeployment
microservices
19

Problems
redeployment
microservices
20

Problems
redeployment
microservices
21

JSR Proposal
22

Configuration Definition
• Application centric
• Not modifiable by application
• Consists of key/value pairs
• Keys and values are strings
• Flat structure
23

Java EE Configuration
• Unified API
• Externalized configuration
• Support of multiple configuration sources
– Properties, xml and json formats support out of the box
• Layering and overrides
• Optional configuration descriptor
• Dynamic configuration
• Integration with other Java EE frameworks
24

Java EE Configuration
• Unified API
• Externalized configuration
• Support of multiple configuration sources
– Properties, xml and json formats support out of the box
• Layering and overrides
25
Java EE 8
• Optional configuration descriptor
• Dynamic configuration
• Integration with other Java EE frameworks
Java EE Next

Roadmap
26
Submit JSR
Review JSR
Expert Group Formation
Sep
2016
Oct
2016
Nov
2016
Dec
2016
Jan
2017
Feb
2017
Mar
2017
Apr
2017
May
2017
June
2017
July
2017
Aug
2017
Sep
2017
Early Draft
Public Draft
Proposed
Final Draft
Final Release

JSR Features (Java EE 8)
27

API
28
a=JavaOne
b=9
c=2016
Config config = ConfigProvider.getConfig();
// Returns "JavaOne"
String foo = config.getProperty("a");
// Returns string "9"
String fooBar = config.getProperty("b");
// Returns null
String notExists = config.getProperty("not.exist");
// Returns string "default"
String notExistsDefault = config.getProperty("not.exist","default");
// Returns number 2016
Long fooBarBaz = config.getProperty("c", Long.class);

Converters
29
• Type safe access to values
• Built-in converters for:
– Primitive Wrappers
– BigDecimal, BigInteger, URL, URI
– Date, Calendar
– java.time.*
public interface Converter<Target> {
Target convert(String value);
}
public class FooConverter
implements Converter<Foo> {
public Foo convert(String value) {
...
}
}
Config cfg = ConfigProvider.builder()
.withConverters(new FooConverter())
.build();
Foo foo = cfg.getProperty("foo", Foo.class);

Configuration Sources
30
• Multiple configuration sources
• Supported configuration sources:
– System properties
– Runtime parameters
– File (Properties, xml, json)
– Resource on a web server
• Pluggable architecture
– Custom sources (like DB)
• Configuration sources are ordered
Java EE
Config
XML JSONprop
DBweb
Application

Layering and Overrides
31

Default Configuration Sources
32
Java EE Config
• System properties (ordinal=400)
• Environment properties (ordinal=300)
• /META-INF/config.properties (ordinal=100)
• /META-INF/config.xml (ordinal=100)
• /META-INF/config.json (ordinal=100)

Defining Configuration Sources
33
• Using config.sources runtime parameter
• Using API
• Using config-sources.xml file

Customizing Configuration Sources
34
Using config.sources runtime parameter
# Single file source with default ordinal (200)
java –jar my.jar –Dconfig.source=/conf/myconfig.properties
# Web source with default ordinal (200)
java –jar my.jar –Dconfig.source=http://shared/global.xml
# Two sources. Ordinals are 200 and 199
java –jar my.jar –Dconfig.source=http://shared/global.xml,/conf/my.json

Customizing Configuration Sources
35
Using API
Config config = ConfigProvider.builder()
.addSource(new EnvSource(), 300)
.addSource(new FileSource("/cfg/config.properties"), 200)
.addSource(new WebSource("http://localhost:8080/config.xml"), 100)
.addSource(new MyCustomSource())
.build();

config-sources.xml
36
• File with defined schema using to define configuration sources and their
metadata
• Default location /META-INF/config-sources.xml
• Can be placed outside of the application package
• Define using runtime parameter
• Define using API
java –jar my.jar –Dconfig.sources=http://sharedhost/config-sources.xml
Config c = ConfigProvider.builder()
.withSources("/cfg/config-sources.xml")
.build();

Sample config-sources.xml
37
Simple
With ordinals
<config-sources>
<source>http://shared:8080/config.xml</source>
<source>/cfg/myconf.json</source>
</config-sources>
<config-sources>
<source ordinal="500">http://shared:8080/config.xml</source>
<source ordinal="450">/cfg/myconf.json</source>
</config-sources>

Sample config-sources.xml
38
Custom
<config-sources>
<source>http://shared:8080/config.xml</source>
<source type="com.oracle.config.CloudConfig">
<user>user</user>
<password>secret</password>
</source>
</config-sources>

JSR Features (Java EE Next)
39

Integration With Other Java EE Frameworks
• Read configuration from
Java EE Config
• Store configuration as part of
whole application configuration
• Use standard API
40
Java EE
Config
Application
Configuration
Application
JPA
Configuration
JAX-RS
Configuration

Configuration Descriptor
41
• File with defined format
• Defines all configurable properties
and metadata
• Optional
• It’s not XML-Schema!
<config-descriptor>
<property name="a"/>
<property name="b" default=”valueB"/>
<property name="c" mutable="false"/>
<property name="d"/>
</config-descriptor>

Immutability
42
Mutable Immutable

Dynamic Configuration
43
• Polling framework
• Expressions
• Property Resolvers
• Configuration Context

Polling
44
// Defining polling using API
.withSource(new FileSource("/cfg/config.xml"), 200, Duration.ofSeconds(30))
.withSource(new WebSource("http://shared/config.xml"), 100, Duration.ofMinutes(1))
.build();

Polling
45
// Defining polling using API
.withSource(new FileSource("/cfg/config.xml"), 200, Duration.ofSeconds(30))
.withSource(new WebSource("http://shared/config.xml"), 100, Duration.ofMinutes(1))
.build();
Ordinal Refresh IntervalLocation

Polling
46
<config-sources refresh-rate="300000">
<source ordinal="200" refresh-rate="30000">/cfg/config.xml</source>
<source ordinal="100" refresh-rate="60000">http://shared/config.xml</source>
</config-sources>

Polling
47
<config-sources refresh-rate="300000">
<source ordinal="200" refresh-rate="30000">/cfg/config.xml</source>
<source ordinal="100" refresh-rate="60000">http://shared/config.xml</source>
</config-sources>
Sources list
refresh interval
(5 min)
Source 1 refresh
interval (30 sec) Source 2 refresh
interval (1 min)

Expressions
48
• EL like expressions evaluated at runtime to a property value
• Property substitution
• Conditional configuration sources
foo=${some.other.value}
bar=${foo + 10}
baz=${foo * bar}
<config-sources>
<source>//cfg/config.properties</source>
<source enabled=”${app==‘ios’}”>
//cfg/cust_ios.properties
</source>
</config-sources>

Property Resolvers
49
• Flexible mechanism allowing
executing user code in configuration
expressions
• Can be used to inject cloud
resources
rating.service.url=${eureka:rating.url}
cust.db=${cloud:cust.db}
<config-sources>
<resolvers>
<resolver name=”cloud”>
<class>com.example.CloudResolver</class>
<username>user</username>
<password>secret</password>
</resolver>
</resolvers>

</config-sources>

Configuration Context
50
• Allows application setting variables which can be used in configuration
expressions
• Example: geographical zone, application type, etc.
<config-sources>
<source>//cfg/config.properties</source>
<source enabled=”${app==‘ios’}”>
</source>
</config-sources>
Config config = ConfigProvider.getConfig();
ConfigContext context = ConfigContext.builder().addProperty("app", "ios").build();
Long prop = config.getPropertyWithContext("prop", context);

Sample Use Case
51

Blacklist Service
Financial Records
Service
Public
Registry
DBBlacklist Service
Financial Records
Service
Public
Registry
DB
Client Rating
Confidential – Oracle Internal/Restricted/Highly Restricted 52
Customer
Service
Rating Service
• https://github.com/psplinakis/ClientRating
• Consists of 4 microservices communicating to each other using RESTful API
• Each microservice is developed by different team which define its
configuration and responsible for its deployment
DB

Client Rating
Customer
Service
Rating ServiceDB
GET http://custhost/custservice/web/getCustomers
[
{cust_id: 1, rating: 9},
{cust_id: 2, rating: 5}
]
GET http://ratinghost/ratingservice/getRating/1
rating: 9

Client Rating
cust-db
rating-url
records-count
log-level
blacklist-url
findata-url
log-level
Customer
Service
Rating ServiceDB

Client Rating
<config-descriptor>
<context-property name=”app”/>
<property name=”cust-db” mutable="false"/>
<property name=”rating-url"/>
<property name=”records-count" default=”100"/>
<property name=”log-level" default=”INFO"/>
<config-descriptor>
<property name=”blacklist-url”/>
<property name=”findata-url"/>
Customer
Service
Rating ServiceDB

Client Rating
<config-descriptor>
<context-property name=”app”/>
<property name=”cust-db” mutable="false"/>
<property name=”rating-url"/>
<property name=”records-count" default=”100"/>
<config-descriptor>
<property name=”blacklist-url”/>
<property name=”findata-url"/>
cust-db=mysql://dbhost:3306/cust_db
rating-url=http://ratinghost/ratingservice"
blacklist-url=http://blhost/blservice
findata-url=http://findatahost/ratingservice
log-level=INFO
records-count=30
log-level=WARN
Global configuration (global.properties)
Microservice configuration (cust_svc.properties) Microservice configuration (rating_svc.properties)
Override only for iOS application (cust_ios.properties)

Client Rating
<config-sources>
<source refresh-rate=”6000” enabled=”${app==‘ios’}”>
</source>
<source>
//cfg/cust_svc.properties
</source>
<source refresh-rate=”6000”>
http://globalhost/global.properties
</source>
</config-sources>
<config-sources>
<source>
//cfg/rating_svc.properties
</source>
<source refresh-rate=”6000”>
http://globalhost/global.properties
</source>
</config-sources>
Customer
Service
Rating ServiceDB

Client Rating
global.properties rating_svc.propertiescust_svc.propertiescust_ios.properties
Customer
Service
Rating ServiceDB

Cloud Configuration Service Idea
Customer
Service
Rating Service
DB

Cloud Configuration Service
60
• Service in the cloud
• Distributed and high-available
configuration storage
• Pluggable to Java EE Config
• Integration with other cloud services
• REST and web API
• Versioning, history, security
Customer
Service
Rating Service
DB

Next Steps
• Take the survey
– http://glassfish.org/survey
• Send technical comments to
– users@javaee-spec.java.net
• Join the JCP – come to Hackergarden in Java Hub
– https://jcp.org/en/participation/membership_drive
• Join or track the JSRs as they progress
– https://java.net/projects/javaee-spec/pages/Specifications
• Adopt-a-JSR
– https://community.oracle.com/community/java/jcp/adopt-a-jsr
Give us your feedback
61

Where to Learn More at JavaOne
62
Session Number Session Title Day / Time
CON7977 Java EE Next – HTTP/2 and REST Wednesday 1:00 p.m.
CON6077 The Illusion of Statelessness Wednesday 4:30 p.m.
CON 7981 JSF 2.3 Thursday 11:30 a.m.

Q & A
63

Configuration for Java EE and the Cloud

Configuration for Java EE and the Cloud

More Related Content

What's hot

Viewers also liked

Similar to Configuration for Java EE and the Cloud

More from Dmitry Kornilov

Recently uploaded

Configuration for Java EE and the Cloud