com.ibm.as400.access
Class AS400JPing

java.lang.Object
  |
  +--com.ibm.as400.access.AS400JPing

public class AS400JPing

extends java.lang.Object

The AS400JPing class is used to determine if OS/400 services are running.

Here is an example of calling AS400JPing within a Java program to ping the AS400 Remote Command Service:

  AS400JPing pingObj = new AS400JPing("myAS400", AS400.COMMAND, false);
  if (pingObj.ping())
     System.out.println("SUCCESS");
  else
     System.out.println("FAILED");
  

Field Summary

static int

ALL_SERVICES Constant for pinging all the OS/400 services.

Constructor Summary

AS400JPing(java.lang.String systemName)
Constructs an AS400JPing object with the specified systemName.

AS400JPing(java.lang.String systemName, int service)
Constructs an AS400JPing object with the specified systemName and service.

AS400JPing(java.lang.String systemName, int service, boolean useSSL)
Constructs an AS400JPing object.

Method Summary

boolean	ping() Ping the iSeries server.
boolean	ping(int service) Ping a specific OS/400 service.
void	setPrintWriter(java.io.OutputStream stream) Set the PrintWriter to log ping information to.
void	setTimeout(long time) Set the timeout period in milliseconds.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALL_SERVICES

public static final int ALL_SERVICES

Constant for pinging all the OS/400 services.

See Also:

Constant Field Values

Constructor Detail

AS400JPing

public AS400JPing(java.lang.String systemName)

Constructs an AS400JPing object with the specified systemName. A JPing object created with this constructor will ping all of the OS/400 services when ping() is called.

Parameters:

systemName - The server to ping. The systemName string can be in 3 forms: shortname (eg. "myAS400"), longname (eg. "myAS400.myCompany.com"), or IP address (eg. "9.1.2.3").

AS400JPing

public AS400JPing(java.lang.String systemName,
                  int service)

Constructs an AS400JPing object with the specified systemName and service.

Parameters:

systemName - The server to ping. The systemName string can be in 3 forms: shortname (eg. "myAS400"), longname (eg. "myAS400.myCompany.com"), or IP address (eg. "9.1.2.3").

service - The AS/40 service to ping. One of the following constants: AS400.FILE, AS400.DATABASE, AS400.COMMAND, AS400.SIGNON, AS400.CENTRAL, AS400.DATAQUEUE, AS400.RECORDACCESS, AS400.PRINT, or ALL_SERVICES.

See Also:

AS400

AS400JPing

public AS400JPing(java.lang.String systemName,
                  int service,
                  boolean useSSL)

Constructs an AS400JPing object.

Parameters:

systemName - The server to ping. The systemName string can be in 3 forms: shortname (eg. "myAS400"), longname (eg. "myAS400.myCompany.com"), or IP address (eg. "9.1.2.3").

service - The OS/400 service to ping. One of the following constants: AS400.FILE, AS400.DATABASE, AS400.COMMAND, AS400.SIGNON, AS400.CENTRAL, AS400.DATAQUEUE, AS400.RECORDACCESS, AS400.PRINT, or ALL_SERVICES.

useSSL - true if the pinging the SSL port for the service, false otherwise. The default is false.

See Also:

AS400

Method Detail

ping

public boolean ping()

Ping the iSeries server.

Returns:

true if all of the services can be pinged successfully, and false otherwise.

ping

public boolean ping(int service)

Ping a specific OS/400 service. One of the following constants: AS400.FILE, AS400.DATABASE, AS400.COMMAND, AS400.SIGNON, AS400.CENTRAL, AS400.DATAQUEUE, AS400.RECORDACCESS, AS400.PRINT, or ALL_SERVICES.

Returns:

true if the service can be pinged successfully, and false otherwise.

setPrintWriter

public void setPrintWriter(java.io.OutputStream stream)
                    throws java.io.IOException

Set the PrintWriter to log ping information to.

Throws:

java.io.IOException - If an error occurs while accessing the stream.

setTimeout

public void setTimeout(long time)

Set the timeout period in milliseconds. The default timeout period is 20000 (20 sec).

Parameters:

time - The timeout period.