com.ibm.as400.access
Class SystemPool

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

public class SystemPool
extends java.lang.Object

The SystemPool class represents a system pool on an AS/400. 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
static float CALCULATE
          Constant used to indicate that the AS/400 should calculate a system pool attribute.
static int CALCULATE_INT
           
 
Constructor Summary
SystemPool()
          Constructs a SystemPool object.
SystemPool(AS400 system, java.lang.String poolName)
          Constructs a SystemPool object.
 
Method Summary
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Adds a listener to be notified when the value of any bound property changes.
 void addVetoableChangeListener(java.beans.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 AS/400.
 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.
 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.
 java.lang.String getDescription()
          Returns the description of the system pool.
 int getMaximumActiveThreads()
          Returns the maximum number of threads that can be active in the pool at any one time.
 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.
 java.lang.String getPagingOption()
          Returns the value indicating whether the system will dynamically adjust the paging characteristics of the storage pool for optimum performance.
 int getPoolIdentifier()
          Returns the pool identifier.
 java.lang.String getPoolName()
          Returns the name of this storage pool.
 int getPoolSize()
          Returns the amount of main storage, in kilobytes, in the pool.
 int getReservedSize()
          Returns the amount of storage, in kilobytes, in the pool reserved for system use (for example, for save and restore operations).
 java.lang.String getSubsystemName()
          Returns the subsystem with which this storage pool is associated.
 AS400 getSystem()
          Returns the AS/400 system.
 float getWaitToIneligible()
          Returns the rate, in transitions per minute, of transitions of threads from a waiting condition to an ineligible condition.
 boolean isCaching()
          Returns the current cache status.
 void loadInformation()
          Loads the system pool information.
 void refreshCache()
           
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Removes a property change listener.
 void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
          Removes a vetoable change listener.
 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 setPagingOption(java.lang.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)
          Sets the activity level for the pool.
 void setPoolName(java.lang.String poolName)
          Sets the system pool name.
 void setPoolSize(int value)
          Sets the size of the system pool in kilobytes, where one kilobyte is 1024 bytes.
 void setPriority(int value)
          Sets the priority of this pool relative the priority of the other storage pools.
 void setSystem(AS400 system)
          Sets the AS/400 system.
 java.lang.String toString()
          Return the pool name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CALCULATE

public static final float CALCULATE
Constant used to indicate that the AS/400 should calculate a system pool attribute.

CALCULATE_INT

public static final int CALCULATE_INT
Constructor Detail

SystemPool

public SystemPool()
Constructs a SystemPool object.

SystemPool

public SystemPool(AS400 system,
                  java.lang.String poolName)
Constructs a SystemPool object.
Parameters:
system - The AS/400 system.
poolName - The name of the system pool.
Method Detail

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.

commitCache

public void commitCache()
                 throws AS400Exception,
                        AS400SecurityException,
                        ConnectionDroppedException,
                        ErrorCompletingRequestException,
                        java.lang.InterruptedException,
                        java.io.IOException,
                        ObjectDoesNotExistException,
                        java.io.UnsupportedEncodingException
Commits any cached system pool information changes to the AS/400. If caching is not enabled, this method does nothing.
Throws:
AS400Exception - If the AS/400 system returns an error message.
AS400SecurityException - If a security or authority error occurs.
ConnectionDroppedException - If the connection is dropped unexpectedly.
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.
See Also:
isCaching(), refreshCache(), setCaching(boolean)

getActiveToIneligible

public float getActiveToIneligible()
                            throws AS400SecurityException,
                                   ErrorCompletingRequestException,
                                   java.lang.InterruptedException,
                                   java.io.IOException,
                                   ObjectDoesNotExistException,
                                   java.io.UnsupportedEncodingException
Returns the rate, in transitions per minute, of transitions of threads from an active condition to an ineligible condition.
Returns:
The rate.
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.

getActiveToWait

public float getActiveToWait()
                      throws AS400SecurityException,
                             ErrorCompletingRequestException,
                             java.lang.InterruptedException,
                             java.io.IOException,
                             ObjectDoesNotExistException,
                             java.io.UnsupportedEncodingException
Returns the rate, in transitions per minute, of transitions of threads from an active condition to a waiting condition.
Returns:
The rate.
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.

getDatabaseFaults

public float getDatabaseFaults()
                        throws AS400SecurityException,
                               ErrorCompletingRequestException,
                               java.lang.InterruptedException,
                               java.io.IOException,
                               ObjectDoesNotExistException,
                               java.io.UnsupportedEncodingException
Returns the rate, shown in page faults per second, of database page faults against pages containing either database data or access paths. A page fault is a program notification that occurs when a page that is marked as not in main storage is referred to be an active program. An access path is the means by which the system provides a logical organization to the data in a database file.
Returns:
The rate.
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.

getDatabasePages

public float getDatabasePages()
                       throws AS400SecurityException,
                              ErrorCompletingRequestException,
                              java.lang.InterruptedException,
                              java.io.IOException,
                              ObjectDoesNotExistException,
                              java.io.UnsupportedEncodingException
Returns the rate, in pages per second, at which database pages are brought into the storage pool.
Returns:
The rate.
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.

getDescription

public java.lang.String getDescription()
Returns the description of the system pool.
Returns:
The description of the system pool.

getMaximumActiveThreads

public int getMaximumActiveThreads()
                            throws AS400SecurityException,
                                   ErrorCompletingRequestException,
                                   java.lang.InterruptedException,
                                   java.io.IOException,
                                   ObjectDoesNotExistException,
                                   java.io.UnsupportedEncodingException
Returns the maximum number of threads that can be active in the pool at any one time.
Returns:
The maximum number of 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 AS/400.
ObjectDoesNotExistException - If the AS/400 object does not exist.
java.io.UnsupportedEncodingException - If the character encoding is not supported.

getNonDatabaseFaults

public float getNonDatabaseFaults()
                           throws AS400SecurityException,
                                  ErrorCompletingRequestException,
                                  java.lang.InterruptedException,
                                  java.io.IOException,
                                  ObjectDoesNotExistException,
                                  java.io.UnsupportedEncodingException
Returns the rate, in page faults per second, of nondatabase page faults against pages other than those designated as database pages.
Returns:
The rate.
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.

getNonDatabasePages

public float getNonDatabasePages()
                          throws AS400SecurityException,
                                 ErrorCompletingRequestException,
                                 java.lang.InterruptedException,
                                 java.io.IOException,
                                 ObjectDoesNotExistException,
                                 java.io.UnsupportedEncodingException
Returns the rate, in page per second, at which non-database pages are brought into the storage pool.
Returns:
The rate.
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.

getPagingOption

public java.lang.String getPagingOption()
                                 throws AS400SecurityException,
                                        ErrorCompletingRequestException,
                                        java.lang.InterruptedException,
                                        java.io.IOException,
                                        ObjectDoesNotExistException,
                                        java.io.UnsupportedEncodingException
Returns the value indicating whether the system will dynamically adjust the paging characteristics of the storage pool for optimum performance. The following special values may be returned. *FIXED: The system does not dynamically adjust the paging characteristics. *CALC: The system dynamically adjusts the paging characteristics. USRDFN: The system does not dynamically adjust the paging characteristics for the storage pool but uses values that have been defined through an API.
Returns:
The value indicating whether the system will dynamically adjust the paging characteristics of the storage pool for optimum performance.
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.

getPoolIdentifier

public int getPoolIdentifier()
                      throws AS400SecurityException,
                             ErrorCompletingRequestException,
                             java.lang.InterruptedException,
                             java.io.IOException,
                             ObjectDoesNotExistException,
                             java.io.UnsupportedEncodingException
Returns the pool identifier.
Returns:
The pool identifier.
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.

getPoolName

public java.lang.String getPoolName()
Returns the name of this storage pool. The name may be a number, in which case it is a private pool associated with a subsystem. The following special values may be returned:

  • *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 - *SHRPOOL10 The specified pool definition is defined to be a shared pool. For v4r3, this is *SHRPOOL60.

    Returns:
    The pool name.

  • getPoolSize

    public int getPoolSize()
                    throws AS400SecurityException,
                           ErrorCompletingRequestException,
                           java.lang.InterruptedException,
                           java.io.IOException,
                           ObjectDoesNotExistException,
                           java.io.UnsupportedEncodingException
    Returns the amount of main storage, in kilobytes, in the pool.
    Returns:
    The pool size.
    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.

    getReservedSize

    public int getReservedSize()
                        throws AS400SecurityException,
                               ErrorCompletingRequestException,
                               java.lang.InterruptedException,
                               java.io.IOException,
                               ObjectDoesNotExistException,
                               java.io.UnsupportedEncodingException
    Returns the amount of storage, in kilobytes, in the pool reserved for system use (for example, for save and restore operations). The system calculates this amount by using storage pool sizes and activity levels.
    Returns:
    The reserved size.
    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.

    getSubsystemName

    public java.lang.String getSubsystemName()
                                      throws AS400SecurityException,
                                             ErrorCompletingRequestException,
                                             java.lang.InterruptedException,
                                             java.io.IOException,
                                             ObjectDoesNotExistException,
                                             java.io.UnsupportedEncodingException
    Returns the subsystem with which this storage pool is associated. The field will be blank for shared pools.
    Returns:
    The subsystem name.
    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.

    getWaitToIneligible

    public float getWaitToIneligible()
                              throws AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     java.lang.InterruptedException,
                                     java.io.IOException,
                                     ObjectDoesNotExistException,
                                     java.io.UnsupportedEncodingException
    Returns the rate, in transitions per minute, of transitions of threads from a waiting condition to an ineligible condition.
    Returns:
    The rate.
    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:
    commitCache(), refreshCache(), setCaching(boolean)

    loadInformation

    public void loadInformation()
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                java.lang.InterruptedException,
                                java.io.IOException,
                                ObjectDoesNotExistException,
                                java.io.UnsupportedEncodingException
    Loads the system pool information. The AS/400 system and the system pool name should be set before this method is invoked. Note: This method is equivalent to the refreshCache() method.
    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.

    refreshCache

    public void refreshCache()

    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. If caching is turned off, the next get() or set() will go to the system.
    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:
    commitCache(), isCaching(), refreshCache()

    setFaults

    public void setFaults(float minValue,
                          float perValue,
                          float maxValue)
                   throws AS400Exception,
                          AS400SecurityException,
                          ConnectionDroppedException,
                          ErrorCompletingRequestException,
                          java.lang.InterruptedException,
                          java.io.IOException,
                          ObjectDoesNotExistException,
                          java.beans.PropertyVetoException,
                          java.io.UnsupportedEncodingException
    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. The sum of mimimum faults and per-thread faults must be less than the value of the maximum faults parameter. Each value is used by the system if the performance adjustment (QPFRADJ) system value is set to 2 or 3. If you want the system to calculate the priority, you must specify SystemPool.CALCULATE for each parameter.
    Parameters:
    minValue - The new minimum faults-per-second guideline.
    perValue - The new faults per second for each active thread.
    maxValue - The new maximum faults-per-second guideline.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    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.beans.PropertyVetoException - If the change is vetoed.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.

    setMaximumFaults

    public void setMaximumFaults(float value)
                          throws AS400Exception,
                                 AS400SecurityException,
                                 ConnectionDroppedException,
                                 ErrorCompletingRequestException,
                                 java.lang.InterruptedException,
                                 java.io.IOException,
                                 ObjectDoesNotExistException,
                                 java.beans.PropertyVetoException,
                                 java.io.UnsupportedEncodingException
    Sets the maximum faults-per-second guideline to use for this storage pool. The sum of mimimum faults and per-thread faults must be less than the value of the maximum faults parameter. This value is used by the system if the performance adjustment (QPFRADJ) system value is set to 2 or 3. If you want the system to calculate the priority, you must specify SystemPool.CALCULATE for this parameter.
    Parameters:
    value - The new maximum faults-per-second guideline.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    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.beans.PropertyVetoException - If the change is vetoed.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.

    setMaximumPoolSize

    public void setMaximumPoolSize(float value)
                            throws AS400Exception,
                                   AS400SecurityException,
                                   ConnectionDroppedException,
                                   ErrorCompletingRequestException,
                                   java.lang.InterruptedException,
                                   java.io.IOException,
                                   ObjectDoesNotExistException,
                                   java.beans.PropertyVetoException,
                                   java.io.UnsupportedEncodingException
    Sets the maximum amount of storage to allocate to this storage pool (as a percentage of total main storage). This value cannot be less than the minimum pool size % parameter value. This value is used by the system if the performance adjustment (QPFRADJ) system value is set to 2 or 3. If you want the system to calculate the priority, you must specify SystemPool.CALCULATE for this parameter.
    Parameters:
    value - The new maximum pool size.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    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.beans.PropertyVetoException - If the change is vetoed.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.

    setMessageLogging

    public void setMessageLogging(boolean log)
                           throws AS400Exception,
                                  AS400SecurityException,
                                  ConnectionDroppedException,
                                  ErrorCompletingRequestException,
                                  java.lang.InterruptedException,
                                  java.io.IOException,
                                  ObjectDoesNotExistException,
                                  java.beans.PropertyVetoException,
                                  java.io.UnsupportedEncodingException
    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. This affects the logging of change-related messages only; it does not affect the logging of error messages. Valid values are:

  • true - Log change messages.
  • false - Do not log change messages.

    The default value for messages logging is true.
    Parameters:
    value - 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.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    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.beans.PropertyVetoException - If the change is vetoed.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.

  • setMinimumFaults

    public void setMinimumFaults(float value)
                          throws AS400Exception,
                                 AS400SecurityException,
                                 ConnectionDroppedException,
                                 ErrorCompletingRequestException,
                                 java.lang.InterruptedException,
                                 java.io.IOException,
                                 ObjectDoesNotExistException,
                                 java.beans.PropertyVetoException,
                                 java.io.UnsupportedEncodingException
    Sets the minimum faults-per-second guideline to use for this storage pool. This value is used by the system if the performance adjustment (QPFRADJ) system value is set to 2 or 3. If you want the system to calculate the priority, you must specify -2 for this parameter. If you do not want this value to change, you may specify -1 for this parameter.
    Parameters:
    value - The new minumum faults-per-second guideline.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    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.beans.PropertyVetoException - If the change is vetoed.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.

    setMinAndMaxPoolSize

    public void setMinAndMaxPoolSize(float minValue,
                                     float maxValue)
                              throws AS400Exception,
                                     AS400SecurityException,
                                     ConnectionDroppedException,
                                     ErrorCompletingRequestException,
                                     java.lang.InterruptedException,
                                     java.io.IOException,
                                     ObjectDoesNotExistException,
                                     java.beans.PropertyVetoException,
                                     java.io.UnsupportedEncodingException
    Sets the minimum and maximum amount of storage to allocate to this storage pool (as a percentage of total main storage). Maximum value cannot be less than the minimum pool size % parameter value. Each value is used by the system if the performance adjustment (QPFRADJ) system value is set to 2 or 3. If you want the system to calculate the priority, you must specify SystemPool.CALCULATE for each parameter.
    Parameters:
    minValue - The new minimum pool size.
    maxValue - The new maximum pool size.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    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.beans.PropertyVetoException - If the change is vetoed.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.

    setMinimumPoolSize

    public void setMinimumPoolSize(float value)
                            throws AS400Exception,
                                   AS400SecurityException,
                                   ConnectionDroppedException,
                                   ErrorCompletingRequestException,
                                   java.lang.InterruptedException,
                                   java.io.IOException,
                                   ObjectDoesNotExistException,
                                   java.beans.PropertyVetoException,
                                   java.io.UnsupportedEncodingException
    Sets the minimum amount of storage to allocate to this storage pool (as a percentage of total main storage). This value cannot be greater than the maximum pool size % parameter value. This value is used by the system if the performance adjustment (QPFRADJ) system value is set to 2 or 3. If you want the system to calculate the priority, you must specify SystemPool.CALCULATE for this parameter.
    Parameters:
    value - The new minimum pool size.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    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.beans.PropertyVetoException - If the change is vetoed.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.

    setPagingOption

    public void setPagingOption(java.lang.String value)
                         throws AS400Exception,
                                AS400SecurityException,
                                ConnectionDroppedException,
                                ErrorCompletingRequestException,
                                java.lang.InterruptedException,
                                java.io.IOException,
                                ObjectDoesNotExistException,
                                java.beans.PropertyVetoException,
                                java.io.UnsupportedEncodingException
    Sets the value indicating whether the system dynamically adjust the paging characteristics of the storage pool for optimum performance. Valid values are:

  • *SAME - The paging option for the storage pool is not changed.
  • *FIXED - The system will not dynamically adjust the paging characteristics; system default values are used.
  • *CALC - The system will dynamically adjust the paging characteristics.
    Parameters:
    value - The value indicating whether the system dynamically adjust the paging characteristics of the sorage pool for optimum performance.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    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.beans.PropertyVetoException - If the change is vetoed.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.

  • setPerThreadFaults

    public void setPerThreadFaults(float value)
                            throws AS400Exception,
                                   AS400SecurityException,
                                   ConnectionDroppedException,
                                   ErrorCompletingRequestException,
                                   java.lang.InterruptedException,
                                   java.io.IOException,
                                   ObjectDoesNotExistException,
                                   java.beans.PropertyVetoException,
                                   java.io.UnsupportedEncodingException
    Sets the faults per second for each active thread in this storage pool. Each job is comprised of one or more threads. The system multiples this number by the number of active threads that it finds in the pool. This result is added to the minimum faults parameter to calculate the faults-per-second guideline to use for this pool. This value is used by the system if the performance adjustment (QPFRADJ) system value is set to 2 or 3. If you want the system to calculate the priority, you must specify SystemPool.CALCULATE for this parameter.
    Parameters:
    value - The new faults.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    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.beans.PropertyVetoException - If the change is vetoed.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.

    setPoolActivityLevel

    public void setPoolActivityLevel(int value)
                              throws AS400Exception,
                                     AS400SecurityException,
                                     ConnectionDroppedException,
                                     ErrorCompletingRequestException,
                                     java.lang.InterruptedException,
                                     java.io.IOException,
                                     ObjectDoesNotExistException,
                                     java.beans.PropertyVetoException,
                                     java.io.UnsupportedEncodingException
    Sets the activity level for the pool. The activity level of the machine pool can not be changed.
    Parameters:
    value - The new activity level for the pool.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    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.beans.PropertyVetoException - If the change is vetoed.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.

    setPoolName

    public void setPoolName(java.lang.String poolName)
                     throws java.beans.PropertyVetoException
    Sets the system pool name.
    Parameters:
    poolName - The name of the system pool.
    Throws:
    java.beans.PropertyVetoException - If the change is vetoed.

    setPoolSize

    public void setPoolSize(int value)
                     throws AS400Exception,
                            AS400SecurityException,
                            ConnectionDroppedException,
                            ErrorCompletingRequestException,
                            java.lang.InterruptedException,
                            java.io.IOException,
                            ObjectDoesNotExistException,
                            java.beans.PropertyVetoException,
                            java.io.UnsupportedEncodingException
    Sets the size of the system pool in kilobytes, where one kilobyte is 1024 bytes. The minimum value is 32 kilobytes. For V4R3 and later, the minimum is 256.
    Parameters:
    value - The new size of the system pool.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    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.beans.PropertyVetoException - If the change is vetoed.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.

    setPriority

    public void setPriority(int value)
                     throws AS400Exception,
                            AS400SecurityException,
                            ConnectionDroppedException,
                            ErrorCompletingRequestException,
                            java.lang.InterruptedException,
                            java.io.IOException,
                            ObjectDoesNotExistException,
                            java.beans.PropertyVetoException,
                            java.io.UnsupportedEncodingException
    Sets the priority of this pool relative the priority of the other storage pools. Valid values are 1 through 14. The priority for the *MACHINE pool must be 1. This value is used by the system if the performance adjustment (QPFRADJ) system value is set to 2 or 3. If you want the system to calculate the priority, you must specify SystemPool.CALCULATE_INT for this parameter.
    Parameters:
    value - The new priority.
    Throws:
    AS400Exception - If the AS/400 system returns an error message.
    AS400SecurityException - If a security or authority error occurs.
    ConnectionDroppedException - If the connection is dropped unexpectedly.
    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.beans.PropertyVetoException - If the change is vetoed.
    java.io.UnsupportedEncodingException - If the character encoding is not supported.

    setSystem

    public void setSystem(AS400 system)
                   throws java.beans.PropertyVetoException
    Sets the AS/400 system.
    Parameters:
    system - The AS/400 system.
    Throws:
    java.beans.PropertyVetoException - If the change is vetoed.

    toString

    public java.lang.String toString()
    Return the pool name.
    Overrides:
    toString in class java.lang.Object
    Returns:
    The pool name.