com.ibm.as400.access
Class SystemStatus
java.lang.Object
|
+--com.ibm.as400.access.SystemStatus
- public class SystemStatus
- extends java.lang.Object
- implements java.io.Serializable
The SystemStatus class represents the system status on the AS/400.
It provides facilities for retrieving system status information.
- See Also:
- Serialized Form
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
SystemStatus
public SystemStatus()
- Constructs a SystemStatus object.
SystemStatus
public SystemStatus(AS400 as400)
- Constructs a SystemStatus object.
- Parameters:
as400
- The AS400 system.
addPropertyChangeListener
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
- Adds a listener to be notified when the value of any bound property
changes.
- Parameters:
listener
- The listener.
addVetoableChangeListener
public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
- Adds a listener to be notified when the value of any constrained property
changes.
- Parameters:
listener
- The listener.
getBatchJobsEndedWithPrinterOutputWaitingToPrint
public int getBatchJobsEndedWithPrinterOutputWaitingToPrint()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- 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.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getBatchJobsEnding
public int getBatchJobsEnding()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- Returns the number of batch jobs that are in the process of ending.
This may be due to one of the following conditions:
- The job finishes processing normally.
- The job ends before its normal completion point and is being
removed from the system.
- Returns:
- The number of batch jobs that are in the process of ending.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getBatchJobsHeldOnJobQueue
public int getBatchJobsHeldOnJobQueue()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- 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.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getBatchJobsHeldWhileRunning
public int getBatchJobsHeldWhileRunning()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- 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.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getBatchJobsOnUnassignedJobQueue
public int getBatchJobsOnUnassignedJobQueue()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- 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.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getBatchJobsRunning
public int getBatchJobsRunning()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- Returns the number of batch jobs currently running on the system.
- Returns:
- The number of batch jobs currently running on the system.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getBatchJobsWaitingForMessage
public int getBatchJobsWaitingForMessage()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- 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.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getBatchJobsWaitingToRunOrAlreadyScheduled
public int getBatchJobsWaitingToRunOrAlreadyScheduled()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- 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.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getCurrentUnprotectedStorageUsed
public int getCurrentUnprotectedStorageUsed()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- 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.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getDateAndTimeStatusGathered
public java.util.Date getDateAndTimeStatusGathered()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- 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.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getElapsedTime
public int getElapsedTime()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- Returns the time (in seconds) that has elapsed between the
measurement start time and the current system time.
- Returns:
- The time (in seconds) that has elapsed between the
measurement start time and the current system time.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getJobsInSystem
public int getJobsInSystem()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- Returns the total number of user jobs and system jobs that are
currently in the system. The total includes:
- All jobs on job queues waiting to be processed.
- All jobs currently active (being processed).
- All jobs that have completed running but still have output on
output queues to be produced.
- Returns:
- The total number of user jobs and system jobs that are
currently in the system.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getMaximumUnprotectedStorageUsed
public int getMaximumUnprotectedStorageUsed()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- 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.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getPercentPermanentAddresses
public float getPercentPermanentAddresses()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- 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.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getPercentProcessingUnitUsed
public float getPercentProcessingUnitUsed()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- 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.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getPercentSystemASPUsed
public float getPercentSystemASPUsed()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- Returns the percentage of the system storage pool currently in use.
- Returns:
- The percentage of the system storage pool currently in use.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getPercentTemporaryAddresses
public float getPercentTemporaryAddresses()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- 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.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getPoolsNumber
public int getPoolsNumber()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- Returns the number of system pools.
- Returns:
- The number of the system pools.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getRestrictedStateFlag
public boolean getRestrictedStateFlag()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- Returns the value indicating whether the system is in restricted state.
- Returns:
- true if the system is in restricted state; false otherwise.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getSystem
public AS400 getSystem()
- Returns the AS/400 system.
- Returns:
- The AS/400 system.
getSystemASP
public int getSystemASP()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- 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).
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getSystemPools
public java.util.Enumeration getSystemPools()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- Returns the enumeration containing a SystemPool object for each
system pool.
- Returns:
- The enumeration containing a SystemPool object for each
system pool.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getTotalAuxiliaryStorage
public int getTotalAuxiliaryStorage()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- Returns the total auxiliary storage (in millions of bytes) on
the system.
- Returns:
- The total auxiliary storage (in millions of bytes) on
the system.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getUsersCurrentSignedOn
public int getUsersCurrentSignedOn()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- 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.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getUsersSignedOffWithPrinterOutputWaitingToPrint
public int getUsersSignedOffWithPrinterOutputWaitingToPrint()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- 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.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getUsersSuspendedBySystemRequest
public int getUsersSuspendedBySystemRequest()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- 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.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
getUsersTemporarilySignedOff
public int getUsersTemporarilySignedOff()
throws AS400SecurityException,
ErrorCompletingRequestException,
java.lang.InterruptedException,
java.io.IOException,
ObjectDoesNotExistException,
java.io.UnsupportedEncodingException
- 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.
- Throws:
- AS400SecurityException - If a security or authority error
occurs.
- ErrorCompletingRequestException - If an error occurs before
the request is completed.
- java.lang.InterruptedException - If this thread is interrupted.
- java.io.IOException - If an error occurs while communicating with
the AS/400.
- ObjectDoesNotExistException - If the AS/400 object does not
exist.
- java.io.UnsupportedEncodingException - If the character encoding is
not supported.
isCaching
public boolean isCaching()
- Returns the current cache status.
The default behavior is no caching.
- Returns:
- true if caching is enabled, false otherwise.
- See Also:
refreshCache()
,
setCaching(boolean)
refreshCache
public void refreshCache()
- Refreshes the current system status information. The
currently cached data is cleared and new data will
be retrieved from the system when needed. That is,
after a call to refreshCache(), a call to one of the get()
methods will go to the system to retrieve the value.
If caching is not enabled, this method does nothing.
- See Also:
isCaching()
,
setCaching(boolean)
removePropertyChangeListener
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
- Removes a property change listener.
- Parameters:
listener
- The listener.
removeVetoableChangeListener
public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
- Removes a vetoable change listener.
- Parameters:
listener
- The listener.
setCaching
public void setCaching(boolean cache)
- Turns caching on or off.
- Parameters:
cache
- true if caching should be used when getting
and setting information to and from the AS/400; false
if every get or set should communicate with the AS/400
immediately. Any cached changes that are not committed
when caching is turned off will be lost.
The default behavior is no caching.- See Also:
isCaching()
,
refreshCache()
setSystem
public void setSystem(AS400 system)
throws java.beans.PropertyVetoException
- Sets the AS/400 system.
- Parameters:
as400
- The AS/400 system from which the system status information
will be retrieved.- Throws:
- java.beans.PropertyVetoException - If the change is vetoed.