com.ibm.as400.access

Class SystemStatus

  • java.lang.Object
    • com.ibm.as400.access.SystemStatus
  • All Implemented Interfaces:
    java.io.Serializable


    public class SystemStatus
    extends java.lang.Object
    implements java.io.Serializable
    Provides access to a group of statistics that represent the current status of the system.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      SystemStatus()
      Constructs a SystemStatus object.
      SystemStatus(AS400 system)
      Constructs a SystemStatus object.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
      Adds a PropertyChangeListener.
      void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
      Adds a VetoableChangeListener.
      int getActiveJobsInSystem()
      Returns the number of jobs active in the system (jobs that have been started, but have not yet ended), including both user and system jobs.
      int getActiveThreadsInSystem()
      Returns the number of initial and secondary threads in the system (threads that have been started, but have not yet ended), including both user and system threads.
      int getBatchJobsEndedWithPrinterOutputWaitingToPrint()
      Returns the number of completed batch jobs that produced printer output that is waiting to print.
      int getBatchJobsEnding()
      Returns the number of batch jobs that are in the process of ending due to one of the following conditions: The job finishes processing normally.
      int getBatchJobsHeldOnJobQueue()
      Returns the number of batch jobs that were submitted, but were held before they could begin running.
      int getBatchJobsHeldWhileRunning()
      Returns the number of batch jobs that had started running, but are now held.
      int getBatchJobsOnAHeldJobQueue()
      Returns the number of batch jobs on job queues that have been assigned to a subsystem, but are being held.
      int getBatchJobsOnUnassignedJobQueue()
      Returns the number of batch jobs on job queues that have not been assigned to a subsystem.
      int getBatchJobsRunning()
      Returns the number of batch jobs currently running on the system.
      int getBatchJobsWaitingForMessage()
      Returns the number of batch jobs waiting for a reply to a message before they can continue to run.
      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.
      float getCurrentProcessingCapacity()
      Returns the amount (in number of physical processors) of current processing capacity of the partition.
      int getCurrentUnprotectedStorageUsed()
      Returns the current amount of storage in use for temporary objects.
      java.util.Date getDateAndTimeStatusGathered()
      Returns the date and time when the status was gathered.
      int getElapsedTime()
      Returns the time (in seconds) that has elapsed between the measurement start time and the current system time.
      int getJobsInSystem()
      Returns the total number of user jobs and system jobs that are currently in the system.
      long getMainStorageSize()
      Returns the amount of main storage, in kilobytes, in the system.
      long getMaximumJobsInSystem()
      Returns the maximum number of jobs that are allowed on the system.
      int getMaximumUnprotectedStorageUsed()
      Returns the largest amount of storage for temporary object used at any one time since the last IPL.
      int getNumberOfPartitions()
      Returns the number of partitions on the system.
      int getNumberOfProcessors()
      Returns the number of processors that are currently active in this partition.
      int getPartitionIdentifier()
      Returns the identifier for the current partition in which the API is running.
      float getPercentCurrentInteractivePerformance()
      Returns the percentage of interactive performance assigned to this logical partition.
      float getPercentDBCapability()
      Returns the percentage of processor database capability that was used during the elapsed time.
      float getPercentPermanent256MBSegmentsUsed()
      Returns the percentage of the maximum possible permanent 256MB segments that have been used.
      float getPercentPermanent4GBSegmentsUsed()
      Returns the percentage of the maximum possible permanent 4GB segments that have been used.
      float getPercentPermanentAddresses()
      Returns the percentage of the maximum possible addresses for permanent objects that have been used.
      float getPercentProcessingUnitUsed()
      Returns the average of the elapsed time during which the processing units were in use.
      float getPercentSharedProcessorPoolUsed()
      Returns the percentage of the total shared processor pool capacity used by all partitions using the pool during the elapsed time.
      float getPercentSystemASPUsed()
      Returns the percentage of the system storage pool currently in use.
      float getPercentTemporary256MBSegmentsUsed()
      Returns the percentage of the maximum possible temporary 256MB segments that have been used.
      float getPercentTemporary4GBSegmentsUsed()
      Returns the percentage of the maximum possible temporary 4GB segments that have been used.
      float getPercentTemporaryAddresses()
      Returns the percentage of the maximum possible addresses for temporary objects that have been used.
      float getPercentUncappedCPUCapacityUsed()
      Returns the percentage of the uncapped shared processing capacity for the partition that was used during the elapsed time.
      int getPoolsNumber()
      Returns the number of system pools.
      int getProcessorSharingAttribute()
      Returns the processor sharing attribute.
      boolean getRestrictedStateFlag()
      Returns the value indicating whether the system is in restricted state.
      AS400 getSystem()
      Returns the system object representing the system from which the system status information will be retrieved.
      int getSystemASP()
      Returns the storage capacity of the system auxiliary storage pool (ASP1).
      java.lang.String getSystemName()
      Returns the name of the system where the statistics were collected.
      java.util.Enumeration getSystemPools()
      Returns an enumeration containing a SystemPool object for each system pool.
      int getTotalAuxiliaryStorage()
      Returns the total auxiliary storage (in millions of bytes) on the system.
      int getUsersCurrentSignedOn()
      Returns the number of users currently signed on the system.
      int getUsersSignedOffWithPrinterOutputWaitingToPrint()
      Returns the number of sessions that have ended with printer output files waiting to print.
      int getUsersSuspendedByGroupJobs()
      Returns the number of user jobs that have been temporarily suspended by group jobs so that another job may be run.
      int getUsersSuspendedBySystemRequest()
      Returns the number of user jobs that have been temporarily suspended by system request jobs so that another job may be run.
      int getUsersTemporarilySignedOff()
      Returns the number of jobs that have been disconnected due to either the selection of option 80 (Temporary sign-off) or the entry of the Disconnect Job (DSCJOB) command.
      boolean isCaching()
      Returns the current cache status.
      void refreshCache()
      Refreshes the current system status information.
      void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
      Removes the PropertyChangeListener.
      void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
      Removes the VetoableChangeListener.
      void reset()
      Reset the status statistics and elapsed time to zero
      void setCaching(boolean caching)
      Turns caching on or off.
      void setSystem(AS400 system)
      Sets the system object representing the system from which the system status information will be retrieved.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • SystemStatus

        public SystemStatus()
        Constructs a SystemStatus object.
      • SystemStatus

        public SystemStatus(AS400 system)
        Constructs a SystemStatus object.
        Parameters:
        system - The system object representing the system from which the status statistics should be retrieved.
    >
    • Method Detail

      • addPropertyChangeListener

        public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
        Adds a PropertyChangeListener. The specified PropertyChangeListener's propertyChange() method will be called each time the value of any bound property is changed.
        Parameters:
        listener - The listener.
        See Also:
        removePropertyChangeListener(java.beans.PropertyChangeListener)
      • addVetoableChangeListener

        public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
        Adds a VetoableChangeListener. The specified VetoableChangeListener's vetoableChange() method will be called each time the value of any constrained property is changed.
        Parameters:
        listener - The listener.
        See Also:
        removeVetoableChangeListener(java.beans.VetoableChangeListener)
      • getActiveJobsInSystem

        public int getActiveJobsInSystem()
                                  throws AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         java.lang.InterruptedException,
                                         java.io.IOException,
                                         ObjectDoesNotExistException
        Returns the number of jobs active in the system (jobs that have been started, but have not yet ended), including both user and system jobs.
        Returns:
        The number of jobs active in the system (jobs that have been started, but have not yet ended), including both user and system 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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getActiveThreadsInSystem

        public int getActiveThreadsInSystem()
                                     throws AS400SecurityException,
                                            ErrorCompletingRequestException,
                                            java.lang.InterruptedException,
                                            java.io.IOException,
                                            ObjectDoesNotExistException
        Returns the number of initial and secondary threads in the system (threads that have been started, but have not yet ended), including both user and system threads.
        Returns:
        The number of initial and secondary threads in the system (threads that have been started, but have not yet ended), including both user and system threads.
        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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getBatchJobsEndedWithPrinterOutputWaitingToPrint

        public int getBatchJobsEndedWithPrinterOutputWaitingToPrint()
                                                             throws AS400SecurityException,
                                                                    ErrorCompletingRequestException,
                                                                    java.lang.InterruptedException,
                                                                    java.io.IOException,
                                                                    ObjectDoesNotExistException
        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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getBatchJobsEnding

        public int getBatchJobsEnding()
                               throws AS400SecurityException,
                                      ErrorCompletingRequestException,
                                      java.lang.InterruptedException,
                                      java.io.IOException,
                                      ObjectDoesNotExistException
        Returns the number of batch jobs that are in the process of ending 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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getBatchJobsOnAHeldJobQueue

        public int getBatchJobsOnAHeldJobQueue()
                                        throws AS400SecurityException,
                                               ErrorCompletingRequestException,
                                               java.lang.InterruptedException,
                                               java.io.IOException,
                                               ObjectDoesNotExistException
        Returns the number of batch jobs on job queues that have been assigned to a subsystem, but are being held.
        Returns:
        The number of batch jobs on job queues that have been assigned to a subsystem, but are being 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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getBatchJobsWaitingToRunOrAlreadyScheduled

        public int getBatchJobsWaitingToRunOrAlreadyScheduled()
                                                       throws AS400SecurityException,
                                                              ErrorCompletingRequestException,
                                                              java.lang.InterruptedException,
                                                              java.io.IOException,
                                                              ObjectDoesNotExistException
        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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getCurrentProcessingCapacity

        public float getCurrentProcessingCapacity()
                                           throws AS400SecurityException,
                                                  ErrorCompletingRequestException,
                                                  java.lang.InterruptedException,
                                                  java.io.IOException,
                                                  ObjectDoesNotExistException
        Returns the amount (in number of physical processors) of current processing capacity of the partition. For a partition sharing physical processors, this attribute represents the share of the physical processors in the pool it is executing.
        Returns:
        The amount of current processing capacity of the partition.
        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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getJobsInSystem

        public int getJobsInSystem()
                            throws AS400SecurityException,
                                   ErrorCompletingRequestException,
                                   java.lang.InterruptedException,
                                   java.io.IOException,
                                   ObjectDoesNotExistException
        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 pending job logs or 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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getMaximumJobsInSystem

        public long getMaximumJobsInSystem()
                                    throws AS400SecurityException,
                                           ErrorCompletingRequestException,
                                           java.lang.InterruptedException,
                                           java.io.IOException,
                                           ObjectDoesNotExistException
        Returns the maximum number of jobs that are allowed on the system. When the number of jobs reaches this maximum, you can no longer submit or start more jobs on 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 maximum number of jobs that are allowed 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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getMaximumUnprotectedStorageUsed

        public int getMaximumUnprotectedStorageUsed()
                                             throws AS400SecurityException,
                                                    ErrorCompletingRequestException,
                                                    java.lang.InterruptedException,
                                                    java.io.IOException,
                                                    ObjectDoesNotExistException
        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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getPercentCurrentInteractivePerformance

        public float getPercentCurrentInteractivePerformance()
                                                      throws AS400SecurityException,
                                                             ErrorCompletingRequestException,
                                                             java.lang.InterruptedException,
                                                             java.io.IOException,
                                                             ObjectDoesNotExistException
        Returns the percentage of interactive performance assigned to this logical partition. This value is a percentage of the total interactive performance available to the entire physical system.
        Returns:
        The percentage of interactive performance assigned to this logical partition.
        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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getPercentDBCapability

        public float getPercentDBCapability()
                                     throws AS400SecurityException,
                                            ErrorCompletingRequestException,
                                            java.lang.InterruptedException,
                                            java.io.IOException,
                                            ObjectDoesNotExistException
        Returns the percentage of processor database capability that was used during the elapsed time. Database capability is the maximum CPU utilization available for database processing on this system. -1 is returned if this system does not report the amount of CPU used for database processing.
        Returns:
        The percentage of processor database capability that was used during the elapsed 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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getPercentProcessingUnitUsed

        public float getPercentProcessingUnitUsed()
                                           throws AS400SecurityException,
                                                  ErrorCompletingRequestException,
                                                  java.lang.InterruptedException,
                                                  java.io.IOException,
                                                  ObjectDoesNotExistException
        Returns the average of the elapsed time during which the processing units were in use. For an uncapped partition, this is the percentage of the configured uncapped shared processing capacity for the partition that was used during the elapsed time. This percentage could be greater than 100% for an uncapped partition.
        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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getPercentSharedProcessorPoolUsed

        public float getPercentSharedProcessorPoolUsed()
                                                throws AS400SecurityException,
                                                       ErrorCompletingRequestException,
                                                       java.lang.InterruptedException,
                                                       java.io.IOException,
                                                       ObjectDoesNotExistException
        Returns the percentage of the total shared processor pool capacity used by all partitions using the pool during the elapsed time. -1 is returned if this partition does not share processors.
        Returns:
        The percentage of the total shared processor pool capacity used by all partitions using the pool during the elapsed 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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getPercentUncappedCPUCapacityUsed

        public float getPercentUncappedCPUCapacityUsed()
                                                throws AS400SecurityException,
                                                       ErrorCompletingRequestException,
                                                       java.lang.InterruptedException,
                                                       java.io.IOException,
                                                       ObjectDoesNotExistException
        Returns the percentage of the uncapped shared processing capacity for the partition that was used during the elapsed time. -1 is returned if this partition can not use more than its configured processing capacity.
        Returns:
        The percentage of the uncapped shared processing capacity for the partition that was used during the elapsed 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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getProcessorSharingAttribute

        public int getProcessorSharingAttribute()
                                         throws AS400SecurityException,
                                                ErrorCompletingRequestException,
                                                java.lang.InterruptedException,
                                                java.io.IOException,
                                                ObjectDoesNotExistException
        Returns the processor sharing attribute. This attribute indicates whether this partition is sharing processors. If the value indicates the partition does not share physical processors, then this partition uses only dedicated processors. If the value indicates the partition shares physical processors, then this partition uses physical processors from a shared pool of physical processors. The following values are returned:
        • 0: Partition does not share processors.
        • 1: Partition shares processors (capped). The partition is limited to using its configured capacity.
        • 2: Partition shares processors (uncapped). The partition can use more than its configured capacity.
        Returns:
        The processor sharing attribute.
        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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getSystem

        public AS400 getSystem()
        Returns the system object representing the system from which the system status information will be retrieved.
        Returns:
        The system object representing the system from which the system status information will be retrieved. If the system has not been set, null is returned.
      • getUsersSignedOffWithPrinterOutputWaitingToPrint

        public int getUsersSignedOffWithPrinterOutputWaitingToPrint()
                                                             throws AS400SecurityException,
                                                                    ErrorCompletingRequestException,
                                                                    java.lang.InterruptedException,
                                                                    java.io.IOException,
                                                                    ObjectDoesNotExistException
        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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getUsersSuspendedByGroupJobs

        public int getUsersSuspendedByGroupJobs()
                                         throws AS400SecurityException,
                                                ErrorCompletingRequestException,
                                                java.lang.InterruptedException,
                                                java.io.IOException,
                                                ObjectDoesNotExistException
        Returns the number of user jobs that have been temporarily suspended by group jobs so that another job may be run.
        Returns:
        The number of user jobs that have been temporarily suspended by group 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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getUsersSuspendedBySystemRequest

        public int getUsersSuspendedBySystemRequest()
                                             throws AS400SecurityException,
                                                    ErrorCompletingRequestException,
                                                    java.lang.InterruptedException,
                                                    java.io.IOException,
                                                    ObjectDoesNotExistException
        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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • getUsersTemporarilySignedOff

        public int getUsersTemporarilySignedOff()
                                         throws AS400SecurityException,
                                                ErrorCompletingRequestException,
                                                java.lang.InterruptedException,
                                                java.io.IOException,
                                                ObjectDoesNotExistException
        Returns the number of jobs that have been disconnected due to either the selection of option 80 (Temporary sign-off) or the entry of the Disconnect Job (DSCJOB) command.
        Returns:
        The number of jobs that have been disconnected due to either the selection of option 80 (Temporary sign-off) or the entry of the Disconnect Job (DSCJOB) command.
        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 system.
        ObjectDoesNotExistException - If the object does not exist on the system.
      • 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 the PropertyChangeListener. If the PropertyChangeListener is not on the list, nothing is done.
        Parameters:
        listener - The listener.
      • removeVetoableChangeListener

        public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
        Removes the VetoableChangeListener. If the VetoableChangeListener is not on the list, nothing is done.
        Parameters:
        listener - The listener.
      • setCaching

        public void setCaching(boolean caching)
        Turns caching on or off.
        Parameters:
        caching - true if caching should be used when getting information from the system; false if every get should communicate with the system immediately. The default behavior is no caching.
        See Also:
        isCaching(), refreshCache()
      • setSystem

        public void setSystem(AS400 system)
                       throws java.beans.PropertyVetoException
        Sets the system object representing the system from which the system status information will be retrieved. This property cannot be changed if the object has established a connection to the system.
        Parameters:
        system - The system object representing the system from which the system status information will be retrieved.
        Throws:
        java.beans.PropertyVetoException - If any of the registered listeners vetos the property change.