Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm
Class ListNetworkInterfaces

java.lang.Object
  extended by com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor
      extended by com.ibm.etools.iseries.comm.ListNetworkInterfaces
All Implemented Interfaces:
IISeriesAPIProcessor

public class ListNetworkInterfaces
extends ISeriesAbstractHostAPIProcessor

ListNetworkInterfaces is a Java wrapper for the OS/400 List Network Interfaces API (QtocLstNetIfc) system API which returns a list of all logical TCP/IP interfaces with details. This wrapper currently only supports the NIFC0100 format which retrieves TCP/IP v4 network interfaces (as opposed to TCP/IP v6 network interfaces.)

Since:
WebSphere Development Studio Client for iSeries V5.1

Nested Class Summary
 
Nested classes/interfaces inherited from class com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor
ISeriesAbstractHostAPIProcessor.HostAPIErrorCodeStructure
 
Field Summary
static String Copyright
           
 
Fields inherited from class com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor
cancel, cancellableSubTasks, cancelQuerier, CREATE_FALSE, CREATE_TRUE, dbcsConvert, DEFAULT_OBJECT_FACTORY_BASIC, DEFAULT_OBJECT_FACTORY_BRIEF, DEFAULT_OBJECT_FACTORY_EXHAUSTIVE, DEFAULT_OBJECT_FACTORY_NAMEONLY, errorcodeObj, hostAPILibraries, INFOLEVEL_BASIC, INFOLEVEL_BRIEF, INFOLEVEL_EXHAUSTIVE, INFOLEVEL_NAME, INFOLEVEL_NAMEARRAY, INITIAL_SPACESIZE, LOG_DIR, LOG_FILENAME, logFile, logFileStream, logLineCounter, logStandardOut, NEED_USERSPACE_NO, NEED_USERSPACE_YES, objName, objType, QVDEOBJLinfo, returnObjectFactory, todos, tracePrefix, warnings
 
Constructor Summary
ListNetworkInterfaces()
          Constructor to use when you do not already have an AS400 object.
ListNetworkInterfaces(AS400 system)
          Constructor
 
Method Summary
 List retrieveInterfaceList()
          Retrieve the list of network interfaces from the remote system.
 
Methods inherited from class com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor
addCancellableSubTask, addWarning, cancel, clearWarnings, closeUserSpace, computeSize, createUserSpaceOnHost, determineInfoLevel, getClientCCSID, getDefaultObjectFactory, getErrorCodeStructure, getHostCCSID, getLibrary, getLogFileStream, getObjectFactory, getObjectName, getObjectType, getSystem, getUserSpace, getUserSpaceAPIName, getUserSpaceIFSName, getUserSpaceLibrary, getUserSpaceName, getWarnings, isCancelled, isTraceOn, logException, logHostMessages, logMessage, logMessage, logMessage, logTodo, openUserSpace, padString, parseBin8Date, parseChar13Date, parseChar7Date, parseChar8Date, readUserSpace, readUserSpace, registerCancelQuerier, removeCancellableSubTask, setClientCCSID, setHostCCSID, setLibrary, setLogFileDirectory, setObjectFactory, setObjectName, setObjectType, setSystem, setTracing, setUserSpaceLibrary, setUserSpaceName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Constructor Detail

ListNetworkInterfaces

public ListNetworkInterfaces()
Constructor to use when you do not already have an AS400 object. A new AS400 object will be created when retrieveInterfaceList is called, unless you subsequently call setSystem(AS400) first.


ListNetworkInterfaces

public ListNetworkInterfaces(AS400 system)
Constructor

Parameters:
system - AS400 object used to connect to the iSeries
Method Detail

retrieveInterfaceList

public List retrieveInterfaceList()
                           throws Exception
Retrieve the list of network interfaces from the remote system.

Returns:
A list of ISeriesTCPIPNetworkInterface instances.
Throws:
Exception
See Also:
ISeriesTCPIPNetworkInterface

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.