Project

General

Profile

Wiki » History » Version 30

Henning Blohm, 28.01.2015 16:15

1 1 Henning Blohm
h1. Intro
2
3 2 Henning Blohm
This project is for the development of [[z2-environment:wiki|z2-environment]] version 3.0.
4 1 Henning Blohm
5 2 Henning Blohm
Version 3.0 is a major refactoring release of z2 with new repository code lines and complete package renaming.
6 1 Henning Blohm
7 2 Henning Blohm
h1. Essential Differences between v2.3 and v3.
8 1 Henning Blohm
9 2 Henning Blohm
* All the typical declarations and package names are no longer *com.zfabrik.<something>* but rather *org.z2env.<something>*
10 13 Henning Blohm
* The <z2 home> layout is completely new and more flexible
11 3 Henning Blohm
* The essential component types that can be _invoked_ from the core is *system state* and *main program*.
12 14 Henning Blohm
* While Jetty is still contained to support Eclipsoid and z2Unit, we support a pre-installed Tomcat as application container (and with TomEE would even get a Java EE profile)
13 1 Henning Blohm
* The core is lighter and more dedicated. 
14 12 Henning Blohm
* There will be substantially less built-in application support like
15
** a local JTA implementation 
16
** No worker suppport without a corresponding add-on.
17 1 Henning Blohm
18 12 Henning Blohm
The main task of v3 is:
19 13 Henning Blohm
* Make the lower parts of z2 more accessible and easier to understand: While z2 previously started System Centric, we now close the gap from the ordinary main program.
20 12 Henning Blohm
* Increase the OSS flavor of z2
21
22 15 Henning Blohm
Obvious TODOs:
23
* Finish Java 8 support
24
* Test TomEE
25
* Fix Eclipsoid templates
26
* Support MVNCR, also for distributions
27 12 Henning Blohm
28 9 Henning Blohm
h1. Draft Intro Documentation
29 1 Henning Blohm
30 2 Henning Blohm
h2. Getting Started
31 1 Henning Blohm
32 2 Henning Blohm
To understand how z2 works, you need to understand at most what are z2 modules and components and what are component repositories and how these concepts interplay. 
33 1 Henning Blohm
34 6 Henning Blohm
Check out [[wiki#Understanding-Z2|understanding-z2]] for that.
35 1 Henning Blohm
36 2 Henning Blohm
It is simplest to start by running a simple Java main program in z2 or a simple Web App. 
37 1 Henning Blohm
38 2 Henning Blohm
Follow this trail:
39 1 Henning Blohm
40 4 Henning Blohm
* [[wiki#Building-z2env-core|Building the core]]
41 7 Henning Blohm
* [[wiki#Running-a-Hello-World-main-program|Running a Hello World main program]]
42 10 Henning Blohm
* [[wiki#Running-a-Hello-World-Web-App|Running a Hello World Web App]]
43 22 Henning Blohm
* [[wiki#Developing-with-Eclipse-or-IntelliJ|Developing with Eclipse or IntelliJ]]
44 1 Henning Blohm
45 22 Henning Blohm
46
47 3 Henning Blohm
h2. Building z2env-core
48 1 Henning Blohm
49 17 Henning Blohm
(For now, we need to build the core).
50
51
h3. Pre-requisites
52
53
* You need Git installed
54
* You need a JDK, at least version 7
55
* You need the ANT build tool
56
57 3 Henning Blohm
First clone http://git.z2-environment.net/z2env.core
58
59
<pre>
60
git clone http://git.z2-environment.net/z2env.core
61
</pre>
62
63 25 Henning Blohm
Change into *org.z2env.core.main* and run 
64 3 Henning Blohm
65
<pre>
66 18 Henning Blohm
ant -Doutput=<z2home> -Dsetup=<setup> 
67 3 Henning Blohm
</pre>
68
69 18 Henning Blohm
where <z2home> is where you want to install z2 (the *z2 home* that is) and <setup> is a choice of pre-configured content, actually component repositories.
70 3 Henning Blohm
71
If you omit *output* it will default to *gen/dist*. If you omit *setup*, no content will be pre-configured will be modified. 
72
73
Check the folder *setups* for available setups of the core build. These can be local (all repos will be cloned locally) or remote (repos will be remoted).
74
75 1 Henning Blohm
In general this build always updates only boot, z.jar, roots. It will not remove anything.
76
77 18 Henning Blohm
78 3 Henning Blohm
Example to install/update a core only into ../../z2env:
79
80
<pre>
81 24 Henning Blohm
ant -Doutput=../../z2env 
82 3 Henning Blohm
</pre>
83
84 1 Henning Blohm
To install/update a web-basic setup (with tomcat and eclipsoid support) with updates from remote repos:
85
86
<pre>
87 3 Henning Blohm
ant -Doutput=../../z2env -Dsetup=web-basic-remote
88
</pre>
89 19 Henning Blohm
90
Check out [[wiki#Understanding-the-ltHOMEgt|Understanding the <HOME>]] to learn more about the generated structure.
91
92 7 Henning Blohm
93
h2. Running a Hello World main program
94
95
For now, we will assume you have a z2 core installed in <HOME>. In its purest form, all the core can actually execute is simple Java main programs. 
96
97
Being in a modular environment, even if we only want to say „Hello World“, we need a module. Let's call it the greeter module. In order to have a main program run by z2, we need to also declare a  component for it, as that is what we tell z2 to run (not a class – mind you – but rather a component in a module). Assuming we use the local component name hello, than the absolut component name is 
98
99
<pre>
100
greeter/hello
101
</pre>
102
103
Finally, as this component actually has implementation code, we need to declare a Java component. By convention this is 
104
105
<pre>
106
greeter/java
107
</pre>
108
109
Now, after installing in <HOME> the place to simply drop a module is under <HOME>/modules. All in all, here is the complete structure to create:
110
111
| <HOME>/modules/greeter/hello.properties | 
112
<pre><code class="ruby">org.z2env.component.type=org.z2env.main
113
component.className=greetings.Main
114
</code></pre> |
115
| <HOME>/modules/greeter/java/z.properties | 
116
<pre><code class="ruby">org.z2env.component.type=org.z2env.java
117
</code></pre> |
118
| <HOME>/modules/greeter/java/src.impl/greetings/Main.java |
119
<pre><code class="java">
120
package greetings;
121
122
public class Main {
123
  public static void main(String[] args) {
124 8 Henning Blohm
    System.out.println("Hello!");
125 7 Henning Blohm
  }
126
}
127
</code></pre> |
128
129
That gives us the two components of module greeter. To run this on the command line, run
130
131
<pre>
132
java -DcomponentName=greeter/hello -jar z.jar
133
</pre>
134
135 1 Henning Blohm
Now, obviously this sample is not worth a modular execution environment. But even from here, you could check your module in with some Git repository that is referenced from the roots and all other users of the same repo would be able to run your component without installing anything.
136 10 Henning Blohm
137
h2. Running a Hello World Web App
138
139 11 Henning Blohm
This introduction explains how to connect a z2 core to a given Tomcat installation and how to develop a simple Web Application.
140 7 Henning Blohm
141 11 Henning Blohm
Furthermore it describes how to use the Dev Repository and the Eclipsoid plugin for the Eclipse or the IntelliJ development environment.
142
143
h3. Pre-Requisites
144
145
* We assume a development workspace in *workspace*.
146
* Have a local Tomcat (7 or higher) installation.*
147
148
h3. Steps we are going to take
149
150
# Create a module with a simple Web app
151
# Make it visible to Z2
152
# Run the Web App in a Tomcat Web Container
153
154
At first get yourself a z2env core with the *web-basic-local* or *web-basic-remote* setup. Make sure it is in your *workspace*. If you follow [[wiki#Building-z2env-core|Building the core]] this means running 
155
156
<pre>
157
ant -Doutput=workspace/z2env -Dsetup=web-basic-remote
158
</pre>
159
160 26 Henning Blohm
(*Note:* If in doubt, use an absolute path for *workspace*)
161 1 Henning Blohm
162 26 Henning Blohm
Using your IDE create a new project *hello* in *workspace* with the following structure:
163 11 Henning Blohm
164
| java/z.properties | 
165
<pre><code class="ruby">
166
org.z2env.component.type=org.z2env.java
167
java.privateReferences=\
168
	javax.servlet
169
</code></pre> |
170
| web/z.properties |
171
<pre><code class="ruby">
172
org.z2env.component.type=org.z2env.tomcat.webapp
173
webapp.path=/hello
174
</code></pre> |
175
| web/WebContent/index.jsp |
176
<pre><code class="html"><html><body>Hello! Did you know that 7*7=<%=7*7%>?</body></html></code></pre> |
177
| LOCAL | <empty file> |
178
179 20 Henning Blohm
Your *workspace* folder now contains two subfolders *z2env* and *hello*.
180
181 11 Henning Blohm
So far, that's it.  We will touch on the LOCAL file later. 
182
183
When we run Z2 knowing this Web Application, it will attempt to start a Tomcat Web Container that will serve the application's content. To do that, it needs to find one. 
184
185
In order to tell Z2 where to look, you can either set an environment variable *CATALINA_HOME* (you might have already – it's the Tomcat standard) or specify an environment variable *catalina.home*. 
186
187
To be on the safe side and assuming the location is */home/me/tomcat*, we open a terminal, change into *workspace/z2env* and run
188
189
<pre>
190
java -Dcatalina.home=/home/me/tomcat -jar z.jar hello/web
191
</pre>
192
193
Note, unlike for the main program, the command line will not return. Instead you can enter „q“ to quit or „s“ to synchronize. But first let's open a browser and check out 
194
195
<pre>
196
http://localhost:8080/hello
197
</pre>
198
199 28 Henning Blohm
*Note:* What you just created is a prototypical z2 module structure containing a Java component *java* (holding implementation) and a Web component *web*. 
200 1 Henning Blohm
201 28 Henning Blohm
Instead of creating the structure yourself, you could use the Eclipsoid plugin (introduced below) for that:
202
* In Eclipse: New / Others / new z2...., 
203
* In IntelliJ: New / Module / z2....
204 1 Henning Blohm
205 28 Henning Blohm
... but beware of the pre-generated configuration. Where it says *com.zfabrik* change to *org.z2env*.
206 27 Henning Blohm
207 28 Henning Blohm
208
*Note:* Now on to that LOCAL file. Unlike for the Hello World main program, this time it was to so-called Dev Repo that made our module available to z2. 
209 11 Henning Blohm
210
The dev repo is a key component to the development approach with z2. It checks for all modules that have a LOCAL file and that are stored some levels deep, relative to the parent folder of the z2 home (by default), which not so coincidentally is our workspace.
211
212
Try this: 
213
214
# Remove LOCAL
215
# Enter „s“ for synchronization. 
216
# Check the URL above (should say „not found“)
217
# Create a LOCAL file again
218
# Synchronize
219
# Check again.
220 1 Henning Blohm
221 11 Henning Blohm
Similarly, from now on, changes made to the hello module will be picked up, whenever you synchronize.
222 1 Henning Blohm
223 22 Henning Blohm
h2. Developing with Eclipse or IntelliJ
224 1 Henning Blohm
225 21 Henning Blohm
In this section we will add some code to the hello Web app and see how to develop using an integrated development environment like the Eclipse IDE or Jetbrains' IntelliJ IDEA.
226 1 Henning Blohm
227 21 Henning Blohm
h3. Pre-Requisite
228 1 Henning Blohm
229 21 Henning Blohm
* Have an Eclipse or IntelliJ installation
230
* Install the Eclipsoid plugin from http://z2-environment.net/eclipsoid/update/site.xml or by searching for "z2" in the IntelliJ Plugin Repository respectively
231
232
h3. Steps we are going to take
233
234
# Complete the development workspace setup
235
# Add a simple Controller
236
237
h4. In Eclipse
238
239
Use the workspace *workspace*. Create a Java project *hello* where we created the *hello* module. That is, we use the existing module as project content. You should now have an Eclipse development workspace that has one Java project named "hello". Right-click on the project and choose "Transform into z2 Project". A small "Z" icon should not decorate the project icon. 
240
241 30 Henning Blohm
Add a source folder *java/src.impl* to the project.
242
243 21 Henning Blohm
Try "Arm Z2 Projects" and "Disarm Z2 Projects" from the context menu. You should see a LOCAL file showing up and disappearing as well as the "Z" decoration showing a green halo and going back to normal. 
244
245
Go into Window/Preferences, pick "z2-Environment". Change the port to 8081, set the user to "z*" and the password to "z". Done.
246
247
h4. In IntelliJ
248
249 30 Henning Blohm
Add a source folder *java/src.impl* to the module.
250
251 21 Henning Blohm
Start a new Project with root folder *workspace*. Press the "Manage z2-Modules" button in the toolbar. Import the *hello* module into your IntelliJ project. Open the Settings dialog, pick "z2-Environment". Change the port to 8081, set the user to "z*" and the password to "z". Done.
252
253
h4. IDE Indepently
254
255
Start z2 as in the previous section but make sure the development support is enabled. Use this command line:
256
257
<pre>
258
java -Dcatalina.home=/home/me/tomcat -jar z.jar org.z2env.dev.shared/ready hello/web
259
</pre>
260
261
(possibly you want to turn this into a shell script)
262
263 23 Henning Blohm
*Note:* The _system state_ *org.z2env.dev.shared/ready* will pull up all necessary development support components. Make sure this is part of your to-be-run list.
264 1 Henning Blohm
265 29 Henning Blohm
266 1 Henning Blohm
Regardless whether you are using Eclipse or IntelliJ, press the "Resolve Classpath from Z2" button in the toolbar. This will make sure that all required dependencies for Z2 modules, as far as Java code is concerned, will be resolved for your workspace. 
267 29 Henning Blohm
268 30 Henning Blohm
Now add a class *SimpleController* and change the following files:
269 21 Henning Blohm
270 22 Henning Blohm
| java/src.impl/hello/SimpleController.java | 
271 21 Henning Blohm
<pre><code class="java">
272
package hello;
273
274
import javax.servlet.*;
275
import javax.servlet.http.*;
276
import java.io.IOException;
277
278
public class SimpleController extends HttpServlet {
279
280
    @Override
281
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
282
        String input = req.getParameter("input");
283
        if (input!=null && input.trim().length()>0) {
284
            req.setAttribute("output","You said: "+input);
285
        }
286
        req.getRequestDispatcher("/").forward(req,resp);
287
    }
288
}
289
</code></pre> |
290
| java/z.properties | 
291
<pre><code class="ruby">
292
org.z2env.component.type = org.z2env.java
293
294
java.privateReferences=\
295
  javax.servlet,\
296
  javax.servlet.jsp.jstl
297
</code></pre> |
298
| web/WebContent/WEB-INF/web.xml | 
299
<pre><code class="xml">
300
<?xml version="1.0" encoding="UTF-8"?>
301
<web-app id="hello" version="2.5"
302
		xmlns="http://java.sun.com/xml/ns/javaee"
303
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
304
		xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
305
306
    <servlet>
307
        <servlet-name>controller</servlet-name>
308
        <servlet-class>hello.SimpleController</servlet-class>
309
    </servlet>
310
    
311
    <servlet-mapping>
312
        <servlet-name>controller</servlet-name>
313
        <url-pattern>/do</url-pattern>
314
    </servlet-mapping>    
315
</web-app>
316
</code></pre> |
317
| web/WebContent/index.jsp |
318
<pre><code class="html">
319
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core_1_1" %>
320
<html>
321
<body>
322
  <c:if test="${not empty output}">
323
    <p><c:out value="${output}"/></p>
324
  </c:if>
325
  <form method="POST" action="<c:url value='/do'/>">
326
    Input: <input type="text" name="input"><input type="submit" value="go!">
327
  </form>
328
</body>
329
</html>
330
</code></pre>|
331
332
Make sure the *hello* module is armed (right-click) by having a LOCAL file.
333
334
Now synchronize your running z2 by either:
335
336
* Pressing the "Sync with z2-Environment" button in the toolbar
337
* Pressing ALT+y in your IDE
338
* Entering "s" on the command line running z2.
339
340
Go to http://localhost:8080/hello and check it out.
341
342
343
h2. Going Multi-Module
344 12 Henning Blohm
345
TBD
346
347
h2. Going System-Centric
348
349
TBD
350
351
Getting more real by adding a remote repo as system repo.
352
353
Develop by checking out modules and using the Dev Repo.
354 3 Henning Blohm
355 1 Henning Blohm
356 3 Henning Blohm
h2. Understanding the <HOME>
357 1 Henning Blohm
358 18 Henning Blohm
We call an installation of a z2env core a *<home>*. The file structure of the *<home>* consists of few but important locations
359 3 Henning Blohm
360 18 Henning Blohm
h3. Layout
361
362 3 Henning Blohm
| z.jar | The actual core implementation. This is precompiled.|
363
| boot/ | A component repository adding to the core and provides the most basic capabilities such as compiling Java code and running a main program. |
364
| roots/ | A file system component repository that is always registered by the core. This is typically filled with other repository components linking to remote or local component repositories. |
365 1 Henning Blohm
| modules/ | A file system repository declared under roots/ that is useful to locally augment a core installation.|
366
367
We use the modules repository for example for command line experiments and simple hacks. It is not as useful for regular development operations as is the dev repo.
368 18 Henning Blohm
369
h3. Folders and Properties
370
371
When running z2 from the command line, some logic is applied to derive where stuff is and some defaults apply:
372
373
|_. What |_. System property |_. Defaults |
374
| Z2 home - the installation location | org.z2env.home | If no system property is set, the environment variable Z2_HOME will be checked. If that is not set, the z2 home location will be derived from the location of the z.jar file |
375
| Dev Repo workspaces - where the Dev Repo checks for local modules | org.z2env.dev.local.workspaces | Defaults to ${z2.home}/.. assuming modules will be next to the home or one level deeper |
376
377 5 Henning Blohm
378
h2. Understanding Z2
379
380
Most of the concepts that make up z2 can be derived from the desire to efficiently develop standard Java Web Applications that are defined in a central system definition. Add to that the wish to avoid all that build complexity and the desire for a practically usable modularization approach.
381
382
Once you loose the ability to tweak some build script or configuration to describe how to package a Web app or some libraries, you need some structural hint and simple declarations providing sufficient information.
383
384
Secondy, assuming you want to apply changes at runtime, you need some way of determining what to unload at runtime, given some changed file. Again: Structural information needs to present that maps to runtime state. 
385
386
Finally, as we want some support for modular application development anyway, why not make modules our essential structure. As we have not only code but also Web Applications, Data Sources,  Background Jobs and much more to consider, we add components with type into the mix. Voila.
387
388
*Component Repositories* provides modules and components to z2. A component is prefixed by the module name:
389
390
<pre>
391
<global component name> = <module name>/<local component name>
392
</pre>
393
394
In fact, the typical component repository has a file system style structure that is made up exactly like that. 
395
396
Structure from repo root:
397
398
| /<module>/<cmp>.properties | A component <cmp> in module <module> that has no resources on its own.|
399
| /<module>/<cmp>/z.properties | A component <cmp> in module <module> that may have additional resources on its own.|
400
401
Note that some components, like Web applications and typically Java components have file resources, such as HTML files or Java source code files, while other components, such as main program declarations or data source declarations, so not.
402
403
There are some conventions around this naming scheme. In particular, by convention, whenever a component requires Java implementation, z2 will first look for a component named *java* of the same module. As for example in the Hello World example.
404
405
To give you an idea what this model translates to at runtime consider this: At runtime, the static component is turned into a Resource instance by a component type implementation (that, in fact, is provided by another, built-in component type). 
406
407
!uml1.png!
408
409
Dependencies, for example those between Java components, translate into dependencies between resources that are observed during invalidation of resources. This introduces invalidation and synchronization.
410
411 16 Henning Blohm
h3. A crucial concept of z2 is that of a synchronization. 
412 5 Henning Blohm
413
For fast development roundtrips and in some cases for general configuration updates, it is desirable to not require a complete restart of a Java Virtual Machine process but rather just to change runtime state accordingly. 
414
415
In z2 a synchronization describes the following process:
416
417
# Check for changes in component repositories
418
# Based on changes found, identify components affected and invalidate associated runtime resources incl. dependent resources.
419
# Try to attain target states
420
421 1 Henning Blohm
That is, whenever you do a change and trigger a synchronization from your IDE, this is exactly what happens: Identify what needs to be thrown away, make sure to remove dependent stuff as well,  bring up what needs to be running.
422 16 Henning Blohm
423
h3. A second crucial concept of z2 is that of *System Centric Development*
424
425
When working on a software system with many access points and high re-use on a service level, as is typical for business systems, staying quick integration with a team's changes is key. Component repositories can be fed from remotely accessible version control systems such as Subversion and Git. When connecting to a central, team-shared repository, every synchronization will make sure that you are up-to-date with the real source of truth. 
426
427
Using the dev repo, you can still isolate yourself from changes on part of the system that you are actively working on. After your modifications are completed, rebased, and locally tested, getting a clean and consistent state is just one synchronization away.
428
429
h3. The third and final concept is that of a compile-free environment
430
431
It is within the nature of the synchronization concept, that anything required to happen to have your software available for execution must have happened after synchronization completed. Most preparation steps are executed at first use. This includes the compilation of Java code. Z2 uses the Eclipse Java Compiler for that purpose.
432 9 Henning Blohm
433
h2. The Component Model
434
435
See [[z2-environment:Z2_Modules_intro]]
436
437
h2. Java Components
438
439
See [[z2-environment:Z2_Java_components_intro]]