All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.access.SystemStatus

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

public class SystemStatus
extends Object
The SystemStatus class represents the system status on the AS/400. It provides facilities for retrieving system status information.


Constructor Index

 o SystemStatus()
Constructs a SystemStatus object.
 o SystemStatus(AS400)
Constructs a SystemStatus object.

Method Index

 o addPropertyChangeListener(PropertyChangeListener)
Adds a listener to be notified when the value of any bound property changes.
 o addVetoableChangeListener(VetoableChangeListener)
Adds a listener to be notified when the value of any constrained property changes.
 o getBatchJobsEndedWithPrinterOutputWaitingToPrint()
Returns the number of completed batch jobs that produced printer output that is waiting to print.
 o getBatchJobsEnding()
Returns the number of batch jobs that are in the process of ending.
 o getBatchJobsHeldOnJobQueue()
Returns the number of batch jobs that were submitted, but were held before they could begin running.
 o getBatchJobsHeldWhileRunning()
Returns the number of batch jobs that had started running, but are now held.
 o getBatchJobsOnUnassignedJobQueue()
Returns the number of batch jobs on job queues that have not been assigned to a subsystem.
 o getBatchJobsRunning()
Returns the number of batch jobs currently running on the system.
 o getBatchJobsWaitingForMessage()
Returns the number of batch jobs waiting for a reply to a message before they can continue to run.
 o getBatchJobsWaitingToRunOrAlreadyScheduled()
Returns the number of batch jobs on the system that are currently waiting to run, including those that were submitted to run at a future date and time.
 o getCurrentUnprotectedStorageUsed()
Returns the current amount of storage in use for temporary objects.
 o getDateAndTimeStatusGathered()
Returns the date and time when the status was gathered.
 o getElapsedTime()
Returns the time (in milliseconds) that has elapsed between the measurement start time and the current system time.
 o getJobsInSystem()
Returns the total number of user jobs and system jobs that are currently in the system.
 o getMaximumUnprotectedStorageUsed()
Returns the largest amount of storage for temporary object used at any one time since the last IPL.
 o getPercentPermanentAddresses()
Returns the percentage of the maximum possible addresses for permanent objects that have been used.
 o getPercentProcessingUnitUsed()
Returns the average of the elapsed time during which the processing units were in use.
 o getPercentSystemASPUsed()
Returns the percentage of the system storage pool currently in use.
 o getPercentTemporaryAddresses()
Returns the percentage of the maximum possible addresses for temporary objects that have been used.
 o getPoolsNumber()
Returns the number of system pools.
 o getRestrictedStateFlag()
Returns the value indicating whether the system is in restricted state.
 o getSystem()
Returns the AS/400 system.
 o getSystemASP()
Returns the storage capacity of the system auxiliary storage pool(ASP1).
 o getSystemPools()
Returns the enumeration containing a SystemPool object for each system pool.
 o getTotalAuxiliaryStorage()
Returns the total auxiliary storage (in millions of bytes) on the system.
 o getUsersCurrentSignedOn()
Returns the number of users currently signed on the system.
 o getUsersSignedOffWithPrinterOutputWaitingToPrint()
Returns the number of sessions that have ended with printer output files waiting to print.
 o getUsersSuspendedBySystemRequest()
Returns the number of user jobs that have been temporarily suspended by system request jobs so that another job may be run.
 o getUsersTemporarilySignedOff()
Returns the number of interactive jobs that are disconnected plus the number of disconnected jobs.
 o removePropertyChangeListener(PropertyChangeListener)
Removes a property change listener.
 o removeVetoableChangeListener(VetoableChangeListener)
Removes a vetoable change listener.
 o setSystem(AS400)
Sets the AS/400 system.

Constructors

 o SystemStatus
 public SystemStatus()
Constructs a SystemStatus object.

 o SystemStatus
 public SystemStatus(AS400 as400) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, ObjectDoesNotExistException, IOException, UnsupportedEncodingException, PropertyVetoException
Constructs a SystemStatus object.

Parameters:
as400 - The AS400 system.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: PropertyVetoException
If the change is vetoed.
Throws: UnsupportedEncodingException
If the character encoding is not supported.

Methods

 o addPropertyChangeListener
 public void addPropertyChangeListener(PropertyChangeListener listener)
Adds a listener to be notified when the value of any bound property changes.

Parameters:
listener - The listener.
 o addVetoableChangeListener
 public void addVetoableChangeListener(VetoableChangeListener listener)
Adds a listener to be notified when the value of any constrained property changes.

Parameters:
listener - The listener.
 o getBatchJobsEndedWithPrinterOutputWaitingToPrint
 public int getBatchJobsEndedWithPrinterOutputWaitingToPrint()
Returns the number of completed batch jobs that produced printer output that is waiting to print.

Returns:
The number of completed batch jobs that produced printer output that is waiting to print.
 o getBatchJobsEnding
 public int getBatchJobsEnding()
Returns the number of batch jobs that are in the process of ending. This may be due to one of the following conditions:

Returns:
The number of batch jobs that are in the process of ending.
 o getBatchJobsHeldOnJobQueue
 public int getBatchJobsHeldOnJobQueue()
Returns the number of batch jobs that were submitted, but were held before they could begin running.

Returns:
The number of batch jobs that were submitted, but were held before they could begin running.
 o getBatchJobsHeldWhileRunning
 public int getBatchJobsHeldWhileRunning()
Returns the number of batch jobs that had started running, but are now held.

Returns:
The number of batch jobs that had started running, but are now held.
 o getBatchJobsOnUnassignedJobQueue
 public int getBatchJobsOnUnassignedJobQueue()
Returns the number of batch jobs on job queues that have not been assigned to a subsystem.

Returns:
The number of batch jobs on job queues that have not been assigned to a subsystem.
 o getBatchJobsRunning
 public int getBatchJobsRunning()
Returns the number of batch jobs currently running on the system.

Returns:
The number of batch jobs currently running on the system.
 o getBatchJobsWaitingForMessage
 public int getBatchJobsWaitingForMessage()
Returns the number of batch jobs waiting for a reply to a message before they can continue to run.

Returns:
The number of batch jobs waiting for a reply to a message before they can continue to run.
 o getBatchJobsWaitingToRunOrAlreadyScheduled
 public int getBatchJobsWaitingToRunOrAlreadyScheduled()
Returns the number of batch jobs on the system that are currently waiting to run, including those that were submitted to run at a future date and time. Jobs on the job schedule that have not been submitted are not included.

Returns:
The number of batch jobs on the system that are currently waiting to run.
 o getCurrentUnprotectedStorageUsed
 public int getCurrentUnprotectedStorageUsed()
Returns the current amount of storage in use for temporary objects. This value is in millions of bytes.

Returns:
The current amount of storage in use for temporary objects.
 o getDateAndTimeStatusGathered
 public Date getDateAndTimeStatusGathered()
Returns the date and time when the status was gathered. This is in system timestamp format.

Returns:
The date and time when the status was gathered.
 o getElapsedTime
 public int getElapsedTime()
Returns the time (in milliseconds) that has elapsed between the measurement start time and the current system time. This value is in the format HHMMSS where HH is the hour, MM is the minute, and SS is the second.

Returns:
The time (in milliseconds) that has elapsed between the measurement start time and the current system time.
 o getJobsInSystem
 public int getJobsInSystem()
Returns the total number of user jobs and system jobs that are currently in the system. The total includes:

Returns:
The total number of user jobs and system jobs that are currently in the system.
 o getMaximumUnprotectedStorageUsed
 public int getMaximumUnprotectedStorageUsed()
Returns the largest amount of storage for temporary object used at any one time since the last IPL. This value is in millions (M) of bytes.

Returns:
The largest amount of storage for temporary object used at any one time since the last IPL.
 o getPercentPermanentAddresses
 public float getPercentPermanentAddresses()
Returns the percentage of the maximum possible addresses for permanent objects that have been used.

Returns:
The percentage of the maximum possible addresses for permanent objects that have been used.
 o getPercentProcessingUnitUsed
 public float getPercentProcessingUnitUsed()
Returns the average of the elapsed time during which the processing units were in use.

Returns:
The average of the elapsed time during which the processing units were in use.
 o getPercentSystemASPUsed
 public float getPercentSystemASPUsed()
Returns the percentage of the system storage pool currently in use.

Returns:
The percentage of the system storage pool currently in use.
 o getPercentTemporaryAddresses
 public float getPercentTemporaryAddresses()
Returns the percentage of the maximum possible addresses for temporary objects that have been used.

Returns:
The percentage of the maximum possible addresses for temporary objects that have been used.
 o getPoolsNumber
 public int getPoolsNumber()
Returns the number of system pools.

Returns:
The number of the system pools.
 o getRestrictedStateFlag
 public boolean getRestrictedStateFlag()
Returns the value indicating whether the system is in restricted state.

Returns:
true if the system is in restricted state; false otherwise.
 o getSystem
 public AS400 getSystem()
Returns the AS/400 system.

Returns:
The AS/400 system.
 o getSystemASP
 public int getSystemASP()
Returns the storage capacity of the system auxiliary storage pool(ASP1). This value is in millions(M) of bytes.

Returns:
The storage capacity of the system auxiliary storage pool(ASP1).
 o getSystemPools
 public Enumeration getSystemPools()
Returns the enumeration containing a SystemPool object for each system pool.

Returns:
The enumeration containing a SystemPool object for each system pool.
 o getTotalAuxiliaryStorage
 public int getTotalAuxiliaryStorage()
Returns the total auxiliary storage (in millions of bytes) on the system.

Returns:
The total auxiliary storage (in millions of bytes) on the system.
 o getUsersCurrentSignedOn
 public int getUsersCurrentSignedOn()
Returns the number of users currently signed on the system. System request jobs and group jobs are not included in this number.

Returns:
The number of users currently signed on the system.
 o getUsersSignedOffWithPrinterOutputWaitingToPrint
 public int getUsersSignedOffWithPrinterOutputWaitingToPrint()
Returns the number of sessions that have ended with printer output files waiting to print.

Returns:
The number of sessions that have ended with printer output files waiting to print.
 o getUsersSuspendedBySystemRequest
 public int getUsersSuspendedBySystemRequest()
Returns the number of user jobs that have been temporarily suspended by system request jobs so that another job may be run.

Returns:
The number of user jobs that have been temporarily suspended by system request jobs so that another job may be run.
 o getUsersTemporarilySignedOff
 public int getUsersTemporarilySignedOff()
Returns the number of interactive jobs that are disconnected plus the number of disconnected jobs.

Returns:
The number of interactive jobs that are disconnected plus the number of disconnected jobs.
 o removePropertyChangeListener
 public void removePropertyChangeListener(PropertyChangeListener l)
Removes a property change listener.

Parameters:
listener - The listener.
 o removeVetoableChangeListener
 public void removeVetoableChangeListener(VetoableChangeListener l)
Removes a vetoable change listener.

Parameters:
listener - The listener.
 o setSystem
 public void setSystem(AS400 system) throws AS400Exception, AS400SecurityException, ConnectionDroppedException, ErrorCompletingRequestException, InterruptedException, ObjectDoesNotExistException, IOException, UnsupportedEncodingException, PropertyVetoException
Sets the AS/400 system.

Parameters:
as400 - The AS/400 system from which the system status information will be retrieved.
Throws: AS400Exception
If the AS/400 system returns an error message.
Throws: AS400SecurityException
If a security or authority error occurs.
Throws: ConnectionDroppedException
If the connection is dropped unexpectedly.
Throws: ErrorCompletingRequestException
If an error occurs before the request is completed.
Throws: InterruptedException
If this thread is interrupted.
Throws: IOException
If an error occurs while communicating with the AS/400.
Throws: ObjectDoesNotExistException
If the AS/400 object does not exist.
Throws: PropertyVetoException
If the change is vetoed.
Throws: UnsupportedEncodingException
If the character encoding is not supported.

All Packages  Class Hierarchy  This Package  Previous  Next  Index