About the JADK

Advanced Customization > Info*Engine Java Adapter Development > About the JADK

About the JADK

Info*Engine uses specialized adapters to communicate with external applications and other data sources. PTC supplies standard adapters that satisfy many of these needs. There are times, however, when customer requirements dictate that a unique adapter must be developed, for which PTC has created Info*Engine Adapter Development Kits (ADKs). One such is the Java-based Adapter Development Kit (JADK).

Prior Knowledge Required

The following topics provide the necessary guidelines to write custom Info*Engine adapters using the Java programming language and integrate for use with Windchill. This guide assumes that you have:

• Thorough knowledge of Java programming concepts and techniques

• Basic knowledge of Info*Engine solution development and authoring

• Basic knowledge of Java Server Pages

• Basic knowledge of HTML and XML

Files Delivered with the Default JADK

The following files are delivered on the Info*Engine Java Adapter Development Kit CD:

File Name	Description
jadk.jar	The JADK package that includes all the components and APIs you need to develop your own adapter.
JADKAdapterImpl.java	Prototype of the implementation class you need to copy to your development path for the adapter.
JADKAdapter.java	Prototype of the class containing the main method you need if you want your adapter to run in standalone mode.
JADKMultithreadedAdapter. java	Prototype of the class containing the main method that uses the multi-threaded model. It is needed if you plan to develop a standalone adapter with only one instance of the implementation class running.
JADKMultithreadedAdapterImpl.java	Prototype of the implementation class based on multi-threaded modeling. You need to copy it to your development path and possibly make changes. For more details about single-threaded and multi-threaded models, see Developing an Adapter Using the JADK.
myAdapterImpl.java	A sample implementation class.
myAdapter.java	A sample main class.
IeGetFile.java	A sample webject class to get a binary file from the local file system and stream it back to your browser.
IeQueryObjects.java	A sample webject class to parse a metadata table file from your local file system and send it back to your browser.
IePutFile.java	A sample webject class that tests the put blob functions for the JADK wrapper class. It reads the contents of a text or binary file from the input stream and saves it off your local hard drive.
IeGetMessage.java	A sample webject that tests a simple data type. Data can be an object, stream, or status. This webject writes whatever status you put into your xylem into your browser.
IeDisplayGroups.java	A sample webject that tests the internal structure built with JADK. The webject simply joins the two group-ins and writes it to the group-out, so you can see the two joined group data in your browser.
IeQuerySql.java	A sample webject that uses a SQL statement to execute a query and get the result set back from the Oracle database. A JDBC driver is required to run this webject.
IeDeleteObjects.java	A sample webject that deletes a row from the Oracle database. A JDBC driver is required to run this webject.
jadk-sqlquery.html	A template for testing the Query-Sql webject.
jadk-sqlquery.xml	A task for testing the Query-Sql webject.
jadk-delete.html	A template for testing the Delete-Objects webject.
jadk-delete-xml	A task for testing the Delete-Objects webject.
build.xml	Build file to be used with Ant for creating the sample adapter classes and the corresponding jar file.
startJADK.sh	A script file to run the sample adapter in standalone mode in Unix.
startJADK.cmd	A script file to run the sample adapter in standalone mode in Windows.
jadk-get-file.xml	A task for testing the Get-File webject.
jadk-query.html	A template for testing the Query-Objects webject.
jadk-join.html	A template for testing the Display-Groups webject.
jadk-put-file.html	Provides a form in which to enter and submit the name of the file to be uploaded. The upload happens by way of executing jadk-put-file.xml.
jadk-status.html	A template for testing the Get-Message webject.
jadk-join.xml	A task for testing the Display-Groups webject.
jadk-put-file.xml	A task for testing the Put-File webject.
jadk-query.xml	A task for testing the Query-Objects webject.
jadk-status.xml	A task for testing the Get-Message webject.
table.txt	A sample text file referenced by jadk-join.xml, jadk-query.xml, and jadk-query2.xml.
table1.txt	A sample text file referenced by jadk-join.xml and jadk-query2.xml.
ptc.gif	The GIF file referenced by jadk-get-file.xml for the sample adapter.

And the following JSPs (Java Server Pages) are also delivered on the CD:

File Name	Description
jadk-sqlquery.jsp	A JSP page to test the Query-Sql webject.
jadk-delete.jsp	A JSP page to test the Delete-Objects webject.
sqlquery-inputs.jsp	Provides a form using the inputs for executing jadk-sqlquery.jsp that can be typed in and submitted.
delete-inputs.jsp	Provides a form using the inputs for executing jadk-delete.jsp that can be typed in and submitted.
jadk-getfile.jsp	A JSP page to test the Get-File webject.
jadk-query.jsp	A JSP page to test the Query-Objects webject.
jadk-putfile.jsp	A JSP page to test the Put-File webject.
jadk-join.jsp	A JSP page to test the Display-Groups webject.
jadk-query2.jsp	Another JSP page to test the Query-Objects webject.
jadk-status.jsp	A JSP page to test the Get-Message webject.
IEError.jsp	A JSP page for error handling.

Was this helpful?