Configuration for Java EE and the Cloud

Dmitry Kornilov

dmitry.kornilov@oracle.com@m0mus

September 21, 2016

Safe Harbor StatementThe 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.

Program Agenda

Introduction

Problem Definition

JSR Proposal & Features

Sample Use Case

Introduction

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

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

DZone and Java EE Guardians Survey Results

Problem Definition

What is Configuration?

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

JSR Proposal

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

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

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

Java EE 8

• Optional configuration descriptor• Dynamic configuration• Integration with other Java EE frameworks

Java EE Next

Roadmap

Submit JSR

Review JSRExpert Group Formation

Sep 2016

Oct2016

Nov2016

Dec2016

Jan2017

Feb2017

Mar2017

Apr2017

May2017

June2017

July2017

Aug2017

Sep2017

Early Draft

Public Draft

Proposed Final Draft

Final Release

JSR Features (Java EE 8)

a=JavaOneb=9c=2016

Config config = ConfigProvider.getConfig();

// Returns "JavaOne"String foo = config.getProperty("a");

// Returns string "9"String fooBar = config.getProperty("b");

// Returns nullString notExists = config.getProperty("not.exist");

// Returns string "default"String notExistsDefault = config.getProperty("not.exist","default");

// Returns number 2016Long fooBarBaz = config.getProperty("c", Long.class);

Converters• 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• 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

Application

Layering and Overrides

Default Configuration Sources

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• Using config.sources runtime parameter• Using API• Using config-sources.xml file

Customizing Configuration SourcesUsing 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 199java –jar my.jar –Dconfig.source=http://shared/global.xml,/conf/my.json

Customizing Configuration SourcesUsing APIConfig 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• 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 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 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)

Integration With Other Java EE Frameworks• Read configuration from

Java EE Config• Store configuration as part of

whole application configuration• Use standard API Java EE

Config

ApplicationConfiguration

Application

JPAConfiguration

JAX-RSConfiguration

Configuration Descriptor• 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>

ImmutabilityMutable Immutable

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

Polling

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

Polling

// Defining polling using APIConfig cfg = ConfigProvider.builder() .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

<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

<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• 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• 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• 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’}”> //cfg/cust_ios.properties </source> </config-sources>

Config config = ConfigProvider.getConfig();ConfigContext context = ConfigContext.builder().addProperty("app", "ios").build(); Long prop = config.getPropertyWithContext("prop", context);

Sample Use Case

Blacklist Service

Financial Records Service

Public Registry

DBBlacklist Service

Financial Records Service

Public Registry

Client Rating

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

Client RatingCustomer

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-dbrating-url records-countlog-level

blacklist-urlfindata-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>

<config-descriptor> <property name=”blacklist-url”/> <property name=”findata-url"/> <property name=”log-level" default=”INFO"/> </config-descriptor>

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>

<config-descriptor> <property name=”blacklist-url”/> <property name=”findata-url"/> <property name=”log-level" default=”INFO"/> </config-descriptor>

cust-db=mysql://dbhost:3306/cust_dbrating-url=http://ratinghost/ratingservice"

blacklist-url=http://blhost/blservicefindata-url=http://findatahost/ratingservicelog-level=INFO

records-count=30

log-level=WARNGlobal 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’}”> //cfg/cust_ios.properties </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>

Client Rating

global.properties rating_svc.propertiescust_svc.propertiescust_ios.properties

Cloud Configuration Service IdeaCustomer

Service Rating Service

Cloud Configuration Service• 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

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

Where to Learn More at JavaOneSession 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.

Configuration for Java EE and the Cloud

Software

Java EE 7: Whats New in the Java EE Platform @ Devoxx 2013

Modern Java EE Design Patterns - pepa.holla.czpepa.holla.cz/.../uploads/2016/10/modern-java-ee-design-patterns.pdf · Markus Eisele Modern Java EE Design Patterns Building Scalable

JBoss Users & Developers Conference Boston:2010 · • Tech Deep Dive • Conclusion. Java EE 6: Goals ... Java EE 6: Newcomers • Servlet 3.0 • Easier configuration • JPA 2.0

Java EE and EJBs - UPapm/TDIN/docs/09ejbs.pdf · Java EE and EJBs Distributed Components in Java APM@FEUP. JavaEE and EJBs 2 General architecture of Java EE Java EE –Framework for

Java EE Training

Java EE | Clean Code and Java EE 6 | Adam Bien

What is tackled in the Java EE Security API (Java EE 8)

Java EE 7: Developing for the Cloud Arun Gupta, Java EE & GlassFish Guy

Java EE Next

JAVA EE Productiv JAVA EE Productivity Report 2011

Java EE EJB Applications

Java EE Programming

Java EE 101

Down and Dirty with Java EE 7 - Jfokus and Dirty with Java EE 7 Reza Rahman Java EE/GlassFish Evangelist Reza.Rahman@Oracle.com @reza_rahman

Java EE 6 Detail

Configuration beyond Java EE 8

Java SE 8 for Java EE developers

Topic Java EE installation (Eclipse, glassfish, etc.) Eclipse configuration for EE Creating a Java Web Dynamic Project Creating your first servlet

Java EE 6 Update - JUG EE is pushed to greatly simplify the Java EE programming model…» Spring vs. Java EE and why I ... Java EE Spring EJB ... CDI Java SE Bootstrap and JPA

Basic Java EE Book