Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "MoDisco/Components/JEE/EjbJar/Documentation/0.9"

< MoDisco‎ | Components‎ | JEE‎ | EjbJar
(Source code)
Line 1: Line 1:
{{MoDiscoTabs|JEE/EjbJar|
+
{{MoDiscoTabs|JEE/EjbJar|{{MoDiscoTab|JEE/EjbJar|Documentation|0.9}}}}
{{MoDiscoTab|JEE/EjbJar|Documentation|0.9}}
+
 
}}
+
 
== Ejb-Jar Discoverer  ==
 
== Ejb-Jar Discoverer  ==
  
The goal of the Generic Ejb-Jar Discoverer plug-in is to allow generic extractions of information from a ejb-jar.xml file, without the need for a metamodel dedicated to a conforming Document Type Definition(DTD) or XML Schema Description (XSD).  
+
The goal of the Generic Ejb-Jar Discoverer plug-in is to allow generic extractions of information from an ejb-jar.xml file, without the need for a metamodel dedicated to a conforming Document Type Definition(DTD) or XML Schema Description (XSD).  
  
 
=== Details  ===
 
=== Details  ===
  
Considering ejb-jar.xml files conforming to DTD or XSD, it will be more convenient to have some dedicated metamodels to manipulate information. However, Generic EjbJar Discoverer is an alternative for miscellaneous ejb-jar.xml files  
+
Considering ejb-jar.xml files conforming to DTD or XSD, it will be more convenient to have some dedicated metamodels to manipulate information. However, the Generic EjbJar Discoverer is an alternative for miscellaneous ejb-jar.xml files.
  
This plug-in aims at analyzing any ejb-jar.xml file providing a model describing the information found. Version supported are JEE 1.2, 1.3, 1.4, 5, 6  
+
This plug-in aims at analyzing any ejb-jar.xml file by providing a model describing the information found. Supported versions are JEE 1.2, 1.3, 1.4, 5, and 6.
 
+
Moreover, it allows to serialize back the xml file from the model. Thus, some m2m transformation might be used jointly to upgrade some xml files.  
+
  
 +
Moreover, it allows to serialize the xml file back from the model. Thus, some M2M transformation might be used jointly to upgrade some xml files.
  
  
Line 22: Line 20:
 
The plug-in provides the user with a contextual menu to easily create models.  
 
The plug-in provides the user with a contextual menu to easily create models.  
  
By right-clicking on a file in the Eclipse Package Explorer view, you can quickly create the model of your configuration file.  
+
To create the model of your configuration file, right-click on the file in the Eclipse '''Package Explorer''' view, and select '''Discovery > Discoverers > Discover JEE ejb-jar.xml''':
 +
 
 +
[[Image:MoDisco_Discover_JEE_EjbJarXML_menu.png|frame|center|Menu to discover an ejb-jar.xml file]]
 +
 
 +
A discovery parameters dialog opens to let you specify the parameters of the discovery:
 +
 
 +
[[Image:MoDisco_Launching_discovery_org.eclipse.modisco.jee.ejbjar.discoverer.png|frame|center|EjbJar discoverer parameters dialog]]
 +
 
 +
* Set '''SERIALIZE_TARGET''' to true if you want to save the model to a file
 +
* You can define '''TARGET_URI''' to the location of a file in your workspace. If it is not defined and SERIALIZE_TARGET is true, a model file will be created in the project.<br>'''Beware: the file will be overwritten if it already exists!'''
 +
 
 +
Once launched, a progress dialog will appear as soon as the operation begins. Depending on the size of your application, the reverse engineering process might take some time to complete:
 +
 
 +
[[Image:MoDisco_discoverer_org.eclipse.modisco.jee.ejbjar.discoverer_in_progress.png|frame|center|Progress dialog during model creation]]
 +
 
 +
At the end of the process, the newly created model file is added to the root of your project if you set SERIALIZE_TARGET to true:
  
 +
[[Image:MoDisco_EjbJarModel_inPackageExplorer.png|frame|center|EjbJar model in the Package Explorer]]
  
[[Image:MoDisco-EjbJar popup menu.png|frame|center]]
+
And the model is opened in the default model browser if you selected '''Open model in editor after discovery''':
  
<br> A progress bar will appear at the bottom of the window as soon as the operation begins. At the end of the process, the newly created model is automatically opened in the MoDisco model browser, if installed, or in default editor.
+
[[Image:MoDisco_EjbJar_inModelBrowser.png|frame|center|EjbJar model in the MoDisco model browser]]
  
 +
The EjbJar XMI files (with a filename ending in ".xml_ejbjar.xmi" by convention) can be opened in any model browser:
  
 +
[[Image:MoDisco_EjbJar_XMI_OpenWith.png|frame|center|Opening an Ejb Jar model]]
  
[[Image:MoDisco-EJBJAR_model_in_browser.png|frame|center]]
+
== Source Repository  ==
  
=== Source code  ===
+
All the source code is stored in the Eclipse public source repository:
All of the source code is stored in a public source repository, which you can access at:  
+
  
Meta-model :  
+
* metamodel : https://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.modisco/plugins/trunk/org.eclipse.modisco.jee.ejbjar
[https://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.modisco/plugins/trunk/org.eclipse.modisco.jee.ejbjar https://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.modisco/plugins/trunk/org.eclipse.modisco.jee.ejbjar]
+
* discoverer : https://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.modisco/plugins/trunk/org.eclipse.modisco.jee.ejbjar.discoverer
  
Discoverer : [https://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.modisco/plugins/trunk/org.eclipse.modisco.jee.ejbjar.discoverer  https://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.modisco/plugins/trunk/org.eclipse.modisco.jee.ejbjar.discoverer]
+
{{MoDisco}}
 +
[[Category:MoDisco]]

Revision as of 06:13, 30 March 2011

MoDisco
Website
Download
Community
Mailing ListForums
Bugzilla
Open
Help Wanted
Bug Day
Contribute
Browse SourceProject Set File

Ejb-Jar Discoverer

The goal of the Generic Ejb-Jar Discoverer plug-in is to allow generic extractions of information from an ejb-jar.xml file, without the need for a metamodel dedicated to a conforming Document Type Definition(DTD) or XML Schema Description (XSD).

Details

Considering ejb-jar.xml files conforming to DTD or XSD, it will be more convenient to have some dedicated metamodels to manipulate information. However, the Generic EjbJar Discoverer is an alternative for miscellaneous ejb-jar.xml files.

This plug-in aims at analyzing any ejb-jar.xml file by providing a model describing the information found. Supported versions are JEE 1.2, 1.3, 1.4, 5, and 6.

Moreover, it allows to serialize the xml file back from the model. Thus, some M2M transformation might be used jointly to upgrade some xml files.


User manual

Discovering and browsing from contextual menu

The plug-in provides the user with a contextual menu to easily create models.

To create the model of your configuration file, right-click on the file in the Eclipse Package Explorer view, and select Discovery > Discoverers > Discover JEE ejb-jar.xml:

Menu to discover an ejb-jar.xml file

A discovery parameters dialog opens to let you specify the parameters of the discovery:

EjbJar discoverer parameters dialog
  • Set SERIALIZE_TARGET to true if you want to save the model to a file
  • You can define TARGET_URI to the location of a file in your workspace. If it is not defined and SERIALIZE_TARGET is true, a model file will be created in the project.
    Beware: the file will be overwritten if it already exists!

Once launched, a progress dialog will appear as soon as the operation begins. Depending on the size of your application, the reverse engineering process might take some time to complete:

Progress dialog during model creation

At the end of the process, the newly created model file is added to the root of your project if you set SERIALIZE_TARGET to true:

EjbJar model in the Package Explorer

And the model is opened in the default model browser if you selected Open model in editor after discovery:

EjbJar model in the MoDisco model browser

The EjbJar XMI files (with a filename ending in ".xml_ejbjar.xmi" by convention) can be opened in any model browser:

Opening an Ejb Jar model

Source Repository

All the source code is stored in the Eclipse public source repository:


MoDisco
Components Infrastructure: KDM · SMM · GASTM · Model Browser · Discovery Manager · MoDisco Workflow · Query Manager · Facet Manager · Metrics Visualization Builder · KDM Source Extension
Technologies: Java · JEE · EjbJar · WebApp · XML
Use Cases: Simple Transformation Chain · Model Filter
Help Installation · SVN
Project API Policy · Retention Policy · Project Plan · metrics · Accessibility Guidelines · Capabilities Disablement

Back to the top