Edo is the official code generator tool for Entando, started with love by Stefano Puddu [email protected] and maintained with pride by the Entando dev team.
Use it to generate the following parts of Entando Components with a single command:
- Pojo
- DAO, Manager, events
- Entando component descriptor and related files
- REST API
- Backoffice actions, validations, tiles and JSPs
- A basic set of utility classes for JUnit tests
- Widgets, custom tags
- InternalServlet widget
- Final report
- Permit to pick what's to be generated
If you obtained Edo as a pre-compiled binary package, follow these easy installation steps:
- Copy
edo-x.y.z.jarinto a folder of your choice - (Optional for OS X and *nix systems) configure a shell alias like so:
alias edo="java -jar /folder-of-your-choice/edo-x.y.z.jar"
The source comes with an Ant script, and you'll need Ant 1.9+ to make it work.
The build-and-install Ant task is the default one, so you just have to run:
$ ant
- (Ant bug) Open
build-maven.xmland replace any occurrency ofexecutable="mvn"withexecutable="mvn.bat" - Build (see next section)
- Copy
target/edo-x.y.z.jarinto a folder of your choice
$ ant build
$ java -jar <PATH_TO_YOUR_JAR>/edo-x.y.z.jar [options] beanName field#1 field#2 ... field#n
Example:
$ java -jar <PATH_TO_YOUR_JAR>/edo-x.y.z.jar [options] Zombie name:string-r deathDate:date
$ edo [options] beanName field#1 field#2 ... field#n
Example:
$ edo [options] Zombie name:string-r deathDate:date
- --baseDir
The path of the main directory, the root folder of your project. If not specified, will be used the current directory.
Apom.xmlfile must exist in the same directory. - --permission
Thecodeof an existing Entando permission.
If not specified, default value is superuser - --package
The package that will be used.
If not specified, Edo will create a package following the Entando Plugin Pattern
$ edo --baseDir=/tmp Foo name:string
$ edo --baseDir=/tmp --package=org.entando.entando.plugins.jppet Cat name:string
$ edo --baseDir=/tmp --package=com.mycompany -permission=manage_pet Dog name:string
- bean name:
The name of the bean - field definition:
The field name, followed by the field data type and field options
- string
- int
- date
- bigdecimal
- primary_key
- -:
The separator between field data type and field options - r:
Flags a field as required - {1...n} (i.e. an integer)
Available only for thestringdata type, forces the max lentgh up to this value
Examples:
$ edo Foo name:string
$ edo Foo name:string-8
$ edo Foo name:string-8r
$ edo Foo name:string-r8
By default Edo creates a id:int field and uses it as the primary key.
If you want to specify a different name for the primary key, declare it as first field using the primary_key field data type.
Example:
$ edo Foo fooid:primary_key name:string
Edo will overwrite any existing file, so be careful.
Only the following files won't get overwritten, because these files are meant to exist just once per Plugin:
Note: [sub-path] can be the project name or plugins/jp[beanName]
src/main/resources/api/[sub-path]/aps/apiMethods.xmlsrc/main/resources/entando-struts-plugin.xmlsrc/main/resources/component/[sub-path]/component.xmlsrc/main/resources/shortcuts/[sub-path]/apsadmin/shortcuts.xmlsrc/main/resources/sql/[sub-path]/port_data_production.sqlsrc/main/resources/sql/[sub-path]/serv_data_production.sqlsrc/main/tld/[sub-path]/name-core.tldsrc/main/webapp/WEB-INF/[sub-path]/apsadmin/tiles.xmlsrc/main/webapp/WEB-INF/[sub-path]/apsadmin/jsp/common/layouts/subMenu.jspsrc/test/resources/sql/[sub-path]/port_data_test.sqlsrc/test/resources/sql/[sub-path]/serv_data_test.sql
In a project named myportal, given the following command line
$ edo --package=org.mycompany Foo name:string-r10
Edo will create these files:
├── edo_YYYYMMdd_HHmmss_Foo-report.txt
└── src
├── main
│ ├── java
│ │ └── org
│ │ └── mycompany
│ │ ├── aps
│ │ │ ├── internalservlet
│ │ │ │ └── foo
│ │ │ │ ├── FooFinderFrontEndAction.java
│ │ │ │ ├── FooFrontEndAction.java
│ │ │ │ └── fooFront.xml
│ │ │ ├── system
│ │ │ │ ├── init
│ │ │ │ │ └── servdb
│ │ │ │ │ └── Foo.java
│ │ │ │ └── services
│ │ │ │ └── foo
│ │ │ │ ├── api
│ │ │ │ │ ├── FooListResponse.java
│ │ │ │ │ ├── FooListResponseResult.java
│ │ │ │ │ ├── FooResponse.java
│ │ │ │ │ ├── FooResponseResult.java
│ │ │ │ │ └── JAXBFoo.java
│ │ │ │ ├── event
│ │ │ │ │ ├── FooChangedEvent.java
│ │ │ │ │ └── FooChangedObserver.java
│ │ │ │ ├── FooDAO.java
│ │ │ │ ├── Foo.java
│ │ │ │ ├── FooManager.java
│ │ │ │ ├── IFooDAO.java
│ │ │ │ └── IFooManager.java
│ │ │ └── tags
│ │ │ ├── FooListTag.java
│ │ │ └── FooTag.java
│ │ └── apsadmin
│ │ ├── foo
│ │ │ ├── FooAction.java
│ │ │ ├── FooAction-validation.xml
│ │ │ ├── FooFinderAction.java
│ │ │ ├── foo.xml
│ │ │ ├── package_en.properties
│ │ │ └── package_it.properties
│ │ └── portal
│ │ └── specialwidget
│ │ └── foo
│ │ ├── FooConfigAction.java
│ │ ├── fooSpecialWidget.xml
│ │ ├── package_en.properties
│ │ └── package_it.properties
│ ├── resources
│ │ ├── api
│ │ │ └── myportal
│ │ │ └── aps
│ │ │ └── apiMethods.xml
│ │ ├── component
│ │ │ └── myportal
│ │ │ └── component.xml
│ │ ├── entando-struts-plugin.xml
│ │ ├── shortcuts
│ │ │ └── apsadmin
│ │ │ └── shortcuts.xml
│ │ ├── spring
│ │ │ └── myportal
│ │ │ ├── aps
│ │ │ │ └── managers
│ │ │ │ └── myportalFooManagersConfig.xml
│ │ │ └── apsadmin
│ │ │ └── myportalFooActionsConfig.xml
│ │ └── sql
│ │ └── misc
│ │ └── myportal_foo
│ │ ├── port_data_production.sql
│ │ └── serv_data_production.sql
│ ├── tld
│ │ └── myportal
│ │ └── myportal-core.tld
│ └── webapp
│ └── WEB-INF
│ ├── aps
│ │ └── jsp
│ │ ├── internalservlet
│ │ │ └── foo
│ │ │ ├── frontend-foo-entry.jsp
│ │ │ ├── frontend-foo-error.jsp
│ │ │ ├── frontend-foo-list.jsp
│ │ │ └── frontend-foo-trash.jsp
│ │ └── widgets
│ │ └── Foo.jsp
│ └── myportal
│ └── apsadmin
│ ├── jsp
│ │ ├── common
│ │ │ └── layouts
│ │ │ └── assets-more
│ │ │ ├── foo-entry-extras.jsp
│ │ │ ├── foo-list-extras.jsp
│ │ │ └── foo-trash-extras.jsp
│ │ ├── foo
│ │ │ ├── foo-entry.jsp
│ │ │ ├── foo-list.jsp
│ │ │ └── foo-trash.jsp
│ │ └── portal
│ │ └── specialwidget
│ │ └── foo
│ │ └── foo-config.jsp
│ └── myportal-tiles.xml
└── test
├── java
│ └── org
│ └── mycompany
│ ├── aps
│ │ ├── MyportalBaseTestCase.java
│ │ └── system
│ │ └── services
│ │ └── TestFooManager.java
│ ├── apsadmin
│ │ ├── foo
│ │ │ ├── TestFooAction.java
│ │ │ └── TestFooFinderAction.java
│ │ └── MyportalApsAdminBaseTestCase.java
│ └── MyportalConfigTestUtils.java
└── resources
└── sql
└── misc
└── myportal_foo
├── port_data_test.sql
└── serv_data_test.sql
A lot :D