Tue, Jun
3 New Articles

Retrieve TCP/IP API Information Using Java Toolbox

  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times

Are you a Java developer looking to retrieve iSeries TCP/IP system API information? If so, this article is definitely for you. Here, you'll learn how to use Java Toolbox  to retrieve information using the TCP/IP management APIs that have been available since OS/400 V5R1.

Depending on the type of application a customer is creating, you can obtain certain iSeries system information. For instance, in a sockets application that allows many customers to connect to your iSeries system, you may want to monitor what IP address and Media Access Control (MAC) address is connecting to your system. An IP address is a network identifier that can be assigned to a system. The MAC address is the physical address that is burned into a computer's network card. If a client that connects to your iSeries socket application is doing something that makes you feel uncomfortable, you can retrieve its IP and MAC addresses using one of the iSeries TCP/IP system APIs.

When a client connects to your iSeries system from an external network for the first time, an ARP REQUEST must be sent out from your iSeries system to map the client's MAC address with its IP address. When your system receives an ARP REPLY with the MAC address, that value is put into the ARP table of the iSeries system. When the client connects again, it won't be necessary to send another ARP REQUEST to find the client's MAC address. On the iSeries, the TCP/IP system API called QtocLstPhyIfcARPTbl lists all the data for the iSeries ARP table.

When using system APIs, you need to know how to call them and what information to input. The QtocLstPhyIfcARPTbl requires a user space name, a format name, and a line name, as shown in the table below. If any problems occur when calling the API an error code will be outputted so you don’t have to worry about any input value to place within the error code.

Qualified user space name
Format name
Line name
Error code

Service Program: QTOCNETSTS
Threadsafe: Yes

When calling the QtocLstPhyIfcARPTbl, you must put all the information into a predefined user space that you can create on the iSeries system.

A format name is also required because many iSeries system APIs have different formats. It is important to know the format because, when the API is called, all the information gets put in a predefined location within the user space. To retrieve that information, you need to know the exact decimal number within the user space. Within the QtocLstPhyIfcARPTbl, there is only one format name, ARPT0100 (see the table below).

Internet address
Internet address binary
Line type
Ethernet type
Type of entry
Data link connection identifier (DLCI)
Routing information field (RIF) valid mask
Routing information field (RIF)
Physical address

The third parameter is the line name. When inputting this value, you can hard-code it in if you know it will not change or you can call the Retrieve Line Description (QDCRLIND) API, which will allow you to return the name of your line description. If you are designing a GUI, you can allow a user to choose among a number of line names for a particular iSeries system.

Using the Java Toolbox

Now that you understand how the system API works, you can put Java Toolbox to work. Java Toolbox has an API called ProgramCall. The ProgramCall class allows a user to call an iSeries system API, pass parameters to it (input and output), and access data returned in the output parameters after the program runs. Use ProgramCall to call programs; use ServiceProgramCall to call service programs. You will notice in the first table that the QtocLstPhyIfcARPTbl API has a service program called QTOCNETSTS. Since it's a service program, you will use the ServiceProgramCall.

Take a look at some of the code that allows you to call the QtocLstPhyIfcARPTbl and retrieve data back from the user space. Remember, before calling this system API, you need to create a user space. Java Toolbox has a UserSpace class that allows you to do just that. In the following method (Figure 1), you will see that I created a UserSpace object called ARP in library GARBERSB.

//Method that allows us to create a UserSpace in library
//GARBERSB called ARP.
public void createUserSpace() {
try {
//Create the UserSpace object.
us = new UserSpace(system, "/QSYS.LIB/GARBERSB.LIB/ARP.USRSPC");

//When set to true this means that ProgramCall has read
//and write access to this UserSpace.

//Create the UserSpace with an initial size of 256 * 1024,
//a true value informing us the UserSpace can be replaced,
//no extended attribute, an initial value of 0 and the 
//public authority set to *EXCLUDE.
256 * 1024,
(byte) 0,
"User space for Netstat Connections",

catch (Exception e) {
System.out.println("Problems creating the user space.");

Figure 1: Use this code to create a user space.

Once the user space is created, you can fill in your system API parameters. First, define the ProgramParameter array with a length of 4. Note that the AS400 system object has been pre-created. This is shown in Figure 2.

// The API has 4 parameters.
ProgramParameter[] parms = new ProgramParameter[4];

// PARM 1: We will use the AS400Text to take our the library name and 

//user space name and place it into our parms array.
AS400Text userSpaceText = new AS400Text(20, system.getCcsid(), system);
parms[0] = new ProgramParameter(


// PARM 2: Format Name ARPT0100 in the List Physical Interface ARP 

//Table API
String formatName = "ARPT0100";
AS400Text text4 = new AS400Text(8, system.getCcsid(), system);
parms[1] = new ProgramParameter(text4.toBytes(formatName));

// PARM 3: Format Name ARPT0100 in the List Physical Interface ARP Table 

//API. Note that we pass in the line name.
AS400Text text = new AS400Text(10, system.getCcsid(), system);
parms[2] = new ProgramParameter(text.toBytes(lineName));

//PARM 4:  Error messages that will be called from the API.
parms[3] = new ProgramParameter(new byte[5]);

// We will pass everything in by reference

Figure 2: This code sets the ProgramParameter array.

Once you have your ProgramParameter set up, all you have to do is create and call the ServiceProgramCall. It is important to make sure you catch possible AS400Messages that might end up getting thrown for debugging purposes. See Figure 3.

// Now setup the ProgramCall.
ServiceProgramCall pc = new ServiceProgramCall(

//Now we will call the ProgramCall that we created above
try {
boolean result = pc.run();

// If the call didn't work, check for any messages.
if (!result) {
AS400Message[] messages = pc.getMessageList();
for (int i = 0; i < messages.length; ++i) {

// Show each message


else {
System.out.println("QtocLstPhyIfcARPTbl API Worked");

Figure 3: Call the service program.

Now that you have called the QtocLstPhyIfcARPTbl, you can retrieve the information that was put within your user space. Figure 4 shows how you can retrieve certain information from the user space.

//We will create a byte buffer to read the information in from the 

byte[] buf = null;

//Here we will get the length of the UserSpace
int size = us.getLength();
buf = new byte[size];

//Temporary int value of where we are in the UserSpace.
int temp = us.read(buf, 0);

//We will print out the Starting offset
int startingOffset = BinaryConverter.byteArrayToInt(buf, 124);
System.out.println("Starting offset " + startingOffset);

//We will print out the number of entries
int numEntries = BinaryConverter.byteArrayToInt(buf, 132);
System.out.println("Number of entries " + numEntries);

//Here we will get the entry size and print it out.
int entrySize = BinaryConverter.byteArrayToInt(buf, 136);
System.out.println("Entry size " + entrySize);

int index = 0;

//We will loop through each entry.
if (numEntries > 0) {
forLoop : for (int i = 0; i < numEntries; i++) {

//Set the index value.
index = startingOffset + (i * entrySize);
CharConverter ch = new CharConverter(ccsid, system);

//Retrieve the IP Address
//Note that we get the value 16 from the ARPT0100 API
index += 16;
Common.intToIPString( BinaryConverter.byteArrayToInt(buf, index)));

Figure 4: Retrieve information from your predefined user space.

As you can see, you can keep on increasing the index by the decimal offset value of the API.

Figure 5 shows an example of what happens when you run the example code. Note that you will have to log onto an iSeries system that has a release of V5R1 or later.

Defining Program Parameters.
Fully Qualified UserSpace Name :ARP       GARBERSB  
Before reading the UserSpace()
After reading the UserSpace()
Let's try Retrieving ARP Information now.
QtocLstPhyIfcARPTbl API Worked
Starting offset 644
Number of entries 8
Arp Object Length will be [Lcom.ibm.test.arp.ArpObject;@193722c
Entry size 76
Entry ccsid 37
Internet Address
Line Type Ethernet
Ethernet Type Ethernet Version 2
Type Of Entry Dynamic
RIF Valid Mask Not Valid
RIF null

Physical Address 00:00:0C:07:AC:01
30 30 3a 30 36 3a 32 39 3a 45 43 3a 36 30 3a 39 39 

Figure 5: This output is a result of the example code.

In the example output, you now see that the IP address is within the ARP table with a MAC address of 00:00:0C:07:AC:01. You can implement this information within your socket application, possibly disconnecting it and not letting it connect in the future if the client is doing something malicious.

Now that you know how to program the QtocLstPhyIfcARPTbl API, you should be able to move on to program different iSeries system TCP/IP APIs. All of the TCP/IP APIs can be viewed within the iSeries Information Center. Many of the APIs can be useful when you want certain information to be retrieved within your application.

Benjamin Garbers is a Software Engineer within the Rochester Support Center. He is currently developing Internet applications for IBM's iSeries Technical Web site.



Support MC Press Online

$0.00 Raised:

Book Reviews

Resource Center

  • SB Profound WC 5536 Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. You can find Part 1 here. In Part 2 of our free Node.js Webinar Series, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Brian will briefly discuss the different tools available, and demonstrate his preferred setup for Node development on IBM i or any platform. Attend this webinar to learn:

  • SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation. Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects. The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the company are not aligned with the current IT environment.

  • SB HelpSystems ROBOT Generic IBM announced the E1080 servers using the latest Power10 processor in September 2021. The most powerful processor from IBM to date, Power10 is designed to handle the demands of doing business in today’s high-tech atmosphere, including running cloud applications, supporting big data, and managing AI workloads. But what does Power10 mean for your data center? In this recorded webinar, IBMers Dan Sundt and Dylan Boday join IBM Power Champion Tom Huntington for a discussion on why Power10 technology is the right strategic investment if you run IBM i, AIX, or Linux. In this action-packed hour, Tom will share trends from the IBM i and AIX user communities while Dan and Dylan dive into the tech specs for key hardware, including:

  • Magic MarkTRY the one package that solves all your document design and printing challenges on all your platforms. Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product. Make sure your data survives when catastrophe hits. Request your trial now!  Request Now.

  • SB HelpSystems ROBOT GenericForms of ransomware has been around for over 30 years, and with more and more organizations suffering attacks each year, it continues to endure. What has made ransomware such a durable threat and what is the best way to combat it? In order to prevent ransomware, organizations must first understand how it works.

  • SB HelpSystems ROBOT GenericIT security is a top priority for businesses around the world, but most IBM i pros don’t know where to begin—and most cybersecurity experts don’t know IBM i. In this session, Robin Tatam explores the business impact of lax IBM i security, the top vulnerabilities putting IBM i at risk, and the steps you can take to protect your organization. If you’re looking to avoid unexpected downtime or corrupted data, you don’t want to miss this session.

  • SB HelpSystems ROBOT GenericCan you trust all of your users all of the time? A typical end user receives 16 malicious emails each month, but only 17 percent of these phishing campaigns are reported to IT. Once an attack is underway, most organizations won’t discover the breach until six months later. A staggering amount of damage can occur in that time. Despite these risks, 93 percent of organizations are leaving their IBM i systems vulnerable to cybercrime. In this on-demand webinar, IBM i security experts Robin Tatam and Sandi Moore will reveal:

  • FORTRA Disaster protection is vital to every business. Yet, it often consists of patched together procedures that are prone to error. From automatic backups to data encryption to media management, Robot automates the routine (yet often complex) tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:

  • FORTRAManaging messages on your IBM i can be more than a full-time job if you have to do it manually. Messages need a response and resources must be monitored—often over multiple systems and across platforms. How can you be sure you won’t miss important system events? Automate your message center with the Robot Message Management Solution. Key features include:

  • FORTRAThe thought of printing, distributing, and storing iSeries reports manually may reduce you to tears. Paper and labor costs associated with report generation can spiral out of control. Mountains of paper threaten to swamp your files. Robot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing. Manage your reports with the Robot Report Management Solution. Key features include:

  • FORTRAFor over 30 years, Robot has been a leader in systems management for IBM i. With batch job creation and scheduling at its core, the Robot Job Scheduling Solution reduces the opportunity for human error and helps you maintain service levels, automating even the biggest, most complex runbooks. Manage your job schedule with the Robot Job Scheduling Solution. Key features include:

  • LANSA Business users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.

  • LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed. Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

  • LANSASupply Chain is becoming increasingly complex and unpredictable. From raw materials for manufacturing to food supply chains, the journey from source to production to delivery to consumers is marred with inefficiencies, manual processes, shortages, recalls, counterfeits, and scandals. In this webinar, we discuss how:

  • The MC Resource Centers bring you the widest selection of white papers, trial software, and on-demand webcasts for you to choose from. >> Review the list of White Papers, Trial Software or On-Demand Webcast at the MC Press Resource Center. >> Add the items to yru Cart and complet he checkout process and submit

  • Profound Logic Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.

  • SB Profound WC 5536Join us for this hour-long webcast that will explore:

  • Fortra IT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators with intimate knowledge of the operating system and the applications that run on it is small. This begs the question: How will you manage the platform that supports such a big part of your business? This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn: