Skip to content

Commit 1d528f2

Browse files
committed
Update the plugin testing section
1 parent ef60f10 commit 1d528f2

File tree

1 file changed

+52
-32
lines changed

1 file changed

+52
-32
lines changed

source/plugin-test.rst

Lines changed: 52 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,53 @@
33
Database plugin testing
44
===========================
55

6-
VAMDC-TAP Validator software may be used to test the database plugin operation,
7-
so there is no need to install the web server and deploy web service framework on the development machine.
8-
It comes with all the needed libraries bundled, and from the plugin point of view the operation
9-
with the VAMDC-TAP Validator is undistinguishable from the real-world operation.
6+
To test the node plugin, the VAMDC-TAP Validator software may be used.
7+
It implements the same DatabasePlugin interface call logic and RequestInterface methods operation
8+
as the VAMDC-TAP node webservice.
9+
All the dependency libraries are bundled in a single TAPValidator.jar archive.
1010

11-
To use VAMDC-TAP Validator for the plugin development, simply add the most recent VAMDC-TAP Validator jar file
12-
to the library path and create the new run configuration,
13-
indicating the **org.vamdc.validator.ValidatorMain** as the main class.
11+
Such an approach facilitates the node plugin development: there is no need to install the
12+
application server and deploy web service framework on the development machine.
1413

15-
During the first run, open the Settings dialog, switch to the plugin mode
16-
and configure the Plugin class name to contain the fully-qualified name
17-
of your class implementing the :ref:`DatabasePlug` interface.
14+
To use the TAPValidator for the plugin development, few steps are required:
1815

19-
If everything is set up correctly, you should be able to see the list of supported restrictables
20-
in the right-top text area and be able to do the queries.
16+
* The most recent version of TAPValidator.jar should be added to the project library path.
2117

22-
For more information on the VAMDC-TAP Validator user interface and features, consult the [TAPValidator]_ documentation.
18+
* New Java Application run/execution configuration should be defined,
19+
indicating the **org.vamdc.validator.ValidatorMain** as the main class.
2320

24-
Screenshots
25-
----------------
21+
* TAPValidator should be configured to operate in the plugin development mode.
22+
In the Settings window, plugin mode radiobutton should be selected;
23+
The class name implementing the :ref:`DatabasePlug` should be indicated,
24+
including the java package name.
25+
26+
If everything is set up correctly, the list of supported restrictables should appear
27+
in the right-top text area. Plugin **buildXSAMS(...)** method is called every time the *Query* button is pressed.
28+
29+
For more information on the VAMDC-TAP Validator user interface and features,
30+
please refer to the [TAPValidator]_ documentation.
31+
32+
33+
.. raw:: latex
34+
35+
\newpage
36+
37+
Eclipse project setup / Screenshots
38+
--------------------------------------
39+
40+
The screenshots corresponding to the Eclipse project setup are presented below.
2641

27-
In case you are using the Eclipse for development, the following screenshots might help.
28-
Open the project properties of your database plugin.
2942

3043
.. _buildpath:
3144

3245
Adding VAMDC-TAP Validator to the build path
3346
+++++++++++++++++++++++++++++++++++++++++++++++++
3447

48+
Open the project properties of your database plugin.
3549

3650
.. image:: img/validator/buildpath.png
3751

38-
Add the latest VAMDC-TAP Validator JAR to the build path, clicking on the "Add external JARs" button
52+
Add the latest VAMDC-TAP Validator JAR to the build path by clicking on the "Add external JARs" button
3953

4054

4155
.. _runconfs:
@@ -57,15 +71,18 @@ Creating run configuration
5771

5872
.. image:: img/validator/newrunconf.png
5973

60-
Create the new run configuration with the following Main class path
74+
Create a new run configuration with the **org.vamdc.validator.ValidatorMain** Main class path
75+
76+
.. raw:: latex
6177

78+
\newpage
6279

6380
Maven Integration
6481
--------------------
6582

6683
All Java software developed as a part of VAMDC is available at VAMDC Maven repository
6784

68-
http://dev.vamdc.org/nexus/content/repositories/releases/
85+
http://nexus.vamdc.org/nexus/content/repositories/releases/
6986

7087
To use Maven for dependency management of your plugin, a following sample POM.xml may be used::
7188

@@ -77,33 +94,36 @@ To use Maven for dependency management of your plugin, a following sample POM.xm
7794
<groupId>org.vamdc.%databasename%</groupId>
7895
<artifactId>plugin</artifactId>
7996
<name>databasename plugin for java node software</name>
97+
98+
<repositories>
99+
<repository>
100+
<id>nexus</id>
101+
<name>VAMDC Releases</name>
102+
<url>http://nexus.vamdc.org/nexus/content/groups/public/</url>
103+
</repository>
104+
</repositories>
80105

81106
<parent>
82107
<groupId>org.vamdc.tap</groupId>
83108
<artifactId>vamdctap-plugin</artifactId>
84-
<version>12.07</version>
109+
<version>12.07r2</version>
85110
</parent>
86111

87-
<distributionManagement>
88-
<repository>
89-
<id>releases</id>
90-
<url>http://dev.vamdc.org/nexus/content/repositories/releases</url>
91-
</repository>
92-
</distributionManagement>
93-
94112
<dependencies>
95113
<dependency>
96114
<groupId>org.vamdc.%databasename%</groupId>
97115
<artifactId>database_dao</artifactId>
98116
<version>0.0.1-SNAPSHOT</version>
99117
</dependency>
100118
<dependency>
101-
<groupId>commons-collections</groupId>
102-
<artifactId>commons-collections</artifactId>
103-
<version>3.2.1</version>
119+
<groupId>org.vamdc</groupId>
120+
<artifactId>TAPValidator</artifactId>
121+
<version>12.07r2</version>
122+
<type>jar</type>
123+
<scope>compile</scope>
104124
</dependency>
105125
</dependencies>
106126
</project>
107127

108-
All the required common dependencies are described within *parent* pom, **vamdctap-plugin**
128+
All the required dependencies are included in the *parent* project, **vamdctap-plugin**
109129

0 commit comments

Comments
 (0)