These are basic instructions for a fast start with the AHWS.
Download the "Most recent Academic History Web Service package bundled with Apache Axis2" from http://wiki.openeai.org:8081/display/participants/Academic History Web Service Collaboration (currently [https://vm1.openeai.org/package/work/openeai-academichistory-1.0/openeai-academichistory-1.0.zip]) and follow the instructions there.
In brief, you will need to install the Academic History Web Service on a server and you will need to install a client somewhere, either or the server or on the workstation of your choice.
Here we provide a guide to install Java and Eclipse -- see below for links to recommended packages for Windows. Eclipse, an open source integrated development environment with powerful tools for performing many development functions, is a Java-based tool with an Enterprise Edition version which includes a WSDL browser and client you can use to test the AHWS.
The web service will work on any Java 1.5 or later JVM. Additionally, any WSDL-enabled web service client can be used to test the AHWS. Here we provide instructions for using the Eclipse Web Services Explorer.
In the future the OpenEAI Project plans to also deploy a web app which can be used to test deployed web services.
Recommended Java and Eclipse packages for Microsoft Windows
Below are links to Java and Eclipse packages we know work together. We will make every effort to keep these basic package links up-to-date, however, Sun and/or Eclipse may change their web sites, so please rely on the package names if there are any questions. Also, please note that if your setup requires it for testing purposes, it may be necessary to install the WSDL client (Eclipse) on the web services server or behind the firewall where the web service resides.
Please note that we have encountered difficulty running 32-bit Eclipse with 64-bit java on Windows, and 64-bit Eclipse for Windows is still under development, so it's recommended to install 32-bit Java to run 32-bit Eclipse. Currently the latest version is: eclipse-jee-galileo-SR1-win32.zip
- At the sun.com link below, select: Java SE Development Kit (JDK) -- JDK 6 Update 16 (74 MB), then select the regular "Windows" platform, which will take you to the download link for jdk-6u16-windows-i586.exe. You will be required to answer a license agreement and select an operating system version.
- At the eclipse.org link below, select: Eclipse IDE for Java EE Developers (189 MB), which will allow you to download the archive eclipse-jee-galileo-SR1-win32.zip.
For the Java JDK, go to http://java.sun.com/javase/downloads/index.jsp
For the Eclipse IDE, go to http://www.eclipse.org/downloads
Setting up your Windows environment
Add the Java executable to Path environment variable (\bin directory)
Create JAVA_HOME environment variable
Extract the axis2 archive
Create AXIS2_HOME environment variable pointing to axis2 home directory
Switch to axis2 home
bin\axis2server
Success, message ending in "[INFO] Listening on port 8080"
Tail or open AcademicHistoryService.log in axis2_home\logs
Browse http://localhost:8080
Instructions for using Eclipse to test the AHWS
In Eclipse, select the Java EE perspective
From the Run menu, select Web Services Explorer (see screenshot)
In the upper right of the Web Services Explorer, select WSDL page button (pyramid/web page icon, see screenshot)
Click on WSDL Main in the Eclipse Navigator window (see screenshot)
Paste WSDL address into location text box and click Go.
Service should open in window with list of services, "academicCalendarQuery", "academicHistoryQuery", "pingQuery", "statisticsQuery"
Ping service.
Look in Status subwindow, should receive reply message ending with "The service is up." Also, check the log you are tailing for error messages.
AcademicHistoryService.xml has entries for the location of resources
Recommend that you require security certificate authentication in addition to user authentication
Open ports to hit web services for testing 8585 or 8080
For production can run on standard web services port.
Can set up as https: site with specific ip numbers allowed, requests from students will be coming from AcademyOne servers.