Skip to content

Commit e0135c1

Browse files
stefan-kastefan-ka
authored
V6.2.0 doc updates (ContextMapper#51)
1 parent 47099a5 commit e0135c1

File tree

84 files changed

+1509
-6
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+1509
-6
lines changed

‎_cmls/aggregate-states-example-1.cml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Aggregate Contract {
2+
Entity Contract {
3+
aggregateRoot
4+
5+
- State aggregateState
6+
- ContractId identifier
7+
- Customer client
8+
- List<Product> products
9+
}
10+
11+
enum State {
12+
aggregateLifecycle
13+
CREATED, POLICE_CREATED, RECALLED
14+
}
15+
}

‎_cmls/aggregate-states-example-1.html

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<div class="highlight"><pre><span></span><span class="k">Aggregate</span> Contract {
2+
<span class="k">Entity</span> Contract {
3+
<span class="k">aggregateRoot</span>
4+
5+
- <span class="k">State</span> aggregateState
6+
- <span class="k">ContractId</span> identifier
7+
- <span class="k">Customer</span> client
8+
- <span class="k">List</span>&lt;Product&gt; products
9+
}
10+
11+
<span class="k">enum</span> State {
12+
<span class="k">aggregateLifecycle</span>
13+
CREATED, POLICE_CREATED, RECALLED
14+
}
15+
}
16+
</pre></div>

‎_cmls/aggregate-states-example-2.cml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Service ContractService {
2+
@ContractId createContract(@Contract contrace) : write [ -> CREATED];
3+
@Contract getContract(@ContractId contractId) : read-only;
4+
boolean createPolicy(@ContractId contractId) : write [ CREATED -> POLICE_CREATED ];
5+
boolean recall(@ContractId contractId) : write [ CREATED, POLICE_CREATED -> RECALLED ];
6+
}

‎_cmls/aggregate-states-example-2.html

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<div class="highlight"><pre><span></span><span class="k">Service</span> ContractService {
2+
@ContractId createContract(@Contract contrace) : <span class="k">write</span> [ -&gt; CREATED];
3+
@Contract getContract(@ContractId contractId) : <span class="k">read</span>-<span class="k">only</span>;
4+
<span class="k">boolean</span> createPolicy(@ContractId contractId) : <span class="k">write</span> [ CREATED -&gt; POLICE_CREATED ];
5+
<span class="k">boolean</span> recall(@ContractId contractId) : <span class="k">write</span> [ CREATED, POLICE_CREATED -&gt; RECALLED ];
6+
}
7+
</pre></div>

‎_cmls/application-flow-example-1.cml

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
2+
/**
3+
* A flow inspired by the Lakeside Mutual project (https://github.com/Microservice-API-Patterns/LakesideMutual).
4+
* Find the original process visualization here:
5+
* https://github.com/Microservice-API-Patterns/LakesideMutual/blob/master/policy-management-backend/src/main/java/com/lakesidemutual/policymanagement/domain/insurancequoterequest/RequestStatus.java
6+
**/
7+
BoundedContext InsuranceQuotes {
8+
Application {
9+
Flow QuoteRequestFlow {
10+
operation submitRequest delegates to QuoteRequest[-> SUBMITTED] emits event RequestSubmitted
11+
event RequestSubmitted + RequestSubmitted triggers operation checkRequest
12+
operation checkRequest delegates to QuoteRequest[SUBMITTED -> RECEIVED X REJECTED] emits event QuoteReceived X RequestRejected
13+
event QuoteReceived triggers operation receiveAndCheckQuote
14+
operation receiveAndCheckQuote delegates to QuoteRequest[RECEIVED -> REJECTED X ACCEPTED X EXPIRED] emits event QuoteRejected X QuoteAccepted X QuoteExpired
15+
event QuoteAccepted triggers operation accept
16+
operation accept delegates to QuoteRequest[ACCEPTED -> POLICY_CREATED X EXPIRED] emits event PolicyCreated X QuoteExpired
17+
}
18+
}
19+
Aggregate QuoteRequest {
20+
Entity Request {
21+
aggregateRoot
22+
}
23+
DomainEvent RequestSubmitted
24+
DomainEvent QuoteReceived
25+
DomainEvent RequestRejected
26+
DomainEvent QuoteRejected
27+
DomainEvent QuoteAccepted
28+
DomainEvent QuoteExpired
29+
DomainEvent PolicyCreated
30+
Service QuoteRequestService {
31+
void submitRequest(@Request request);
32+
void checkRequest(@Request request);
33+
void receiveAndCheckQuote(@Request request);
34+
void reject(@Request request);
35+
void accept(@Request request);
36+
}
37+
enum RequestState {
38+
aggregateLifecycle
39+
SUBMITTED, RECEIVED, REJECTED, ACCEPTED, EXPIRED, POLICY_CREATED
40+
}
41+
}
42+
}

‎_cmls/application-flow-example-1.html

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<div class="highlight"><pre><span></span><span class="c">/**</span>
2+
<span class="c"> * A flow inspired by the Lakeside Mutual project (https://github.com/Microservice-API-Patterns/LakesideMutual).</span>
3+
<span class="c"> * Find the original process visualization here:</span>
4+
<span class="c"> * https://github.com/Microservice-API-Patterns/LakesideMutual/blob/master/policy-management-backend/src/main/java/com/lakesidemutual/policymanagement/domain/insurancequoterequest/RequestStatus.java</span>
5+
<span class="c"> **/</span>
6+
<span class="k">BoundedContext</span> InsuranceQuotes {
7+
<span class="k">Application</span> {
8+
<span class="k">Flow</span> QuoteRequestFlow {
9+
<span class="k">operation</span> submitRequest <span class="k">delegates</span> <span class="k">to</span> QuoteRequest[-<span class="k">&gt;</span> SUBMITTED] <span class="k">emits</span> <span class="k">event</span> RequestSubmitted
10+
<span class="k">event</span> RequestSubmitted + RequestSubmitted <span class="k">triggers</span> <span class="k">operation</span> checkRequest
11+
<span class="k">operation</span> checkRequest <span class="k">delegates</span> <span class="k">to</span> QuoteRequest[SUBMITTED -&gt; RECEIVED <span class="k">X</span> REJECTED] <span class="k">emits</span> <span class="k">event</span> QuoteReceived <span class="k">X</span> RequestRejected
12+
<span class="k">event</span> QuoteReceived <span class="k">triggers</span> <span class="k">operation</span> receiveAndCheckQuote
13+
<span class="k">operation</span> receiveAndCheckQuote <span class="k">delegates</span> <span class="k">to</span> QuoteRequest[RECEIVED -&gt; REJECTED <span class="k">X</span> ACCEPTED <span class="k">X</span> EXPIRED] <span class="k">emits</span> <span class="k">event</span> QuoteRejected <span class="k">X</span> QuoteAccepted <span class="k">X</span> QuoteExpired
14+
<span class="k">event</span> QuoteAccepted <span class="k">triggers</span> <span class="k">operation</span> accept
15+
<span class="k">operation</span> accept <span class="k">delegates</span> <span class="k">to</span> QuoteRequest[ACCEPTED -&gt; POLICY_CREATED <span class="k">X</span> EXPIRED] <span class="k">emits</span> <span class="k">event</span> PolicyCreated <span class="k">X</span> QuoteExpired
16+
}
17+
}
18+
<span class="k">Aggregate</span> QuoteRequest {
19+
<span class="k">Entity</span> Request {
20+
<span class="k">aggregateRoot</span>
21+
}
22+
<span class="k">DomainEvent</span> RequestSubmitted
23+
<span class="k">DomainEvent</span> QuoteReceived
24+
<span class="k">DomainEvent</span> RequestRejected
25+
<span class="k">DomainEvent</span> QuoteRejected
26+
<span class="k">DomainEvent</span> QuoteAccepted
27+
<span class="k">DomainEvent</span> QuoteExpired
28+
<span class="k">DomainEvent</span> PolicyCreated
29+
<span class="k">Service</span> QuoteRequestService {
30+
<span class="k">void</span> submitRequest(@Request request);
31+
<span class="k">void</span> checkRequest(@Request request);
32+
<span class="k">void</span> receiveAndCheckQuote(@Request request);
33+
<span class="k">void</span> reject(@Request request);
34+
<span class="k">void</span> accept(@Request request);
35+
}
36+
<span class="k">enum</span> RequestState {
37+
<span class="k">aggregateLifecycle</span>
38+
SUBMITTED, RECEIVED, REJECTED, ACCEPTED, EXPIRED, POLICY_CREATED
39+
}
40+
}
41+
}
42+
</pre></div>

‎_cmls/application-layer-example-1.cml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
BoundedContext ClaimsManagement {
2+
Application {
3+
Service ClaimsApplicationService {
4+
void submitClaim(@Claim claim);
5+
void checkInsurance(@Claim claim);
6+
}
7+
8+
Command AcceptClaim {
9+
- Claim claim
10+
}
11+
Command RejectClaim {
12+
- Claim claim
13+
}
14+
}
15+
16+
Aggregate Claims {
17+
Entity Claim {
18+
aggregateRoot
19+
long claimId
20+
CustomerId customer
21+
String description
22+
Blob requestDocument
23+
boolean isComplete
24+
boolean isAssessed
25+
- ClaimState claimState
26+
}
27+
enum ClaimState {
28+
aggregateLifecycle
29+
OPEN, REJECTED, ACCEPTED
30+
}
31+
}
32+
}

‎_cmls/application-layer-example-1.html

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<div class="highlight"><pre><span></span><span class="k">BoundedContext</span> ClaimsManagement {
2+
<span class="k">Application</span> {
3+
<span class="k">Service</span> ClaimsApplicationService {
4+
<span class="k">void</span> submitClaim(@Claim claim);
5+
<span class="k">void</span> checkInsurance(@Claim claim);
6+
}
7+
8+
<span class="k">Command</span> AcceptClaim {
9+
- <span class="k">Claim</span> claim
10+
}
11+
<span class="k">Command</span> RejectClaim {
12+
- <span class="k">Claim</span> claim
13+
}
14+
}
15+
16+
<span class="k">Aggregate</span> Claims {
17+
<span class="k">Entity</span> Claim {
18+
<span class="k">aggregateRoot</span>
19+
<span class="k">long</span> claimId
20+
CustomerId <span class="k">customer</span>
21+
<span class="k">String</span> description
22+
<span class="k">Blob</span> requestDocument
23+
<span class="k">boolean</span> isComplete
24+
<span class="k">boolean</span> isAssessed
25+
- <span class="k">ClaimState</span> claimState
26+
}
27+
<span class="k">enum</span> ClaimState {
28+
<span class="k">aggregateLifecycle</span>
29+
OPEN, REJECTED, ACCEPTED
30+
}
31+
}
32+
}
33+
</pre></div>

‎_cmls/lang-ref-aggregate-1.cml

+14-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ Aggregate Contract {
1010
- List<Product> products
1111
}
1212

13+
enum States {
14+
aggregateLifecycle
15+
16+
CREATED, POLICE_CREATED, RECALLED
17+
}
18+
1319
ValueObject ContractId {
1420
int contractId key
1521
}
@@ -19,4 +25,11 @@ Aggregate Contract {
1925
- Contract contract
2026
BigDecimal price
2127
}
22-
}
28+
29+
Service ContractService {
30+
@ContractId createContract(@Contract contrace) : write [ -> CREATED];
31+
@Contract getContract(@ContractId contractId) : read-only;
32+
boolean createPolicy(@ContractId contractId) : write [ CREATED -> POLICE_CREATED ];
33+
boolean recall(@ContractId contractId) : write [ CREATED, POLICE_CREATED -> RECALLED ];
34+
}
35+
}

‎_cmls/lang-ref-aggregate-1.html

+14-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,13 @@
77

88
- <span class="k">ContractId</span> identifier
99
- <span class="k">Customer</span> client
10-
- <span class="k">List&lt;Product&gt;</span> products
10+
- <span class="k">List</span>&lt;Product&gt; products
11+
}
12+
13+
<span class="k">enum</span> States {
14+
<span class="k">aggregateLifecycle</span>
15+
16+
CREATED, POLICE_CREATED, RECALLED
1117
}
1218

1319
<span class="k">ValueObject</span> ContractId {
@@ -19,5 +25,12 @@
1925
- <span class="k">Contract</span> contract
2026
<span class="k">BigDecimal</span> price
2127
}
28+
29+
<span class="k">Service</span> ContractService {
30+
@ContractId createContract(@Contract contrace) : <span class="k">write</span> [ -&gt; CREATED];
31+
@Contract getContract(@ContractId contractId) : <span class="k">read</span>-<span class="k">only</span>;
32+
<span class="k">boolean</span> createPolicy(@ContractId contractId) : <span class="k">write</span> [ CREATED -&gt; POLICE_CREATED ];
33+
<span class="k">boolean</span> recall(@ContractId contractId) : <span class="k">write</span> [ CREATED, POLICE_CREATED -&gt; RECALLED ];
34+
}
2235
}
2336
</pre></div>

‎_cmls/lang-ref-aggregate-16.cml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
enum States {
2+
aggregateLifecycle
3+
CREATED, POLICE_CREATED, RECALLED
4+
}

‎_cmls/lang-ref-aggregate-16.html

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<div class="highlight"><pre><span></span><span class="k">enum</span> States {
2+
<span class="k">aggregateLifecycle</span>
3+
CREATED, POLICE_CREATED, RECALLED
4+
}
5+
</pre></div>

‎_cmls/lang-ref-aggregate-17.cml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Service ContractService {
2+
@ContractId createContract(@Contract contrace) : write;
3+
@Contract getContract(@ContractId contractId) : read-only;
4+
boolean createPolicy(@ContractId contractId) : write;
5+
boolean recall(@ContractId contractId) : write;
6+
}

‎_cmls/lang-ref-aggregate-17.html

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<div class="highlight"><pre><span></span><span class="k">Service</span> ContractService {
2+
@ContractId createContract(@Contract contrace) : <span class="k">write</span>;
3+
@Contract getContract(@ContractId contractId) : <span class="k">read</span>-<span class="k">only</span>;
4+
<span class="k">boolean</span> createPolicy(@ContractId contractId) : <span class="k">write</span>;
5+
<span class="k">boolean</span> recall(@ContractId contractId) : <span class="k">write</span>;
6+
}
7+
</pre></div>

‎_cmls/lang-ref-aggregate-18.cml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Service ContractService {
2+
@ContractId createContract(@Contract contrace) : write [ -> CREATED];
3+
@Contract getContract(@ContractId contractId) : read-only;
4+
boolean createPolicy(@ContractId contractId) : write [ CREATED -> POLICE_CREATED ];
5+
boolean recall(@ContractId contractId) : write [ CREATED, POLICE_CREATED -> RECALLED ];
6+
}

‎_cmls/lang-ref-aggregate-18.html

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<div class="highlight"><pre><span></span><span class="k">Service</span> ContractService {
2+
@ContractId createContract(@Contract contrace) : <span class="k">write</span> [ -&gt; CREATED];
3+
@Contract getContract(@ContractId contractId) : <span class="k">read</span>-<span class="k">only</span>;
4+
<span class="k">boolean</span> createPolicy(@ContractId contractId) : <span class="k">write</span> [ CREATED -&gt; POLICE_CREATED ];
5+
<span class="k">boolean</span> recall(@ContractId contractId) : <span class="k">write</span> [ CREATED, POLICE_CREATED -&gt; RECALLED ];
6+
}
7+
</pre></div>

‎_cmls/lang-ref-aggregate-19.cml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// an initial state:
2+
-> CREATED
3+
4+
// simple state transition from one state into the other
5+
CREATED -> CHECK_REQUESTED
6+
7+
// the left side can contain multiple states:
8+
// (this means that the state on the right can be reached by any of those on the left side)
9+
CREATED, CHECK_REQUESTED -> CHECK_IN_PROGRESS
10+
11+
// multiple target states possible
12+
// X stands for XOR and means one OR the other will be reached but not both at the same time (exclusive OR)
13+
CHECK_IN_PROGRESS -> ACCEPTED X REJECTED
14+
15+
// target states can be marked as end states with a star:
16+
CHECK_IN_PROGRESS -> ACCEPTED* X REJECTED*
17+
18+
// a combination of multiple on the left and multiple on the right
19+
CREATED, CHECK_REQUESTED -> ACCEPTED X REJECTED

‎_cmls/lang-ref-aggregate-19.html

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<div class="highlight"><pre><span></span><span class="c">// an initial state:</span>
2+
-<span class="k">&gt;</span> CREATED
3+
4+
<span class="c">// simple state transition from one state into the other</span>
5+
CREATED -&gt; CHECK_REQUESTED
6+
7+
<span class="c">// the left side can contain multiple states:</span>
8+
<span class="c">// (this means that the state on the right can be reached by any of those on the left side)</span>
9+
CREATED, CHECK_REQUESTED -&gt; CHECK_IN_PROGRESS
10+
11+
<span class="c">// multiple target states possible</span>
12+
<span class="c">// X stands for XOR and means one OR the other will be reached but not both at the same time (exclusive OR)</span>
13+
CHECK_IN_PROGRESS -&gt; ACCEPTED <span class="k">X</span> REJECTED
14+
15+
<span class="c">// target states can be marked as end states with a star:</span>
16+
CHECK_IN_PROGRESS -&gt; ACCEPTED* <span class="k">X</span> REJECTED*
17+
18+
<span class="c">// a combination of multiple on the left and multiple on the right</span>
19+
CREATED, CHECK_REQUESTED -&gt; ACCEPTED <span class="k">X</span> REJECTED
20+
</pre></div>

‎_cmls/lang-ref-application-layer-example-1.cml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
BoundedContext ClaimsManagement {
2+
Application {
3+
Service ClaimsApplicationService {
4+
void submitClaim(@Claim claim);
5+
void checkInsurance(@Claim claim);
6+
void acceptClaim(@Claim claim);
7+
void rejectClaim(@Claim claim);
8+
}
9+
}
10+
11+
Aggregate Claims {
12+
Entity Claim {
13+
aggregateRoot
14+
long claimId
15+
CustomerId customer
16+
String description
17+
Blob requestDocument
18+
boolean isComplete
19+
boolean isAssessed
20+
- ClaimState claimState
21+
}
22+
enum ClaimState {
23+
aggregateLifecycle
24+
OPEN, REJECTED, ACCEPTED
25+
}
26+
27+
abstract DomainEvent ClaimEvent {
28+
long claimId
29+
Date timestamp
30+
}
31+
DomainEvent ClaimSubmitted extends ClaimEvent
32+
DomainEvent ClaimAccepted extends ClaimEvent
33+
DomainEvent ClaimRejected extends ClaimEvent
34+
}
35+
}

0 commit comments

Comments
 (0)