Dependency Search's Guide

This manual provides a brief description of procedures from installation through to use of the Dependency Search.

Operating as an Eclipse plug-in, this tool automatically extracts the necessary information from the target environment to extract the code that will be necessary to port.

Note

Since the information needed for searches is automatically extracted from the target environment, it can extract the required code from any platform without relying on a specific platform.

Also, the search information required for porting to JBoss EAP6 is included with the tool, there is no need to specify the target porting environment in the tool.

Table 1. Targeted resources

Item	Description
Java file	Information for all classes used by Java files is compared to the library information available at the target environment to extract classes that cannot be used or should not be used.
JSP file	The Java class information and tag library information used by JSP files is compared to the library information available at the target environment to extract classes that cannot be used or should not be used.
XML file	The DTD and XSD information of XML files is compared with the DTD and XSD information available at the target environment to extract the XML files that need be ported.

It has been confirmed that the tool can operate in the following hardware environment.

Table 1. Hardware Requirements

Item	Requirements
CPU	Pentium (R) Dual-Core CPU E5400 @2.70GHz (2 CPU) or the equivalent
RAM	2012MB RAM or more

It has been confirmed that the tool can operate in the following software environment.

Table 1. Software Requirements

Item	Requirements
OS	Windows XP/7, RHEL6(*)Other Linux Compatible
Java VM	Oracle JRE 1.6 or more
IDE	Eclipse 3.7 Indigo or Eclipse 4.3 Kepler

None in particular.

	Note
	There is no need to make all the preparations needed for a successful compilation. Searches can be performed as long as the target files are available.

Set up the operating environment described above. Perform the steps below after the required environment has been set up.

Download

Download the plug-in.

Note

https://github.com/TUBAME/migration-tool/releases
Unzip

Unzip the downloaded file. Unzipping the file creates the tubame.wsearch_* directory.

Note

The * part of the name varies with the version.

Important

Unzipping the file in Windows may fail due to path length limitations. If it fails, use a short path such as C:\temp for unzipping.
Install in Eclipse.

Move or copy the unzipped directory to the plugins directory under the Eclipse installation directory.
Confirm installation.

Select the Eclipse menu as shown below.

Help → About Eclipse → Installation Details → Plug-ins

Confirm that the Plug-in Id column contains the tubame.wsearch plug-in name.
Complete installation.

This completes the installation.

The following describes how to use the tool.

Perform the following steps.

Start up Eclipse.
Start up the project creation wizard.

File → New → Project...

Create a Java Project.

Java Project → Next

Use the New Java Project wizard to make the appropriate settings required by the environment of the item to be ported to create a project.

	Important
	Be sure to create a Java Project. The tool will not run normally in a project other than a Java Project.

	Important
	The targeted Java search files must be placed in the Eclipse Source Folder.

	Important
	As long as the placed source files have file names that Java can handle, directory and file names are not an issue. However, if characters that Java cannot handle are included (e.g. hyphens), a search may end in failure.

Perform the following steps.

Specify the information required by the search.

Specify the information required by the search as shown below.

Window → Preferences → Dependency Search → Library settings

The following information can be specified.

Library settings

These settings manage library information used for searches. Libraries whose checkboxes have been selected will be searched as available libraries at the target environment.

	Note
	The following settings can be made. Name Screen name. Type a name. Library type Select whether libraries will be compressed files (zip format) or directories. Path Set the path of the libraries. Type Select this checkbox for libraries in the Maven repository format. Description Provide a description of the library.

Cache

Library information is extracted when a search starts. A cache function has been provided to handle the comparatively heavy processing that search results involve. Specify whether or not the cache will be used. Since the cache does not exist during the first search, library information is extracted even if the cache is enabled.

Perform the following steps.

Select search resources.

Right-click a resource you want to search and select the following menu.

tubame → Dependency Search
Set search conditions.

Make the following entries.

Destination of output results: Specifies a gjbm file to which to output the search results.
Conduct a search.

Click Finish to start the search.

When the search ends, Dependency Search Result view appears in the Eclipse work view area. You can also open Dependency Search Result view by double clicking the gjbm search result file.

Items displayed in Dependency Search Result view are described below.

Table 1. Items displayed in Dependency Search Result view

Item Description

Header area

Displays error instance, warning instance and result file path information.

	Note
	By default, up to `100` instances each will be displayed for errors and warnings, but no results will be displayed beyond that.

Result

Displays the results of comparing source and target.

	Note
	There are the following classifications. error Indicates the code is deemed necessary for porting. warn Items where porting is recommended or where the need for porting should be checked.

Category

Displays found source categories.

	Note
	There are the following classifications. Java XML JSP

Package The package name is displayed for a Java file, otherwise “-” is displayed.

Source library Displays the name of the found source library.

Target library Displays the name of the found source library. Multiple hits are displayed comma-delimited.

Class Displays the class name, namespace, tag library path, schema path, etc. depending on what is found.

Hit count Displays found instances by package or class.

File to be ported Displays the name of the file to be ported.

Line Displays the line numbers of the files that will be ported.

Result details Displays the found reason.

Remarks Displays the name of the target library when a deprecated class is found.

The view menu allows you to take the following actions regarding items displayed in Dependency Search Result view.

Table 1. View menu item

Item	Description
Result filter	Allows you to set the result columns that should be displayed.
Category filter	Allows you to set the category columns that should be displayed.
Package filter	Allows you to set the package columns that should be displayed.
Source library filter	Allows you to set the source library filter columns that should be displayed.
Target library filter	Allows you to set the target library filter columns that should be displayed.
Export to CSV	Allows you to export items displayed in Dependency Search Result view to a CSV format file.
Display instance settings	Determines the maximum number of items displayed in Dependency Search Result view. The set value indicates the maximum number of instances displayed in the error and warn result columns.

Delete the installed tubame.wsearch_*. This completes the uninstallation.

	Note
	The * part of the name varies with the version.

	Note
	Add the -clean option when starting up Eclipse after deletion.

Dependency Search's Guide

1. Overview

1.1. Introduction to This Document

1.2. Introduction to This Tool

2. Operating Environment

2.1. Hardware Requirements

2.2. Software Requirements

2.3. Prerequisite

3. Installing the Tool

3.1. Installing the Tool

4. How to Use

4.1. Operating Procedures

4.1.1. Creating Your Eclipse Project

4.1.2. Preparations

4.1.3. Conducting a Search

4.1.4. Checking Results

4.1.5. Working with View Menu

5. Uninstalling the Tool

5.1. Uninstalling the Tool

	Important
	Unzipping the file in Windows may fail due to path length limitations. If it fails, use a short path such as `C:\temp` for unzipping.

	Note
	https://github.com/TUBAME/migration-tool/releases