MicroProfile: A Quest for a Lightweight and Modern Enterprise Java Platform

@croft#Devoxx #MicroProfile
Eclipse MicroProfile:
A Quest for a Lightweight and Modern Enterprise Java Platform
Mike Croft
Payara

The Quest
• What is MicroProfile?
• Why MicroProfile?
• How do I get it?
• What APIs do I get?
• How do I use them?

What is MicroProfile?
• A collection of APIs
• Focused on, but not limited to, microservices
• A place for innovation
• A fast, time-boxed release cycle
• Community driven

Why MicroProfile?
• Get involved in the future of Enterprise Java
• Java EE and the JCP are perceived as slow
• For your app
• The tech landscape is changing, microservice or not. MicroProfile
aims to provide tools to make the best use of new tech

How do I get it?
• Choose your own adventure
• Payara Micro
• TomEE
• WildFly Swarm
• Open Liberty
• KumuluzEE
• Hammock

What APIs do I get?
• MicroProfile 1.2
• Config 1.1
• Health Check 1.0
• Fault Tolerance 1.0
• JWT Propagation 1.0
• Metrics 1.0

What APIs will I get?
• MicroProfile Future
• Open Tracing 1.0
• Open API 1.0
• TypeSafe Rest Client 1.0
• JSON-B 1.0
• Java EE 8 upgrades
• Maintenance Releases
UNCONFIRMED!

#Devoxx #MicroProfile @croft
Config 1.1

Config 1.1
• Inject config values at runtime
• NOT a registry
• Values are read-only by design
• Specify your own config sources
• Ordinals for priority
• Higher number == higher priority

Config 1.1
• Default Config Sources:
• META-INF/microprofile-config.properties (100)
• Environment variables (300)
• System Properties (400)
• Implementor (Payara) Default Config Sources:
• domain
• config
• server
• application
• module
• cluster
• jndi

Config 1.1
• @ConfigProperty
• name
• defaultValue
@Inject
@ConfigProperty(name = "example.some.url")
private String someUrl;
@Inject
@ConfigProperty(name = "example.some.port")
private Optional<Integer> somePort;
@Inject
@ConfigProperty(name = "example.timeout",
defaultValue = "100")
private javax.inject.Provider<Long> timeout;

Config 1.1
• Converters
• boolean/Boolean
• int and Integer
• long and Long
• float and Float
• double and Double
• Duration
• LocalTime, LocalDate, LocalDateTime
• OffsetDateTime, OffsetTime
• Instant
• URL

Config 1.1
• Custom Config Sources:
• java.util.ServiceLoader
• For a single source
• ConfigSourceProvider
• For multiple sources
e.g. many properties files in JARs
public interface ConfigSource {
String CONFIG_ORDINAL = "config_ordinal";
Map<String, String> getProperties();
default Set<String> getPropertyNames() {
return getProperties().keySet();
}
default int getOrdinal() {
String configOrdinal =
getValue(CONFIG_ORDINAL);
if (configOrdinal != null) {
try {
return Integer.parseInt(configOrdinal);
} catch (NumberFormatException ignored) {
}
}
return 100;
}
String getValue(String propertyName);
String getName();
}

Health Check 1.0

Health Check 1.0
• @Health
• UP or DOWN
• Extra data can be optionally specified

Health Check 1.0
• @Health
• Class annotation
• Must implement HealthCheck
• Must override call()
@Health
public class CheckDiskspace implements
HealthCheck {
@Override
public HealthCheckResponse call() {
return
HealthCheckResponse.named("diskspace")
.withData("free", "780mb")
.up()
.build();
}
}

Metrics 1.0

Metrics 1.0
• Annotations
• @Counted
• @Gauge
• @Metered
• @Timed
• @Metric

Metrics 1.0
• @Counted
• monotonic
• Targets:
• Constructor
• Method
• Type
@Counted
public void serviceA() {
// only current
// invocations counted
}
@Counted(monotonic = true)
public void serviceB() {
// every invocation
// counted
}

Metrics 1.0
• @Gauge
• unit
•Targets:
• Method
• Produces:
• Sampled value,
e.g. CPU temperature
@Gauge(unit = MetricUnits.MEGABYTES)
public long getHeapSize() {
return heapSize;
}
@Gauge(unit = MetricUnits.NONE)
public long getValue() {
return value;
}

Metrics 1.0
• @Metered
• Targets:
• Constructor
• Method
• Type
• Produces:
• Mean throughput
• 1, 5, 15 minute moving avg
@Metered
public class MeteredBean {
public void serviceA() { ... }
public void serviceB() { ... }
}
@Metered
public void run(){
// do work
}

Metrics 1.0
• @Timed
• Targets:
• Constructor
• Method
• Type
• Produces:
• Duration statistics
• Throughput statistics
@Timed
public class TimedBean {
public void serviceA() { ... }
public void serviceB() { ... }
}
@Timed
public void run(){
// do work
}

Metrics 1.0
• @Metric
• Targets:
• Field
• Method
• Parameter
@Produces
@Metric(name = "hitPercent")
@ApplicationScoped
protected Gauge<Double> getHitPercent() {
return new Gauge<Double>() {
@Override
public Double getValue() {
return hits / total;
}
};
}
@Inject
public void init(
@Metric(name = "inst") Counter inst) {
inst.inc();
}

Metrics 1.0
• Annotation Fields
• name
• absolute
• displayName
• description
• unit
• tags
@Counted(monotonic = true,
name = "Service B",
absolute = true,
displayName = "My Service B",
description = "Total invokes of B",
unit = MetricUnits.NONE,
tags = "key=value")
}

Metrics 1.0
• 3 Metrics registries
• base
• application
• vendor
• JSON format
• Prometheus text
format
{
"application": {
"hitCount": 45
},
"base": {
"thread.count": 33,
"thread.max.count": 47
},
"vendor": {
"someMetric": 100
}
}

Metrics 1.0
• Sample prometheus.yml
• Found in the Vote service of the
Microprofile-Conference
application
• Liberty’s implementation is
secured by default, hence the need
for authentication
scrape_configs:
- job_name: 'microprofile-conference-vote'
tls_config:
insecure_skip_verify: true
basic_auth:
username: confAdmin
password: microprofile
scheme: https
static_configs:
- targets: ['localhost:9443']

Fault Tolerance 1.0

Fault Tolerance 1.0
• Implements common design patterns
• All annotations can be used together
• @Asynchronous
• @Retry
• @Fallback
• @CircuitBreaker
• @Bulkhead
• @Timeout
• See the spec for details

Fault Tolerance 1.0
• @Asynchronous
• Annotate method or class
• Method(s) invoked in separate thread
• MUST return a Future
• Assumes requests should be synchronous if not specified

Fault Tolerance 1.0
• @Retry
• delay (ms)
• delayUnit
• maxDuration (ms)
• durationUnit
• jitter (ms)
• jitterDelayUnit
• maxRetries
• retryOn
• abortOn
@Retry(delay = 400, maxDuration = 3200,
jitter = 400, maxRetries = 10)
public Connection serviceA() {
return connectionService();
}
@Retry(maxRetries = 90, maxDuration = 5,
durationUnit = ChronoUnit.SECONDS)
writingService();
}
@Retry(retryOn = {IOException.class})
public void serviceC() {
readingService();
}

Fault Tolerance 1.0
• @Fallback
• myFallback.class
• fallbackMethod
@Retry(maxRetries = 1)
@Fallback(StringFallbackHandler.class)
public String serviceZ() {
return "service A";
}
@Dependent
class StringFallbackHandler implements
FallbackHandler<String> {
@Override
public String handle(ExecutionContext
context){
return "Fallback for service A";
}
}
@Retry(maxRetries = 2)
@Fallback(fallbackMethod =
"fallbackForServiceB")
public String serviceB() {
return nameService();
}
private String fallbackForServiceB() {
return "myFallback";
}

Fault Tolerance 1.0
• @CircuitBreaker
• successThreshold
• requestVolumeThreshold
• failureRatio
• delay
• Throws:
• CircuitBreakerOpenException
@CircuitBreaker(
successThreshold = 10,
requestVolumeThreshold = 4,
failureRatio=0.75,
delay = 1000)
}

Fault Tolerance 1.0
•@Bulkhead
• Semaphore mode:
• value
• Threadpool mode:
• value
• waitingTaskQueue
• with @Asynchronous
• Throws:
• BulkheadException
In ThreadPool mode
@Bulkhead(5)
public Connection serviceA1() {
}
@Asynchronous
@Bulkhead(value = 5,
waitingTaskQueue = 8)
public Future<Connection> serviceA2() {
return CompletableFuture.completedFuture(
connectionService());
}

Fault Tolerance 1.0
• @Timeout
• Timeout in ms
• Can trigger @Fallback
• Can trigger @Retry
• Contributes to opening a Circuit
• Throws:
• TimeoutException
@Timeout(400)
}

JWT Propagation 1.0

JWT Propagation 1.0
• Token-based authentication
• Easily validated without second round-trip
• JSON format data
• Uses claims to carry auth information about a subject
• Processing trivial with JSON-P
• Agreed set of standard claims for interoperability

JWT Propagation 1.0
• MicroProfile JWT Tokens can...
• Be used for authentication
• Be used for authorization
• Be mapped to JSR375 IdentityStore
• Support additional IANA standard claims
• Support additional non-standard claims
• 2 new standard claims
• upn: user principal
• groups: token subject’s group memberships

JWT Propagation 1.0
• Min. Required Claims
• typ
• alg
• kid
• iss
• sub
• exp
• iat
• jti
• upn
• groups
{
"typ": "JWT",
"alg": "RS256",
"kid": "abc-1234567890"
}
{
"iss": "https://server.example.com",
"jti": "a-123",
"exp": 1311281970,
"iat": 1311280970,
"sub": "24400320",
"upn": "jdoe@server.example.com",
"groups": ["red-group", "green-group",
"admin-group", "admin"
]
}

JWT Propagation 1.0
• @Claim
• Claims enum available for
standard claims
• Ambiguous uses throw
DeploymentException
• For complete details,
see the specification doc
@ApplicationScoped
public class MyEndpoint {
@Inject
@Claim(value = "exp",
standard = Claims.iat)
private Long timeClaim;
// Mixing exp with iat
// Throws exception
@Claim(standard = Claims.iss)
private Long timeClaim;
}

Find Out More...
As a user...
• Choose your implementation!
• What specs does it support?
• Check the release notes…
• For the microprofile-bom
• For the individual specs
• Ask questions!
• In Gitter!
• In the Google Group!

Find Out More...
As a contributor...
• What specifications are you interested in?
• An existing spec?
• Find the repository on GitHub (or on microprofile.io)
• Find the chat community on Gitter
• Find the hangout in the MicroProfile Calendar
• Something new?
• Start a discussion in the Google Group!
• Start coding in the Sandbox repository
• (PRs should be merged quickly)

Demo

Questions?
• How does MicroProfile relate to EE4J?
• How big is MicroProfile planning to get?
• There are no implementation rules - could be composable
• There will be some interdepency though - e.g. Config API widely
reused
• What about breaking changes?
• MicroProfile is about innovation primarily. Breaking changes will be
avoided where possible, but not if it limits progress.

MicroProfile: A Quest for a Lightweight and Modern Enterprise Java Platform

More Related Content

What's hot

Similar to MicroProfile: A Quest for a Lightweight and Modern Enterprise Java Platform

Recently uploaded

MicroProfile: A Quest for a Lightweight and Modern Enterprise Java Platform