Libraries

Overview

The Zestâ¢ Libraries are of varying maturity level and we try to maintain a STATUS (dev-status.xml) file indicating +

Zestâ¢
Introduction
Tutorials
Javadoc
Samples
Core
Libraries
Extensions
Tools
GlossaryÂ

Libraries

Overview

The Zestâ¢ Libraries are of varying maturity level and we try to maintain a STATUS (dev-status.xml) file indicating how good the codebase, documentation and unit tests are for each of the libraries. This is highly subjective and potentially different individuals will judge this differently, but at least it gives a ballpark idea of the situation for our users.

Modified: zest/site/content/java/develop/library-alarm.html URL: http://svn.apache.org/viewvc/zest/site/content/java/develop/library-alarm.html?rev=1739675&r1=1739674&r2=1739675&view=diff ============================================================================== --- zest/site/content/java/develop/library-alarm.html (original) +++ zest/site/content/java/develop/library-alarm.html Mon Apr 18 01:15:33 2016 @@ -66,7 +66,7 @@ })(); -

Zestâ¢
Introduction
Tutorials
Javadoc
Samples
Core
Libraries
Extensions
Tools
GlossaryÂ

Alarms

code

docs

tests

The process control and industrial automation industry has for decades been struggling with a large number of unreliable +

Zestâ¢
Introduction
Tutorials
Javadoc
Samples
Core
Libraries
Extensions
Tools
GlossaryÂ

Alarms

code

docs

tests

The process control and industrial automation industry has for decades been struggling with a large number of unreliable data points, such as sensors, fuses and potentially malfunctioning valves and actuators. This industry quickly developed the concept of Alarm Point as an abstraction for indication that something is not working correctly. These Alarm Points could then be grouped and aggregated, along a well-defined set of rules, to provide human operators a @@ -74,7 +74,7 @@ clear view of what is going on in a plan donât. Very little thought has been spent on what happens when many independent systems interact and what the consequences are to other systems when one fails. The Alarm Point concepts becomes a natural fit for the enterprise world of today, where Alarm Points allows for fine-grained notification and view into the health of one or more -systems.

In Zest, we are building upon this powerful abstraction, from decades of field experience.

TableÂ 25.Â Artifact

Group ID	Artifact ID	Version
org.apache.zest.library	org.apache.zest.library.alarm	0

Overview

An Alarm Point is of an Alarm Class and of an Alarm Category. The Alarm Class defines the severity of the +systems.

In Zest, we are building upon this powerful abstraction, from decades of field experience.

TableÂ 25.Â Artifact

Group ID	Artifact ID	Version
org.apache.zest.library	org.apache.zest.library.alarm	0

Overview

An Alarm Point is of an Alarm Class and of an Alarm Category. The Alarm Class defines the severity of the Alarm Point and the Alarm Category defines which part of the system it belongs to. Alarm Category can be extended by the developer, and the package contains the SimpleAlarmCategory as an example, where a Description property has been added.

An Alarm Point also has a System Name, which should be the subsystem or application name.

Alarm Points are triggered and an Alarm Trigger may cause the Alarm Status to change. IF, and only if, the Modified: zest/site/content/java/develop/library-circuitbreaker.html URL: http://svn.apache.org/viewvc/zest/site/content/java/develop/library-circuitbreaker.html?rev=1739675&r1=1739674&r2=1739675&view=diff ============================================================================== --- zest/site/content/java/develop/library-circuitbreaker.html (original) +++ zest/site/content/java/develop/library-circuitbreaker.html Mon Apr 18 01:15:33 2016 @@ -66,7 +66,7 @@ })(); -

Zestâ¢
Introduction
Tutorials
Javadoc
Samples
Core
Libraries
Extensions
Tools
GlossaryÂ

Circuit Breaker

code

docs

tests

The Circuit Breaker library provides a way to guard your application +

Zestâ¢
Introduction
Tutorials
Javadoc
Samples
Core
Libraries
Extensions
Tools
GlossaryÂ

Circuit Breaker

code

docs

tests

The Circuit Breaker library provides a way to guard your application against faulty external systems (e.g. mail servers being down, web services being down). It is used by many Zestâ¢ Extensions and Libraries.

Thereâs a couple of differences between this implementation and others seen on the net, but weâve also heavily borrowed from others. The @@ -91,7 +91,7 @@ tripping it should be possible to expose There is a standard implementation of the Availability interface that delegates to a circuit breaker and the Enabled configuration flag, which is what weâd suspect will be used in most cases where external systems -are invoked.

TableÂ 26.Â Artifact

Group ID	Artifact ID	Version
org.apache.zest.library	org.apache.zest.library.circuitbreaker	0

Direct usage

The CircuitBreaker can be used directly, even without using anything else from the Zestâ¢ SDK.

Here is a code snippet that demonstrate how t o create a CircuitBreaker and how it behave:

// Create a CircuitBreaker with a threshold of 3, a 250ms timeout, allowing IllegalArgumentExceptions
+are invoked.
TableÂ 26.Â Artifact
Group ID Artifact ID Version
org.apache.zest.library org.apache.zest.library.circuitbreaker 0

Direct usage
The CircuitBreaker can be used directly, even without using anything else from the Zestâ¢ SDK.
Here is a code snippet that demonstrate how t
 o create a CircuitBreaker and how it behave:
// Create a CircuitBreaker with a threshold of 3, a 250ms timeout, allowing IllegalArgumentExceptions
 CircuitBreaker cb = new CircuitBreaker( 3, 250, CircuitBreakers.in( IllegalArgumentException.class ) );
 
   [...snip...]

Modified: zest/site/content/java/develop/library-constraints.html
URL: http://svn.apache.org/viewvc/zest/site/content/java/develop/library-constraints.html?rev=1739675&r1=1739674&r2=1739675&view=diff
==============================================================================
--- zest/site/content/java/develop/library-constraints.html (original)
+++ zest/site/content/java/develop/library-constraints.html Mon Apr 18 01:15:33 2016
@@ -66,10 +66,10 @@
   })();
  
 
-  
Zestâ¢
Introduction
Tutorials
Javadoc
Samples
Core
Libraries
Extensions
Tools
GlossaryÂ 
Overview
Groovy Scripting
Javascript Scripting
Scala Support
Alarms
Circuit Breaker
Constraints
Conversion - DEPRECATED
Event Sourcing
FileConfig
HTTP
Invocation Cache
JMX
Locking
Logging
Metrics Library
OSGi
RDF
ReST Client
ReST - HATEOAS Primer
ReST Common
ReST Server
Scheduler
Servlet
Shiro Security
Shiro Web Security
Spring Integration
SQL
UID
UoWFile
Constraints
code
docs
tests
The Constraints library provide a bunch of often used Constraints based on the
+  
Zestâ¢
Introduction
Tutorials
Javadoc
Samples
Core
Libraries
Extensions
Tools
GlossaryÂ 
Overview
Groovy Scripting
Javascript Scripting
Scala Support
Alarms
Circuit Breaker
Constraints
Conversion - DEPRECATED
Event Sourcing
FileConfig
HTTP
Invocation Cache
JMX
Locking
Logging
Metrics Library
OSGi
RDF
ReST Client
ReST - HATEOAS Primer
ReST Common
ReST Server
Restlet Support
Scheduler
Servlet
Shiro Security
Shiro Web Security
Spring Integration
SQL
UID
UoWFile
Constraints
code
docs
tests
The Constraints library provide a bunch of often used Constraints based on the
 Zestâ¢ Constraints api described in Constraint.
Remember that you are not limited to constraints presents in this library, you
 are encouraged to write your own constraints. See Create a Constraint
-or take a look at this library source code to learn how to write your own.
TableÂ 27.Â Artifact
Group ID Artifact ID Version
org.apache.zest.library org.apache.zest.library.constraints 0

Usage
You can use theses constraints on Properties or on method arguments.
+or take a look at this library source code to learn how to write your own.
TableÂ 27.Â Artifact
Group ID Artifact ID Version
org.apache.zest.library org.apache.zest.library.constraints 0

Usage
You can use theses constraints on Properties or on method arguments.
 Here are some examples:
import org.apache.zest.library.constraints.annotation.*;
   [...snip...]
 

Modified: zest/site/content/java/develop/library-conversion.html
URL: http://svn.apache.org/viewvc/zest/site/content/java/develop/library-conversion.html?rev=1739675&r1=1739674&r2=1739675&view=diff
==============================================================================
--- zest/site/content/java/develop/library-conversion.html (original)
+++ zest/site/content/java/develop/library-conversion.html Mon Apr 18 01:15:33 2016
@@ -66,7 +66,7 @@
   })();
  
 
-  
Zestâ¢
Introduction
Tutorials
Javadoc
Samples
Core
Libraries
Extensions
Tools
GlossaryÂ 
Overview
Groovy Scripting
Javascript Scripting
Scala Support
Alarms
Circuit Breaker
Constraints
Conversion - DEPRECATED
Event Sourcing
FileConfig
HTTP
Invocation Cache
JMX
Locking
Logging
Metrics Library
OSGi
RDF
ReST Client
ReST - HATEOAS Primer
ReST Common
ReST Server
Scheduler
Servlet
Shiro Security
Shiro Web Security
Spring Integration
SQL
UID
UoWFile
Conversion - DEPRECATED
code
docs
tests
The Conversion Library provides support for converting composite types.
TableÂ 28.Â Artifact
Group ID Artifact ID Version
org.apache.zest.library org.apache.zest.library.conversion 0

DEPRECATED

 This functionality is now present in UnitOfWork as
+  
Zestâ¢
Introduction
Tutorials
Javadoc
Samples
Core
Libraries
Extensions
Tools
GlossaryÂ 
Overview
Groovy Scripting
Javascript Scripting
Scala Support
Alarms
Circuit Breaker
Constraints
Conversion - DEPRECATED
Event Sourcing
FileConfig
HTTP
Invocation Cache
JMX
Locking
Logging
Metrics Library
OSGi
RDF
ReST Client
ReST - HATEOAS Primer
ReST Common
ReST Server
Restlet Support
Scheduler
Servlet
Shiro Security
Shiro Web Security
Spring Integration
SQL
UID
UoWFile
Conversion - DEP
 RECATED
code
docs
tests
The Conversion Library provides support for converting composite types.
TableÂ 28.Â Artifact
Group ID Artifact ID Version
org.apache.zest.library org.apache.zest.library.conversion 0

DEPRECATED
This functionality is now present in UnitOfWork as
 the two methods toEntity() and toValue(). Since this library was written
 assocations of all kinds are now fully supported in Values.
Entities to Values
To convert Entities to Values, use the EntityToValueService. It is easily assembled:
new EntityToValueAssembler().assemble( module );
 
Letâs say we have an interface defining state:
public interface PersonState

Modified: zest/site/content/java/develop/library-eventsourcing.html
URL: http://svn.apache.org/viewvc/zest/site/content/java/develop/library-eventsourcing.html?rev=1739675&r1=1739674&r2=1739675&view=diff
==============================================================================
--- zest/site/content/java/develop/library-eventsourcing.html (original)
+++ zest/site/content/java/develop/library-eventsourcing.html Mon Apr 18 01:15:33 2016
@@ -66,11 +66,11 @@
   })();
  
 
-  
Zestâ¢
Introduction
Tutorials
Javadoc
Samples
Core
Libraries
Extensions
Tools
GlossaryÂ 
Overview
Groovy Scripting
Javascript Scripting
Scala Support
Alarms
Circuit Breaker
Constraints
Conversion - DEPRECATED
Event Sourcing
FileConfig
HTTP
Invocation Cache
JMX
Locking
Logging
Metrics Library
OSGi
RDF
ReST Client
ReST - HATEOAS Primer
ReST Common
ReST Server
Scheduler
Servlet
Shiro Security
Shiro Web Security
Spring Integration
SQL
UID
UoWFile
Event Sourcing
code
docs
tests
The Event Sourcing Library supports generating, storing and replaying two types of events: application-events and domain-events.
Application events are bound to Usecase and are produced by execution of specific methods (ones with ApplicationEvent as their first parameter).
+  
Zestâ¢
Introduction
Tutorials
Javadoc
Samples
Core
Libraries
Extensions
Tools
GlossaryÂ 
Overview
Groovy Scripting
Javascript Scripting
Scala Support
Alarms
Circuit Breaker
Constraints
Conversion - DEPRECATED
Event Sourcing
FileConfig
HTTP
Invocation Cache
JMX
Locking
Logging
Metrics Library
OSGi
RDF
ReST Client
ReST - HATEOAS Primer
ReST Common
ReST Server
Restlet Support
Scheduler
Servlet
Shiro Security
Shiro Web Security
Spring Integration
SQL
UID
UoWFile
Event Sourcing
code
docs
tests
The Event Sourcing Library supports generating, storing and replaying two types of events: application-events and domain-events.
Application events are bound to Usecase and are produced by execution of specific methods (ones with ApplicationEvent as their first parameter).
 Each application event holds information about Usecase, method name and JSON serialized values of method parameters.
Domain events are bound to entity instances and are produced by execution of annotated (see @DomainEvent) methods that belongs to EntityComposite.
 Each domain event (see DomainEventValue) holds information about entity type, identity, method name and JSON serialized values of method parameters.
Both application and domain events are captured during UnitOfWork lifetime and are stored in EventStore after successfully completed UnitOfWork as collection together (see UnitOfWorkDomainEventsValue and TransactionApplicationEvents).
There is support for replaying events.
-When events are replayed the same code is executed but no new events are generated.
There are helper classes that enables a service to easily track events feed, and for domain events there is EventRouter that allow to specify specificationâreceiver routes.
TableÂ 29.Â Artifact
Group ID Artifact ID Version
org.apache.zest.library org.apache.zest.library.eventsourcing 0


 JDBM backed store
EventStore supports indexed and streamed access to events feed.
-There is in-memory and JDBM backed implementations.
code
docs
tests
TableÂ 30.Â Artifact
Group ID Artifact ID Version
org.apache.zest.library org.apache.zest.library.eventsourcing-jdbm 0

REST access
For remote access 
 to feed there is eventsourcing-rest library that exposes events as Atom feeds.
code
docs
tests
TableÂ 31.Â Artifact
Group ID Artifact ID Version
org.apache.zest.library org.apache.zest.library.eventsourcing-rest 0

Application Events
Assembly is done as follows:
new EventsourcingAssembler()
+When events are replayed the same code is executed but no new events are generated.
There are helper classes that enables a service to easily track events feed, and for domain events there is EventRouter that allow to specify specificationâreceiver routes.
TableÂ 29.Â Artifact
Group ID Artifact ID Version
org.apache.zest.library org.apache.zest.library.eventsourcing 0


 JDBM backed store
EventStore supports indexed and streamed access to events feed.
+There is in-memory and JDBM backed implementations.
code
docs
tests
TableÂ 30.Â Artifact
Group ID Artifact ID Version
org.apache.zest.library org.apache.zest.library.eventsourcing-jdbm 0

REST access
For remote access 
 to feed there is eventsourcing-rest library that exposes events as Atom feeds.
code
docs
tests
TableÂ 31.Â Artifact
Group ID Artifact ID Version
org.apache.zest.library org.apache.zest.library.eventsourcing-rest 0

Application Events
Assembly is done as follows:
new EventsourcingAssembler()
         .withApplicationEvents()
         .withCurrentUserFromUOWPrincipal()
         .assemble(module);

Modified: zest/site/content/java/develop/library-fileconfig.html
URL: http://svn.apache.org/viewvc/zest/site/content/java/develop/library-fileconfig.html?rev=1739675&r1=1739674&r2=1739675&view=diff
==============================================================================
--- zest/site/content/java/develop/library-fileconfig.html (original)
+++ zest/site/content/java/develop/library-fileconfig.html Mon Apr 18 01:15:33 2016
@@ -66,7 +66,7 @@
   })();
  
 
-  
Zestâ¢
Introduction
Tutorials
Javadoc
Samples
Core
Libraries
Extensions
Tools
GlossaryÂ 
Overview
Groovy Scripting
Javascript Scripting
Scala Support
Alarms
Circuit Breaker
Constraints
Conversion - DEPRECATED
Event Sourcing

 FileConfig
HTTP
Invocation Cache
JMX
Locking
Logging
Metrics Library
OSGi
RDF
ReST Client
ReST - HATEOAS Primer
ReST Common
ReST Server
Scheduler
Servlet
Shiro Security
Shiro Web Security
Spring Integration
SQL
UID
UoWFile
FileConfig
code
docs
tests
The FileConfig library provide a service for accessing application-specific directories.
A lot of the Zestâ¢ Libraries and Extensions make use of this library to locate files.
TableÂ 32.Â Artifact
Group ID Artifact ID Version
org.apache.zest.library org.apache.zest.library.fileconfig 0

Usage
public interface FileConfiguration
+  
Zestâ¢
Introduction
Tutorials
Javadoc
Samples
Core
Libraries
Extensions
Tools
GlossaryÂ 
Overview
Groovy Scripting
Javascript Scripting
Scala Support
Alarms
Circuit Breaker
Constraints
Conversion - DEPRECATED
Event Sourcing

 FileConfig
HTTP
Invocation Cache
JMX
Locking
Logging
Metrics Library
OSGi
RDF
ReST Client
ReST - HATEOAS Primer
ReST Common
ReST Server
Restlet Support
Scheduler
Servlet
Shiro Security
Shiro Web Security
Spring Integration
SQL
UID
UoWFile
FileConfig
code
docs
tests
The FileConfig library provide a service for accessing application-specific directories.
A lot of the Zestâ¢ Libraries and Extensions make use of this library to locate files.
TableÂ 32.Â Artifact
Group ID Artifact ID Version
org.apache.zest.library org.apache.zest.library.fileconfig 0

Usage
public interface FileConfiguration
 {
   [...snip...]

Libraries

Overview

Libraries

Overview

Alarms

Alarms

Overview

Overview

Circuit Breaker

Circuit Breaker

Direct usage

Direct usage

Constraints

Constraints

Usage

Usage

Conversion - DEPRECATED

DEPRECATED

Conversion - DEP RECATED

DEPRECATED

Entities to Values

Event Sourcing

Event Sourcing

Application Events

Application Events

FileConfig

Usage

FileConfig

Usage