com.ibm.as400.access

Class SystemPool


  • public class SystemPool
extends Object
    Represents a system pool. It provides facilities for retrieving and changing system pool information. Here is a example: 

      try {
      // Creates AS400 object.
      AS400 as400 = new AS400("systemName");
      // Constructs a SystemPool object
      SystemPool systemPool = new SystemPool(as400,"*SPOOL");
      // Gets system pool attributes.
      System.out.println("Paging option : "+systemPool.getPagingOption());

  } catch (Exception e)
  {
      System.out.println("error : "+e)
  }

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static float CALCULATE
      Deprecated.  
      static int CALCULATE_INT
      Deprecated.  

    • Constructor Summary

      Constructors 
      Constructor and Description
      SystemPool()
      Constructs a SystemPool object.
      SystemPool(AS400 system, int poolIdentifier)
      Constructs a SystemPool object, to represent a pool identified by its unique system pool identifier.
      SystemPool(AS400 system, String poolName)
      Constructs a SystemPool object, to represent a shared system pool.
      SystemPool(AS400 system, String poolName, int poolIdentifier)
      Deprecated. 
      Use SystemPool(system, poolIdentifier) instead.
      SystemPool(Subsystem subsystem, int sequenceNumber)
      Constructs a SystemPool object, to represent a subsystem (non-shared) pool.
      SystemPool(Subsystem subsystem, int sequenceNumber, int size, int activityLevel)
      Constructs a SystemPool object, to represent a subsystem (non-shared) pool.
      SystemPool(Subsystem subsystem, int sequenceNumber, long size, int activityLevel)
      Constructs a SystemPool object, to represent a subsystem (non-shared) pool.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void addPropertyChangeListener(PropertyChangeListener listener)
      Adds a listener to be notified when the value of any bound property changes.
      void addVetoableChangeListener(VetoableChangeListener listener)
      Adds a listener to be notified when the value of any constrained property changes.
      void commitCache()
      Commits any cached system pool information changes to the system.
      boolean equals(Object obj)
      Determines whether this SystemPool object is equal to another object.
      float getActiveToIneligible()
      Returns the rate, in transitions per minute, of transitions of threads from an active condition to an ineligible condition.
      float getActiveToWait()
      Returns the rate, in transitions per minute, of transitions of threads from an active condition to a waiting condition.
      int getActivityLevel()
      Returns the activity level for the pool.
      float getDatabaseFaults()
      Returns the rate, shown in page faults per second, of database page faults against pages containing either database data or access paths.
      float getDatabasePages()
      Returns the rate, in pages per second, at which database pages are brought into the storage pool.
      String getDescription()
      Returns the description of the system pool.
      int getIdentifier()
      Returns the system pool identifier.
      int getMaximumActiveThreads()
      Deprecated. 
      Use getActivityLevel() instead.
      String getName()
      Returns the name of this storage pool.
      float getNonDatabaseFaults()
      Returns the rate, in page faults per second, of nondatabase page faults against pages other than those designated as database pages.
      float getNonDatabasePages()
      Returns the rate, in page per second, at which non-database pages are brought into the storage pool.
      String getPagingOption()
      Returns the value indicating whether the system will dynamically adjust the paging characteristics of the storage pool for optimum performance.
      int getPoolIdentifier()
      Deprecated. 
      Use getIdentifier() instead.
      String getPoolName()
      Deprecated. 
      Use getName() instead.
      int getPoolSize()
      Deprecated. 
      Use getSize() instead.
      int getReservedSize()
      Returns the amount of storage, in kilobytes, in the pool reserved for system use.
      int getSize()
      Returns the amount of main storage, in kilobytes, currently allocated to the pool.
      long getSizeLong()
      Returns the amount of main storage, in kilobytes, currently allocated to the pool.
      String getSubsystemLibrary()
      Returns the library of the subsystem with which this storage pool is associated.
      String getSubsystemName()
      Returns the subsystem with which this storage pool is associated.
      AS400 getSystem()
      Returns the system.
      float getWaitToIneligible()
      Returns the rate, in transitions per minute, of transitions of threads from a waiting condition to an ineligible condition.
      int hashCode()
      Returns a hash code value for the object.
      boolean isCaching()
      Returns the current cache status.
      boolean isShared()
      Indicates whether the pool is a shared system pool.
      static boolean isValidNameForSharedPool(String name)
      Indicates whether the pool name is a valid name for a shared system pool.
      void loadInformation()
      Loads the system pool information.
      void refreshCache() 
      void removePropertyChangeListener(PropertyChangeListener listener)
      Removes a property change listener.
      void removeVetoableChangeListener(VetoableChangeListener listener)
      Removes a vetoable change listener.
      void setActivityLevel(int value)
      Sets the activity level for the pool.
      void setCaching(boolean cache)
      Turns caching on or off.
      void setFaults(float minValue, float perValue, float maxValue)
      Sets the minimum faults-per-second guideline, the faults per second for each active thread, and the maximum faults-per-second guideline for this storage pool.
      void setMaximumFaults(float value)
      Sets the maximum faults-per-second guideline to use for this storage pool.
      void setMaximumPoolSize(float value)
      Sets the maximum amount of storage to allocate to this storage pool (as a percentage of total main storage).
      void setMessageLogging(boolean log)
      Sets the value indicating whether messages reporting that a change was made are written to the current job's job log and to the QHST message log.
      void setMinAndMaxPoolSize(float minValue, float maxValue)
      Sets the minimum and maximum amount of storage to allocate to this storage pool (as a percentage of total main storage).
      void setMinimumFaults(float value)
      Sets the minimum faults-per-second guideline to use for this storage pool.
      void setMinimumPoolSize(float value)
      Sets the minimum amount of storage to allocate to this storage pool (as a percentage of total main storage).
      void setName(String poolName)
      Sets the system pool name.
      void setPagingOption(String value)
      Sets the value indicating whether the system dynamically adjust the paging characteristics of the storage pool for optimum performance.
      void setPerThreadFaults(float value)
      Sets the faults per second for each active thread in this storage pool.
      void setPoolActivityLevel(int value)
      Deprecated. 
      Use setActivityLevel() instead.
      void setPoolName(String poolName)
      Deprecated. 
      Use setName() instead.
      void setPoolSize(int value)
      Deprecated. 
      Use setSize() instead.
      void setPriority(int value)
      Sets the priority of this pool relative the priority of the other storage pools.
      void setSize(int value)
      Sets the size of the system pool in kilobytes, where one kilobyte is 1024 bytes.
      void setSizeLong(long value)
      Sets the size of the system pool in kilobytes, where one kilobyte is 1024 bytes.
      void setSystem(AS400 system)
      Sets the system.
      String toString()
      Return the pool name.
Returns:
The pool name.

  • getName

    public String getName()
    Returns the name of this storage pool. The name may be a number, in which case it is a non-shared pool associated with a subsystem. The following special values may be returned, in the case of shared pools:

  • *MACHINE The specified pool definition is defined to be the machine pool.
  • *BASE The specified pool definition is defined to be the base system pool, which can be shared with other subsystems.
  • *INTERACT The specified pool definition is defined to be shared pool used for interactive work.
  • *SPOOL The specified pool definition is defined to be the shared pool used for spooled writers.
  • *SHRPOOL1 - *SHRPOOL60 The specified pool definition is defined to be a shared pool.

Returns:
The pool name. If the pool name cannot be determined, null is returned.