Fetching latest commit…
Cannot retrieve the latest commit at this time.
1 Azzyzt JEE Tools ================== !!! Release 1.3.2 Azzyzt JEE Tools is a collection of software tools helping software developers to create services using Java Enterprise Edition 6. Use it if you need to create database-backed Java EE services callable via CORBA/IIOP, SOAP or REST. Azzyzt JEE Tools are designed to be integrated into popular Java IDEs and to work with Java EE runtimes starting from Java EE 6. The primary targets are GlassFish as Java EE server and Eclipse as IDE. Copyright (c) 2011, Municipiality of Vienna, Austria Licensed under the EUPL, Version 1.1 or subsequent versions If you're new to Azzyzt JEE Tools, a good way to get started is to work through the tutorial in using_azzyzt.html in the source distribution's doc directory. For a change log see changelog.html. The complete sources are on GitHub under https://github.com/amanessinger/azzyzt_jee_tools. 1.1 Current status ~~~~~~~~~~~~~~~~~~ As of release 1.3.2, Azzyzt JEE Tools consists of three main parts: 1. a project generator that creates so-called azzyzted projects. An azzyzted project is a collection of four projects, an Enterprise Application Project (EAR project), an Enterprise Java Beans project (EJB project), its client project (EJB client project) and a Dynamic Web Project (servlet project). The EJB project contains all business code, the servlet project contains REST wrappers around business methods, the EJB client project contains all data types visible to SOAP or REST clients. These three are called member projects. The EAR project is a container for the member projects. The project generator uses a project base name, a package prefix and an Eclipse runtime specification capable of supporting EJB 3.1, and from that it creates the four projects. The EJB project is marked with a special "azzyzted nature". 2. an application code generator that analyzes JPA entities in azzyzted projects, and uses that information to create a base application. This application is a set of service beans exposed as SOAP and REST services. They offer access to the database as it is commonly used by CRUD applications. All generated code is in dedicated source folders. The generated application can be extended and the extensions may use generated code like DTOs as building blocks. 3. a runtime library of code used by generated applications. The structure of azzyzted projects and the structure of generated code evolved from the work on An Eclipse / GlassFish / Java EE 6 Tutorial and on usage of that tutorial in a subsequent internal training class for developers at the Municipiality of Vienna, Austria. Although Azzyzt JEE Tools come as a set of extensions to the Eclipse IDE, large portions of the code are independent of Eclipse. Given a project structure like that created by #1, #2 could be called from any IDE and can even be used without an IDE, because it can be called from the command line. Azzyzt JEE Tools are known to work with the runtimes of * GlassFish v3.01 * GlassFish v3.1 * GlassFish v3.1.1 * GlassFish v3.1.2 and Eclipse versions * Galileo SR2 * Helios SR1, SR2 * Indigo * Indigo SR1, SR2 In the context of this documentation Eclipse is always assumed as the generic bundle Eclipse IDE for Java EE Developers. Other distributions may contain the required plugins and may work, but they were not tested. The plugins were compiled on Eclipse 3.7 "Indigo" SR2 using Java 1.6.0_31, and they were tested in the following configurations: * Galileo SR2 + GlassFish 3.01 * Helios SR1 + GlassFish 3.01 * Helios SR2 + GlassFish 3.1 * Indigo SR1 + GlassFish 3.1.1 * Indigo SR2 + GlassFish 3.1.2 These are typical configurations of Eclipse versions together with versions of GlassFish, that were current at that time. They are supposed to be in use most often. All tests were done with JDK 1.6. No other application servers but GlassFish were tested. While in theory all servers complying to the Java EE 6 full profile should work, they are completely unsupported. Future extensions may provide generators for additional patterns commonly used in Java EE applications. Contributions to Azzyzt JEE Tools are welcome. Possible areas include support for additional Java IDEs, additional patterns, additional runtimes, etc. Of course bug fixes are welcome as well. Azzyzt JEE Tools were developed by Andreas Manessinger for the Municipal Department 14 - Automated Data Processing, Information and Communications Technology (MA 14) of the City of Vienna, Austria 1.2 Licenses ~~~~~~~~~~~~ Licensed under the EUPL, Version 1.1 or as soon they will be approved by the European Commission - subsequent versions of the EUPL (the "Licence"); You may not use this work except in compliance with the Licence. For convenience a plain text copy of the English version of the Licence can be found in the file LICENCE.txt in the top-level directory of this software distribution. You may obtain a copy of the Licence in any of 22 European Languages at: http://www.osor.eu/eupl Unless required by applicable law or agreed to in writing, software distributed under the Licence is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licence for the specific language governing permissions and limitations under the Licence. For the purpose of generating code, Azzyzt JEE Tools make use of and bundles a copy of StringTemplate, which is Copyright (c) 2008, Terence Parr All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. The code generator uses Apache Commons IO which is licensed under the Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. This documentation was created using Deplate.  using_azzyzt.html  changelog.html  https://github.com/amanessinger/azzyzt_jee_tools  http://programming.manessinger.com/tutorials/an-eclipse-glassfish-java-ee-6-tutorial/  http://www.eclipse.org/downloads/  http://programming.manessinger.com  http://www.wien.gv.at/english/administration/ict/  http://www.stringtemplate.org/  http://commons.apache.org/io/  http://deplate.sourceforge.net/