Allow development in Eclipse environment using iPLAss SDK

About iPLAss

Please refer to the official website for details. https://iplass.org/

About this procedure

-Build iPLAss with Install and Run (MySQL8.0.17 + Windows10) It will be a continuation of.

--In the above article, development with Groovy was assumed, but by following this procedure, you can also develop with Eclipse + Java.

--The procedure is to create a zip file in the iPLAss SDK. Therefore, you can build without a Github account.

--There is also an introduction procedure on the official website, but here we will post the construction procedure in the following environment with images.

About the construction environment, etc.

• Windows10
• iPLAss 3.0.16 --Java and Tomcat are prepared (decompressed) using the following --eclipse 2019-09, Java Full Edition introduced (Pleiades All in One) --Destination: E: \ eclipse \ pleiades2019-09 --Tomcat uses 8 by official designation --Java uses default setting 11 in eclipse 2019-09
• MySQL 8.0.17

About "construction of development environment"

The official construction procedure URL is below. https://iplass.org/docs/gettingstarted/installguide/index.html

Eclipse settings

Open the settings screen in Window> Settings.

Eclipse settings 01/03

General> Set "UTF-8" in "Text File Encoding" in the workspace.

Eclipse settings 02/03

Java> Installed JRE: Java to be used is set Java> Compiler: It has the same compiler compliance level as Java to be used. Make sure each is set.

Eclipse settings 03/03

Server> Register the Tomcat + Java configuration used in the runtime environment.

After making the above three settings, click "Apply and Close" to close the setting screen.

Project capture

Project capture 01/09

Download the SDK from the iPLAss official website and unzip it. https://iplass.org/downloads/

Importing the project 02/09

Copy the "iplass-skeleton" directory in the unzipped folder to the Eclipse workspace.

Importing the project 03/09

Import on the Eclipse side. Select Import Project.

Project import 04/09

General> Select a project from a folder or archive.

Project import 05/09

Select "Directory" and then select the "iplass-skeleton" directory that you copied to your workspace. After that, uncheck "Detect and configure project nature" and click the "Finish" button.

Importing the project 06/09

Follow the procedure below to change the project name (application name), etc.

1. Rename

Right-click on the project and follow the steps below to rename the project. Refactoring> Rename

2. Move

Right-click on the project again and follow the steps below to change the actual directory. Refactoring> Move Before modification: E: \ eclipse \ pleiades-2019-09 \ workspace \ iplass-skeleton After modification: E: \ eclipse \ pleiades-2019-09 \ workspace \

3. Change Gradle settings

Open the "setting.gradle" file in your project and change the value of "rootProject.name" to the value of the project name.

Project capture 07/09

Open "build.gradle" in the project and set to get the JDBC driver for MySQL with Gradle.

• The JDBC version is the latest version when iPLAss is released, so change the value according to your environment. (The part called 8.0.17)

Project capture 08/09

Right-click on the project and follow the steps below to convert the project to a Gradle-enabled project. Configuration> Add Gradle Nature

Project capture 09/09

Right-click on the project and select Refresh. Dependency libraries etc. are imported.

Project settings

Project settings 01/08

Right-click on the project and select "Properties" to open the settings screen.

Project settings 02/08

Select Web Project Settings and set the context root. (Become part of the URL) This time, this procedure is called "systie".

Project settings 03/08

Select "Project Facet" and set it according to the following procedure.

1. Select the Runtime tab.
2. In the "Runtime" tab, select the configuration you want to use (in this procedure, the configuration of Tomcat8.5 + Java11 created above).
3. Changed the version of "Dynamic Web Module" in the left frame to "3.1". When the settings are complete, click "Apply and Close" to close.

Project settings 04/08

Open "mtp-service-config.xml" located in "src / main / resource".

Project settings 05/08

Set iPLAss to work with MySQL. iPLAss can be set by switching the XML to be read for each DB. By default, the oracle settings are loaded, so comment out the Oracle XML and uncomment the MySQL XML.

mtp-service-config.xml: before modification

	<inherits>/mtp-core-service-config-oracle.xml</inherits>
	<!-- If use mysql, inherits mtp-core-service-config-mysql.xml for convenience. -->
	<!--
	<inherits>/mtp-core-service-config-mysql.xml</inherits>
	-->

mtp-service-config.xml: after modification

	<!--
	<inherits>/mtp-core-service-config-oracle.xml</inherits>
	-->
	<!-- If use mysql, inherits mtp-core-service-config-mysql.xml for convenience. -->
	<inherits>/mtp-core-service-config-mysql.xml</inherits>

Project settings 06/08

Set the connection information to MySQL. Similarly, comment out the Oracle settings, uncomment the MySQL settings, and enter the connection information.

mtp-service-config.xml: before modification

	<!-- Rdb Connection Settings -->
	<service>
		<interface>org.iplass.mtp.impl.rdb.connection.ConnectionFactory</interface>

		<!-- DriverManager base ConnectionFactory -->
		<class>org.iplass.mtp.impl.rdb.connection.DriverManagerConnectionFactory</class>

		<!-- ■ your rdb setting 1 ■ -->
		<!-- for oracle -->
		<property name="url" value="jdbc:oracle:thin:ADDRESS:PORT:DB" />
		<property name="user" value="XXXXX" />
		<property name="password" value="XXXXX" />
		<property name="driver" value="oracle.jdbc.driver.OracleDriver" />

		<!-- for mysql -->
		<!--
		<property name="url" value="jdbc:mysql://ADDRESS:PORT/DB" />
		<property name="user" value="XXXXX" />
		<property name="password" value="XXXXX" />
		<property name="driver" value="com.mysql.cj.jdbc.Driver" />
		-->

mtp-service-config.xml: after modification

	<!-- Rdb Connection Settings -->
	<service>
		<interface>org.iplass.mtp.impl.rdb.connection.ConnectionFactory</interface>

		<!-- DriverManager base ConnectionFactory -->
		<class>org.iplass.mtp.impl.rdb.connection.DriverManagerConnectionFactory</class>

		<!-- ■ your rdb setting 1 ■ -->
		<!-- for oracle -->
		<!--
		<property name="url" value="jdbc:oracle:thin:ADDRESS:PORT:DB" />
		<property name="user" value="XXXXX" />
		<property name="password" value="XXXXX" />
		<property name="driver" value="oracle.jdbc.driver.OracleDriver" />
		-->

		<!-- for mysql -->
		<property name="url" value="jdbc:mysql://localhost:3306/mtdb" />
		<property name="user" value="xxx" />
		<property name="password" value="xxxx" />
		<property name="driver" value="com.mysql.cj.jdbc.Driver" />

Project settings 07/08

Set the save destination for binary data. For MySQL, the setting is required. Uncomment and change the root directory setting where you want to save the binaries.

mtp-service-config.xml: before modification

	<!-- Lob Store Settings -->
	<service>
		<interface>org.iplass.mtp.impl.lob.LobStoreService</interface>

		<!--
If you want to save the binary data to a file, please uncomment the following.
If the DB is MySQL or PostgreSQL, File LobStore setting is required.
* The following settings are for saving Binary to a file and LongText to RDB.
If LongText is also a file, set the longTextStore to FileLobStore as well.
		 -->
		<!--
		<property name="binaryStore" class="org.iplass.mtp.impl.lob.lobstore.file.FileLobStore">
			<property name="rootDir" value="[setYourBinaryFileStoreRootPath]" />
			<property name="overwriteFile" value="false" />
		</property>
		<property name="longTextStore" class="org.iplass.mtp.impl.lob.lobstore.rdb.RdbLobStore">
		</property>
		 -->

		<!--
Lob size Rdb(lob_store)Specify whether to manage with.
		-->
		<property name="manageLobSizeOnRdb" value="true" />
	</service>

mtp-service-config.xml: after modification

	<!-- Lob Store Settings -->
	<service>
		<interface>org.iplass.mtp.impl.lob.LobStoreService</interface>

		<!--
If you want to save the binary data to a file, please uncomment the following.
If the DB is MySQL or PostgreSQL, File LobStore setting is required.
* The following settings are for saving Binary to a file and LongText to RDB.
If LongText is also a file, set the longTextStore to FileLobStore as well.
		 -->
		<property name="binaryStore" class="org.iplass.mtp.impl.lob.lobstore.file.FileLobStore">
			<property name="rootDir" value="E:\ProgramFiles\mysql\iplass" />
			<property name="overwriteFile" value="false" />
		</property>
		<property name="longTextStore" class="org.iplass.mtp.impl.lob.lobstore.rdb.RdbLobStore">
		</property>

		<!--
Lob size Rdb(lob_store)Specify whether to manage with.
		-->
		<property name="manageLobSizeOnRdb" value="true" />
	</service>

Project settings 08/08

Set the mail. If you do not want to use local development or mail server, you can check the mail by outputting to the log.

• By default, users who use iPLAss will skip the email and issue a temporary password at the time of initial registration.

mtp-service-config.xml: before modification

		<!-- ■ for develop only (additional="true) ■ -->
		<!--If you want to debug the outgoing mail, enable the following.-->
		<!--
		<property name="listener" class="org.iplass.mtp.mail.listeners.LoggingSendMailListener" additional="true"/>
		-->

mtp-service-config.xml: after modification

		<!-- ■ for develop only (additional="true) ■ -->
		<!--If you want to debug the outgoing mail, enable the following.-->
		<property name="listener" class="org.iplass.mtp.mail.listeners.LoggingSendMailListener" additional="true"/>

After making the changes so far, save "mtp-service-config.xml".

Creating a tenant (supplement)

I created a tenant in iPLAss setup, but after the above settings, I can create multiple tenants from Eclipse.

• Tenant: In iPLAss, an image like a project (box) (personal impression)
• As a prerequisite, there is table information used by iPLAss. If you have not set up iPLAss, you need to support the zip file "iplass-server-setup-kit" in the iPLAss SDK. See the readme in the zip for more details.

If you want to create a new tenant, follow the steps below to open the screen and create it.

• Since it is a light supplement, only screenshots are provided. You can create a tenant by entering the required information above.

Start the server

Start the server 01/06

Open the screen with Window> View View> Other.

Start the server 02/06

Select Server> Server and add the view to the Eclipse screen.

Start the server 03/06

Click the link.

Start the server 04/06

Select the server you want to use (in this case, the Tomcat v8.5 server) and select the preferences you created for your server runtime environment. After setting, click "Next".

Start the server 05/06

Select a project and press "Add". When the project is moved to the configured area, click "Finish".

Start the server 06/06

Start the server.

Access to iPLAss

The URL structure of iPLAss is as follows. http://localhost:8080/コンテキスト名/テナント名/gem/

In this case, it is as follows. http://localhost:8080/systie/free/gem/ If the following login screen appears as after setup, it is successful.

This completes iPLAss construction (Eclipse version).