Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2107 from akka/wip-3945-missing-license-for-templ…
…ate-ban =sam #3927 Added license file and tutorial to java8 persistence sample
- Loading branch information
Showing
6 changed files
with
290 additions
and
1 deletion.
There are no files selected for viewing
17 changes: 17 additions & 0 deletions
17
akka-samples/akka-sample-persistence-java-lambda/.gitignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
*# | ||
*.iml | ||
*.ipr | ||
*.iws | ||
*.pyc | ||
*.tm.epoch | ||
*.vim | ||
*-shim.sbt | ||
.idea/ | ||
/project/plugins/project | ||
project/boot | ||
target/ | ||
/logs | ||
.cache | ||
.classpath | ||
.project | ||
.settings |
121 changes: 121 additions & 0 deletions
121
akka-samples/akka-sample-persistence-java-lambda/COPYING
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
Creative Commons Legal Code | ||
|
||
CC0 1.0 Universal | ||
|
||
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE | ||
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN | ||
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS | ||
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES | ||
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS | ||
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM | ||
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED | ||
HEREUNDER. | ||
|
||
Statement of Purpose | ||
|
||
The laws of most jurisdictions throughout the world automatically confer | ||
exclusive Copyright and Related Rights (defined below) upon the creator | ||
and subsequent owner(s) (each and all, an "owner") of an original work of | ||
authorship and/or a database (each, a "Work"). | ||
|
||
Certain owners wish to permanently relinquish those rights to a Work for | ||
the purpose of contributing to a commons of creative, cultural and | ||
scientific works ("Commons") that the public can reliably and without fear | ||
of later claims of infringement build upon, modify, incorporate in other | ||
works, reuse and redistribute as freely as possible in any form whatsoever | ||
and for any purposes, including without limitation commercial purposes. | ||
These owners may contribute to the Commons to promote the ideal of a free | ||
culture and the further production of creative, cultural and scientific | ||
works, or to gain reputation or greater distribution for their Work in | ||
part through the use and efforts of others. | ||
|
||
For these and/or other purposes and motivations, and without any | ||
expectation of additional consideration or compensation, the person | ||
associating CC0 with a Work (the "Affirmer"), to the extent that he or she | ||
is an owner of Copyright and Related Rights in the Work, voluntarily | ||
elects to apply CC0 to the Work and publicly distribute the Work under its | ||
terms, with knowledge of his or her Copyright and Related Rights in the | ||
Work and the meaning and intended legal effect of CC0 on those rights. | ||
|
||
1. Copyright and Related Rights. A Work made available under CC0 may be | ||
protected by copyright and related or neighboring rights ("Copyright and | ||
Related Rights"). Copyright and Related Rights include, but are not | ||
limited to, the following: | ||
|
||
i. the right to reproduce, adapt, distribute, perform, display, | ||
communicate, and translate a Work; | ||
ii. moral rights retained by the original author(s) and/or performer(s); | ||
iii. publicity and privacy rights pertaining to a person's image or | ||
likeness depicted in a Work; | ||
iv. rights protecting against unfair competition in regards to a Work, | ||
subject to the limitations in paragraph 4(a), below; | ||
v. rights protecting the extraction, dissemination, use and reuse of data | ||
in a Work; | ||
vi. database rights (such as those arising under Directive 96/9/EC of the | ||
European Parliament and of the Council of 11 March 1996 on the legal | ||
protection of databases, and under any national implementation | ||
thereof, including any amended or successor version of such | ||
directive); and | ||
vii. other similar, equivalent or corresponding rights throughout the | ||
world based on applicable law or treaty, and any national | ||
implementations thereof. | ||
|
||
2. Waiver. To the greatest extent permitted by, but not in contravention | ||
of, applicable law, Affirmer hereby overtly, fully, permanently, | ||
irrevocably and unconditionally waives, abandons, and surrenders all of | ||
Affirmer's Copyright and Related Rights and associated claims and causes | ||
of action, whether now known or unknown (including existing as well as | ||
future claims and causes of action), in the Work (i) in all territories | ||
worldwide, (ii) for the maximum duration provided by applicable law or | ||
treaty (including future time extensions), (iii) in any current or future | ||
medium and for any number of copies, and (iv) for any purpose whatsoever, | ||
including without limitation commercial, advertising or promotional | ||
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each | ||
member of the public at large and to the detriment of Affirmer's heirs and | ||
successors, fully intending that such Waiver shall not be subject to | ||
revocation, rescission, cancellation, termination, or any other legal or | ||
equitable action to disrupt the quiet enjoyment of the Work by the public | ||
as contemplated by Affirmer's express Statement of Purpose. | ||
|
||
3. Public License Fallback. Should any part of the Waiver for any reason | ||
be judged legally invalid or ineffective under applicable law, then the | ||
Waiver shall be preserved to the maximum extent permitted taking into | ||
account Affirmer's express Statement of Purpose. In addition, to the | ||
extent the Waiver is so judged Affirmer hereby grants to each affected | ||
person a royalty-free, non transferable, non sublicensable, non exclusive, | ||
irrevocable and unconditional license to exercise Affirmer's Copyright and | ||
Related Rights in the Work (i) in all territories worldwide, (ii) for the | ||
maximum duration provided by applicable law or treaty (including future | ||
time extensions), (iii) in any current or future medium and for any number | ||
of copies, and (iv) for any purpose whatsoever, including without | ||
limitation commercial, advertising or promotional purposes (the | ||
"License"). The License shall be deemed effective as of the date CC0 was | ||
applied by Affirmer to the Work. Should any part of the License for any | ||
reason be judged legally invalid or ineffective under applicable law, such | ||
partial invalidity or ineffectiveness shall not invalidate the remainder | ||
of the License, and in such case Affirmer hereby affirms that he or she | ||
will not (i) exercise any of his or her remaining Copyright and Related | ||
Rights in the Work or (ii) assert any associated claims and causes of | ||
action with respect to the Work, in either case contrary to Affirmer's | ||
express Statement of Purpose. | ||
|
||
4. Limitations and Disclaimers. | ||
|
||
a. No trademark or patent rights held by Affirmer are waived, abandoned, | ||
surrendered, licensed or otherwise affected by this document. | ||
b. Affirmer offers the Work as-is and makes no representations or | ||
warranties of any kind concerning the Work, express, implied, | ||
statutory or otherwise, including without limitation warranties of | ||
title, merchantability, fitness for a particular purpose, non | ||
infringement, or the absence of latent or other defects, accuracy, or | ||
the present or absence of errors, whether or not discoverable, all to | ||
the greatest extent permissible under applicable law. | ||
c. Affirmer disclaims responsibility for clearing rights of other persons | ||
that may apply to the Work or any use thereof, including without | ||
limitation any person's Copyright and Related Rights in the Work. | ||
Further, Affirmer disclaims responsibility for obtaining any necessary | ||
consents, permissions or other rights required for any use of the | ||
Work. | ||
d. Affirmer understands and acknowledges that Creative Commons is not a | ||
party to this document and has no duty or obligation with respect to | ||
this CC0 or use of the Work. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Activator Template by Typesafe | ||
|
||
Licensed under Public Domain (CC0) | ||
|
||
To the extent possible under law, the person who associated CC0 with | ||
this Activator Tempate has waived all copyright and related or neighboring | ||
rights to this Activator Template. | ||
|
||
You should have received a copy of the CC0 legalcode along with this | ||
work. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>. |
137 changes: 137 additions & 0 deletions
137
akka-samples/akka-sample-persistence-java-lambda/tutorial/index.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,137 @@ | ||
<!-- <html> --> | ||
<head> | ||
<title>Akka Persistence Samples in Java with Lambdas</title> | ||
</head> | ||
|
||
<body> | ||
|
||
<div> | ||
<h2>Akka Persistence Samples</h2> | ||
<p> | ||
This tutorial contains examples that illustrate a subset of | ||
<a href="http://doc.akka.io/docs/akka/2.3-SNAPSHOT/java/lambda-persistence.html" target="_blank">Akka Persistence</a> features. | ||
</p> | ||
<ul> | ||
<li>Processors and channels</li> | ||
<li>Processsor snapshots</li> | ||
<li>Eventsourced processors</li> | ||
<li>Processor failure handling</li> | ||
<li>Processor views</li> | ||
<li>Processor conversation recovery</li> | ||
</ul> | ||
|
||
<p> | ||
Custom storage locations for the journal and snapshots can be defined in | ||
<a href="#code/src/main/resources/application.conf" class="shortcut">application.conf</a>. | ||
</p> | ||
</div> | ||
|
||
<div> | ||
<h2>Processors and channels</h2> | ||
<p> | ||
<a href="#code/src/main/java/sample/persistence/ProcessorChannelExample.java" class="shortcut">ProcessorChannelExample.java</a> | ||
defines an <code>ExampleProcessor</code> and an <code>ExampleDestination</code>. The processor sends messages to a | ||
destination via a channel. The destination confirms the delivery of these messages so that replayed messages aren't | ||
redundantly delivered to the destination. Repeated runs of the application demonstrates that the processor receives | ||
both replayed and new messages whereas the channel only receives new messages, sent by the application. The processor | ||
also receives replies from the destination, demonstrating that a channel preserves sender references. | ||
</p> | ||
|
||
<p> | ||
To run this example, go to the <a href="#run" class="shortcut">Run</a> tab, and run the application main class | ||
<b><code>sample.persistence.ProcessorChannelExample</code></b> several times. | ||
</p> | ||
</div> | ||
|
||
<div> | ||
<h2>Processor snapshots</h2> | ||
<p> | ||
<a href="#code/src/main/java/sample/persistence/SnapshotExample.java" class="shortcut">SnapshotExample.java</a> | ||
demonstrates how processors can take snapshots of application state and recover from previously stored snapshots. | ||
Snapshots are offered to processors at the beginning of recovery, before any messages (younger than the snapshot) | ||
are replayed. | ||
</p> | ||
|
||
<p> | ||
To run this example, go to the <a href="#run" class="shortcut">Run</a> tab, and run the application main class | ||
<b><code>sample.persistence.SnapshotExample</code></b> several times. With every run, the state offered by the | ||
most recent snapshot is printed to <code>stdout</code>, followed by the updated state after sending new persistent | ||
messages to the processor. | ||
</p> | ||
</div> | ||
|
||
<div> | ||
<h2>Eventsourced processors</h2> | ||
<p> | ||
<a href="#code/src/main/java/sample/persistence/EventsourcedExample.java" class="shortcut">EventsourcedExample.java</a> | ||
is described in detail in the <a href="http://doc.akka.io/docs/akka/2.3-SNAPSHOT/java/lambda-persistence.html#event-sourcing" target="_blank">Event sourcing</a> | ||
section of the user documentation. With every application run, the <code>ExampleProcessor</code> is recovered from | ||
events stored in previous application runs, processes new commands, stores new events and snapshots and prints the | ||
current processor state to <code>stdout</code>. | ||
</p> | ||
|
||
<p> | ||
To run this example, go to the <a href="#run" class="shortcut">Run</a> tab, and run the application main class | ||
<b><code>sample.persistence.EventsourcedExample</code></b> several times. | ||
</p> | ||
</div> | ||
|
||
<div> | ||
<h2>Processor failure handling</h2> | ||
<p> | ||
<a href="#code/src/main/java/sample/persistence/ProcessorFailureExample.java" class="shortcut">ProcessorFailureExample.java</a> | ||
shows how a processor can delete persistent messages from the journal if they threw an exception. Throwing an exception | ||
restarts the processor and replays messages. In order to prevent that the message that caused the exception is replayed, | ||
it is marked as deleted in the journal (during invocation of <code>preRestart</code>). This is a common pattern in | ||
command-sourcing to compensate write-ahead logging of messages. | ||
</p> | ||
|
||
<p> | ||
To run this example, go to the <a href="#run" class="shortcut">Run</a> tab, and run the application main class | ||
<b><code>sample.persistence.ProcessorFailureExample</code></b> several times. | ||
</p> | ||
|
||
<p> | ||
<a href="http://doc.akka.io/docs/akka/2.3-SNAPSHOT/java/lambda-persistence.html#event-sourcing" target="_blank">Event sourcing</a> | ||
on the other hand, does not persist commands directly but rather events that have been derived from received commands | ||
(not shown here). These events are known to be successfully applicable to current processor state i.e. there's | ||
no need for deleting them from the journal. Event sourced processors usually have a lower throughput than command | ||
sourced processors, as the maximum size of a write batch is limited by the number of persisted events per received | ||
command. | ||
</p> | ||
</div> | ||
|
||
<div> | ||
<h2>Processor views</h2> | ||
<p> | ||
<a href="#code/src/main/java/sample/persistence/ViewExample.java" class="shortcut">ViewExample.java</a> demonstrates | ||
how a view (<code>ExampleView</code>) is updated with the persistent message stream of a processor | ||
(<code>ExampleProcessor</code>). Messages sent to the processor are read from <code>stdin</code>. Views also support | ||
snapshotting and can be used in combination with channels in the same way as processors. | ||
</p> | ||
|
||
<p> | ||
To run this example, go to the <a href="#run" class="shortcut">Run</a> tab, and run the application main class | ||
<b><code>sample.persistence.ViewExample</code></b>. | ||
</p> | ||
|
||
<p> | ||
Views can also receive events that have been persisted by event sourced processors (not shown). | ||
</p> | ||
</div> | ||
|
||
<div> | ||
<h2>Processor conversation recovery</h2> | ||
<p> | ||
<a href="#code/src/main/java/sample/persistence/ConversationRecoveryExample.java" class="shortcut">ConversationRecoveryExample.java</a> | ||
defines two processors that send messages to each other via channels. The reliable delivery properties of channels, | ||
in combination with processors, allow these processors to automatically resume their conversation after a JVM crash. | ||
</p> | ||
<p> | ||
To run this example, go to the <a href="#run" class="shortcut">Run</a> tab, and run the application main class | ||
<b><code>sample.persistence.ConversationRecoveryExample</code></b> several times. | ||
</p> | ||
</div> | ||
|
||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters