J2EE Coding Aids

New features such as online validation and J2EE refactoring have made J2EE coding easier in Pramati Studio. J2EE code is validated during code generation. Studio checks for Java, EJB, and J2EE errors, simultaneously. Violation of EJB or J2EE specification or the bean provider contract is treated as error. If a bean has something wrong within it, Studio suggests a correction if possible.

EJBs are usual Java classes and J2EE coding aids such as rename refactoring, and code completions are available in Studio. EJB dependencies are considered as Java class inheritances. EJB class, component interface, home interface dependencies are treated as EJB class implementing corresponding interface. For example, if a new method is introduced in an EJB class, and the caret is on the method declaration, Studio underlines it using a red squiggly. Press Alt + Enter to view the suggested correction. In this case, Studio suggests to insert the current method in a bean interface. Press Enter to implement the suggestion.

Intelligent Features of J2EE Assistant

When the reference name entered is already in use, the lookup code is generated but no entry is added to the XML files.

When the parent package of the class to be imported is already present in the code, the import statement is not added.

If a class having the same name but a different package as that of the class is to be imported has already been added, no import statement is added but a lookup code with the fully qualified class name is added.

If no file is open in the Display Panel, the J2EE Assistant in the main menu bar is not enabled.

Trying to invoke the J2EE Assistant on files other than a Bean Class, JSP or a Servlet prompts the user with a beep sound, and also displays an appropriate message in the Status Bar.

EJB remote, local, remote home, local home interfaces should be declared as public and should extend corresponding javax.ejb.XXX interface. EJB interface can not be declared final

All interface business methods should be implemented in EJB class except finder methods for entity bean CMP

For EJB remote interface and remote home interface, all methods should throw java.rmi.RemoteException

All methods, arguments, and return types should be RMI/IIOP compatible

For EJB Local Interface and Local Home interface no methods should throw java.rmi.RemoteException

Online validation of J2EE code in Studio is based on J2EE, EJB1.1, and EJB 2.0 specifications. Bean provider contract given in EJB specification should be adhered to when a bean code is being written. Any deviation from a specification, is highlighted in the editor by red squiggly for errors and gray squiggly for warnings. Placing the mouse at the squiggly displays a description of the error.

If Studio can take any action to correct the error, it prompts to press Alt + Enter. Select the appropriate action from the list of suggestions and press Enter to perform the action. For example, according to the EJB specifications, the method create() in Home or LocalHome should throw CreateException. If CreateException is not thrown, the method is highlighted with a squiggly.

Studio provides J2EE aware refactoring in addition to Java refactoring. All references to the renamed element is updated across the AST, in the ejb-jar.xml, web.xml, and application.xml. For example, if ejbCreateCustomer in a bean class is renamed to ejbCreateNewCustomer, in addition to Java refactoring the corresponding create method is renamed to createNewCustomer in Home and LocalHome. All references in the desk and the deployment descriptor are updated.

Rename package: Package statements, import statements, and qualified names of classes

Rename class: Import statements and the qualified names of the classes

Rename method: All calls of the method, all overridden and implemented methods in the subclasses

Rename field: All read and write usages of the field

Rename variable: All read and write usages of the variable

For example, if method getName() for a CMP 2.0 is renamed to getName1(), the following changes are made by Studio:

Corresponding setName() is renamed to setName1()

Field name is changed from name to name1 in ejb-jar.xml

All references to getName() is renamed in ejb-jar.xml, pramati-or-map.xml for field vs database column

EJB QL is modified accordingly

For this example, rename lineitem CMR in OrderBook.dsk. Open bean properties for SalesOrderBean to view the existing type of relationship between SalesOrderBean and LineitemBean. Open LineitemBean in Editor and follow these steps:

Place the cursor at lineitem CMR and select Refactor > Rename from the menu bar or right click on the concerned Java file and select Refactor > Rename.

Type the new name for the member to be refactored.

Select the Preview usages before refactoring option to view all usages of the selected member in the output panel. A dialog notifies you about the action to be performed.

Click Close.

The Preview tab in output panel displays the usages to be effected due to this refactoring.

To continue, click Refactor button in the Preview toolbar. Express development takes care of the necessary modifications, recompilation etc. All usages of lineitem is renamed as newlineitem.

The J2EE Assistant in Studio helps the developer to add references to the Bean classes, Bean Browser, JSP Pages and Servlets, writing design patterns. The three different types of references that can be added are EJB references, resource references, resource environment references.

Using the J2EE Assistant to add these references, generates the lookup code at the cursor position, based on the inputs provided by the developer, adds these entries to the required XML files, imports the relevant classes (in the bean class only), and also initializes the required variables. Using the J2EE Assistant minimizes the number of errors that are committed, by the developer, and also removes any oversights of the developer.

Adding EJB References

EJB References are used for the declaration of a reference to an enterprise bean home. The declaration consists of:

the EJB reference name used in the code of the application client that referencing the enterprise bean

the expected type of the referenced enterprise bean

the expected home and remote interfaces of the referenced enterprise bean

optional ejb-link information, used to specify the referenced enterprise bean

an optional description

To add the EJB Reference, position the cursor at the place where the reference is to be added, and then click on J2EE Assistant > Add EJB Reference from the main menu. The shortcut key that may be used is Ctrl + Alt + Q. This brings up the Add EJB Reference panel, where the following information should be entered:

Link: Select the JNDI name for the reference to be created. The JNDI name is used to link an ejb reference to the target enterprise bean. This is the name of the target enterprise bean, and is unique

Remote Interfaces: Choose this option to add the ejb reference to the remote interface of the bean. If the bean does not have a remote interface, the option is disabled

Local Interfaces: Choose this option to add the ejb reference to the local interface of the bean. If the bean does not have a local interface, the option is disabled.

Name: Enter the name of the EJB Reference to be added in this field. The name must be unique within the same module. Entering a name which is already being used for a different bean disables the OK button, and prompts the user by coloring the reference name in red and displaying an appropriate error message

Clicking on OK after filling in all the required details adds the lookup code at the cursor position, adds the required import statement for the home/local class being looked up, declares the initial context variable, ic to the code, and therefore the classpath of the bean class file must contain the classes of the beans looked up.

Adding Resource References

Resource reference contains a declaration of enterprise bean or web component reference to an external resource. It consists of an optional description, the resource manager connection factory reference name, the indication of the resource manager connection factory type expected by the code, the type of authentication (Application or Container), and an optional specification of the shareability of connections obtained from the resource (Shareable or Unshareable).

Using the J2EE Assistant, position the cursor at the place where the reference is to be added, and then click on J2EE Assistant > Add Resource Reference from the main menu. The shortcut key that may be used is Ctrl + Alt + W. This brings up the Add Resource Reference panel, where the following information needs to be filled:

Link: Select the reference link from the list in the combo box. The list contains all the data resources and mail resources that have been defined in the desk

Name: Enter the name of the resource reference to be added in this field

Clicking on OK adds the lookup code at the place where the cursor was positioned, adds the required import statements for the javax.sql.DataSource, declares the initial context variable - ic.

Adding Resource Environment References

The resource environment reference contains a declaration of an enterprise bean reference to an administered object associated with a resource in the enterprise bean or the web component environment.

To add the Resource Environment Reference, position the cursor at the place where the reference is to be added, and then click on J2EE Assistant > Add Resource Environment Reference from the main menu. The shortcut key that may be used is Ctrl + Alt + E. This brings up the Add Resource Environment Reference panel, where the following information needs to be filled:

Link: Select the reference link from the list in the combo box. The list contains all the JMS resources that have been defined in the desk

Name Enter the name of the resource environment reference in this field. The name must be unique in the module

Clicking on OK adds the lookup code at the place where the cursor was positioned, adds the required import statements, declares the initial context variable - ic, and therefore the classpath of the bean class file must contain the classes of the beans being looked up.

Bean Browser

Use this feature to browse for different types of enterprise beans in the desk. Click on J2EE Assistant > Bean Browser from the main menu or press on Ctrl + Alt + B on the keyboard. This pops up the Bean Browser dialog, which by default, displays all the beans in the desk.

To view beans after sorting them using the different criterion, use the following:

CMP: Clicking on this button removes all the CMP entity beans from the list. Clicking on the toggle button displays the CMP beans in the list.

BMP: Use this toggle button to hide/display the BMP entity beans in the list

SL: Use this toggle button to hide/display the Stateless session beans in the list

SF: Use this toggle button to hide/display the Stateful session beans in the list

SORT: Clicking on this button displays all the beans after sorting them in an ascending order, according to the bean type. By default, the beans are sorted according to the EJB Names.

Selecting the option, all Modules from the combo box displays all the beans in the desk. Selecting a specific module name from the combo box displays only those beans that exist in that module

The OK button is disabled till a bean is selected. Select the bean from the list, and click on OK to open the bean class file in the Display Panel.

Session Facade

Use this feature to select beans and the type of interface (remote or local) that are to be included in facade. Click on J2EE Assistant > Session Facade from the main menu, or press Ctrl + Alt + S on the keyboard. This pops up the Create Session Facade dialog. The dialog is divided in two parts:

Select Facade Bean: This combo box contains all the session beans in the desk as a combo box. If a session bean file is open in the Display Panel, then the combo box has the open bean class name as its selected item. If no session bean is open in the Display Panel, no item is displayed in the combo box

Select Beans to include in Facade: This section is displayed as a table which contains all the beans in the desk. The table has checkbox for selecting a bean to include in facade, and for choosing the type of interface (remote/local) to be included in the facade.

Check the options - Home and Local Home against the bean name to include them in the facade. If the interface type is not available for a bean, then that specific checkbox displays the text NA (not available). The OK button is disabled till a bean is selected. Check against the bean name, the interface type for that bean, and the session bean to create the facade and then click OK. This generates the lookup code for all the beans selected in the setSessionContext method of the selected session facade bean. Selecting beans that have already been declared in the Create Session Facade dialog, does not generate the look up code for these beans. The list of variables is initialized for the remote/local interfaces of the beans being looked up, and their classes are included in the classpath of the module of the facade bean. If the beans being looked up belong to a package other than the session facade bean, the beans are imported in the facade beans.

Selecting a bean as the Facade Bean field does allow the same bean to be included in the Facade. Similarly, selecting a CMP 1.1 bean as a Facade bean does not allow the local interface of any bean to be included in the Facade.

Value Object

Value Object is an object that contains the fields that represent the EJB accessor methods. Use this J2EE Assistant feature to create a value object for a specific CMP. This feature supports both CMP 1.1 and CMP 2.0 type of bean. Click on J2EE Assistant > Create Value Object on the main menu, or right click on the bean properties file in the Explore Panel and select Create Value Object. This pops up the Value Object Dialog. The menu item is enabled only when CMP bean properties in the Explore Panel.

Value Object Class, which represents the CMP Fields chosen by the user.

Getters and Setters for the CMP Fields in the Value Object

A default constructor in the Value Object, which takes all the fields

Getter and Setter for Value Objects in the Remote/Local Interface as specified by the user

Creating a Value Object also updates the bean code to have Getter and Setter methods.

The Create Value Object dialog that pops up has the following fields that the user fills as per the requirement:

Value Object Class Name: The value object class name with its package name is automatically filled in this field. The name of the value object class is filled as the EJBName of the Bean selected in the Explore Panel, suffixed with VO

Field Name: The names of the fields in the Bean are displayed here. This field is not editable.

Field Type: The field types are displayed here. This field is not editable

Getter: Check this option to create the getter methods for the CMP fields in the value object class. By default, it is checked

Setter: Check this option to create the setter methods for the CMP fields in the value object class. By default, it is checked

To create the getter and setter methods for the value object in the bean interfaces, check the options provided:

Getter in Remote Interface: Checking this option creates the getter method in the remote interface of the bean. This option is by default, checked. If the bean does not have a remote interface, the option is disabled

Setter in Remote Interface: Checking this option creates the setter methods in the remote interface of the bean. This is checked by default. If the bean does not have a remote interface, the option is disabled

Getter in Local Interface: Checking this option creates the getter method in the local interface of the bean. This option is by default, checked. If the bean does not have a local interface, the option is disabled

Setter in Local Interface: Checking this option creates the setter method in the local interface of the bean. This is checked by default. If the bean does not have a local interface, the option is disabled

Selecting the getter/setter options creates the getter/setter for the Value Object in the corresponding interface. The bean code is also updated automatically.

Click OK after filling in all the details in the dialog. This button is disabled when none of the checkbox are selected. To cancel the command, click on Cancel.