Adding Comments to Your Java Code for the jcode Utility
When you build a Java service in your own IDE, you use the jcode utility to perform actions against the service. For more information, see
Using the jcode Utility. Before you can use the jcode utility, you must add specially formatted Java comments (jcode tags) to the Java source code to designate the following segments of code:
Imports. Add the following comments to mark the beginning and end of the import section.
// --- <<IS-START-IMPORTS>> ---
imports
// --- <<IS -END-IMPORTS>> ---
Service definitions and service inputs and outputs. Add the following comments to mark the beginning and end of the logic for one method in the class. This results in a Java service in
Integration Server.
// --- <<IS-START(serviceName)>> ---
service logic
// --- <<IS-END>> --
Shared code. Add the following comments to mark the beginning and end of the shared code within the class.
// --- <<IS-START-SHARED>> --
shared code
// --- <<IS-END-SHARED>> ---
For example, the following code fragment shows the tags used to mark the beginning and end of the import section.
.
.
.
// --- <<IS-START-IMPORTS>>
---
import com.wm.data.*;
import java.util.*;
// --- <<IS-END-IMPORTS>>
---
.
.
.
Template for Using jcode Tags in a Java Service
The following code is a template that shows the jcode tags (or comments) that you need to add to the Java source so that the jcode utility can identify code segments. For sample code that uses these jcode tags, see
Example of Code Commented for the jcode
Utility.
package Interface1;
/**
* This is an example of an empty Java source code file that includes
* the jcode tags (comments) that the jcode utility requires.
*/
import com.wm.app.b2b.server.Service;
import com.wm.app.b2b.server.ServiceException;
import com.wm.data.IData;
import com.wm.data.IDataCursor;
// --- <<IS-START-IMPORTS>>
---
// --- <<IS-END-IMPORTS>>
---
public class Interface0
{
public static void Service1 (IData pipeline)
throws ServiceException
{
// --- <<IS-START(Service1)>>
---
// --- <<IS-END>> --
return;
}
public static void Service2 (IData pipeline)
throws ServiceException
{
// --- <<IS-START(Service2)>>
---
// --- <<IS-END>> ---
return;
}
// --- <<IS-START-SHARED>>
--
// --- <<IS-END-SHARED>>
---
}
Related Topics
