SystemPool

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

public class SystemPool
extends java.lang.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.

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, java.lang.String poolName)` Constructs a SystemPool object, to represent a shared system pool.
`SystemPool(AS400 system, java.lang.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.

Method Summary

Methods
Modifier and Type	Method and Description
`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 system.
`boolean`	`equals(java.lang.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.
`java.lang.String`	`getDescription()` Returns the description of the system pool.
`int`	`getIdentifier()` Returns the system pool identifier.
`int`	`getMaximumActiveThreads()` Deprecated. Use getActivityLevel() instead.
`java.lang.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.
`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()` Deprecated. Use getIdentifier() instead.
`java.lang.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.
`java.lang.String`	`getSubsystemLibrary()` Returns the library of the subsystem with which this storage pool is associated.
`java.lang.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(java.lang.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(java.beans.PropertyChangeListener listener)` Removes a property change listener.
`void`	`removeVetoableChangeListener(java.beans.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(java.lang.String poolName)` Sets the system pool name.
`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)` Deprecated. Use setActivityLevel() instead.
`void`	`setPoolName(java.lang.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`	`setSystem(AS400 system)` Sets the system.
`java.lang.String`	`toString()` Return the pool name.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - CALCULATE
```
public static final float CALCULATE
```
    Deprecated.
    
    Indicates that the system should calculate a system pool attribute.
    
    See Also:
    Constant Field Values
  - CALCULATE_INT
```
public static final int CALCULATE_INT
```
    Deprecated.
    
    Indicates that the system should calculate a system pool attribute.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - SystemPool
```
public SystemPool()
```
    Constructs a SystemPool object.
  - SystemPool
```
public SystemPool(AS400 system,
          java.lang.String poolName)
```
    Constructs a SystemPool object, to represent a shared system pool.
    
    Parameters:
    system - The system.
    poolName - The name of the shared system pool. Valid values are *MACHINE, *BASE, *INTERACT, *SPOOL, and *SHRPOOL1-60.
  - SystemPool
```
public SystemPool(Subsystem subsystem,
          int sequenceNumber)
```
    Constructs a SystemPool object, to represent a subsystem (non-shared) pool.
    
    Parameters:
    subsystem - The subsystem that "owns" the pool.
    sequenceNumber - The pool's sequence number within the subsystem. Valid values are 1 through 10.
  - SystemPool
```
public SystemPool(Subsystem subsystem,
          int sequenceNumber,
          int size,
          int activityLevel)
```
    Constructs a SystemPool object, to represent a subsystem (non-shared) pool.
    
    Parameters:
    subsystem - The subsystem that "owns" the pool.
    sequenceNumber - The pool's sequence number within the subsystem. Valid values are 1 through 10.
    size - The size of the system pool, in kilobytes.
    activityLevel - The activity level of the pool.
  - SystemPool
```
public SystemPool(AS400 system,
          java.lang.String poolName,
          int poolIdentifier)
```
    Deprecated. Use SystemPool(system, poolIdentifier) instead.
    
    Constructs a SystemPool object, to represent a shared system pool.
    
    Parameters:
    system - The system.
    poolName - The name of the shared system pool. Valid values are *MACHINE, *BASE, *INTERACT, *SPOOL, and *SHRPOOL1-60.
    poolIdentifier - The system pool identifier. Valid values are 1 through 64.
  - SystemPool
```
public SystemPool(AS400 system,
          int poolIdentifier)
```
    Constructs a SystemPool object, to represent a pool identified by its unique system pool identifier. Either a shared pool or a non-shared pool can be specified.
    
    Parameters:
    system - The system.
    poolIdentifier - The system pool identifier. Valid values are 1 through 64.
- 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 system. If caching is not enabled, this method does nothing.
    
    Throws:
    
    AS400Exception - If the 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 system.
    
    ObjectDoesNotExistException - If the object does not exist on the system.
    
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
    See Also:
    isCaching(), refreshCache(), setCaching(boolean)
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Determines whether this SystemPool object is equal to another object.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Returns:
    true if the two instances are equal.
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for the object.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    A hash code value for this object.
  - 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 system.
    
    ObjectDoesNotExistException - If the object does not exist on the system.
    
    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 system.
    
    ObjectDoesNotExistException - If the object does not exist on the system.
    
    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 system.
    
    ObjectDoesNotExistException - If the object does not exist on the system.
    
    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 system.
    
    ObjectDoesNotExistException - If the object does not exist on the system.
    
    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
```
    Deprecated. Use getActivityLevel() instead.
    
    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 system.
    
    ObjectDoesNotExistException - If the object does not exist on the system.
    
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
  - getActivityLevel
```
public int getActivityLevel()
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            java.lang.InterruptedException,
                            java.io.IOException,
                            ObjectDoesNotExistException,
                            java.io.UnsupportedEncodingException
```
    Returns the activity level for the pool. This is the maximum number of threads that can be active in the pool at any one time.
    
    Returns:
    The pool activity level.
    
    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.
    
    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 system.
    
    ObjectDoesNotExistException - If the object does not exist on the system.
    
    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 system.
    
    ObjectDoesNotExistException - If the object does not exist on the system.
    
    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 system.
    
    ObjectDoesNotExistException - If the object does not exist on the system.
    
    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
```
    Deprecated. Use getIdentifier() instead.
    
    Returns the system pool identifier.
    
    Returns:
    The system 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 system.
    
    ObjectDoesNotExistException - If the object does not exist on the system.
    
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
  - getIdentifier
```
public int getIdentifier()
                  throws AS400SecurityException,
                         ErrorCompletingRequestException,
                         java.lang.InterruptedException,
                         java.io.IOException,
                         ObjectDoesNotExistException,
                         java.io.UnsupportedEncodingException
```
    Returns the system pool identifier. The system assigns a unique identifier (from 1 through 64) to each system storage pool that currently has main storage allocated. If the pool is inactive, 0 is returned.
    
    Returns:
    The system pool identifier. 0 indicates that the pool is inactive.
    
    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.
    
    java.io.UnsupportedEncodingException - If the character encoding is not supported.
  - getPoolName
```
public java.lang.String getPoolName()
```
    Deprecated. Use getName() instead.
    
    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.

getName
```
public java.lang.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.

getPoolSize
```
public int getPoolSize()
                throws AS400SecurityException,
                       ErrorCompletingRequestException,
                       java.lang.InterruptedException,
                       java.io.IOException,
                       ObjectDoesNotExistException,
                       java.io.UnsupportedEncodingException
```
Deprecated. Use getSize() instead.

Returns the amount of main storage, in kilobytes, currently allocated to the pool. Note: Depending on system storage availability, this may be less than the pool's requested ("defined") size.

Returns:
The pool size, in kilobytes.

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.

java.io.UnsupportedEncodingException - If the character encoding is not supported.

getSize
```
public int getSize()
            throws AS400SecurityException,
                   ErrorCompletingRequestException,
                   java.lang.InterruptedException,
                   java.io.IOException,
                   ObjectDoesNotExistException,
                   java.io.UnsupportedEncodingException
```
Returns the amount of main storage, in kilobytes, currently allocated to the pool. Note: Depending on system storage availability, this may be less than the pool's requested ("defined") size.

Returns:
The pool size, in kilobytes.

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.

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 system.

ObjectDoesNotExistException - If the object does not exist on the system.

java.io.UnsupportedEncodingException - If the character encoding is not supported.

getSubsystemLibrary
```
public java.lang.String getSubsystemLibrary()
                                     throws AS400SecurityException,
                                            ErrorCompletingRequestException,
                                            java.lang.InterruptedException,
                                            java.io.IOException,
                                            ObjectDoesNotExistException,
                                            java.io.UnsupportedEncodingException
```
Returns the library of the subsystem with which this storage pool is associated. The field will be blank for shared pools.

Returns:
The subsystem library.

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.

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 system.

ObjectDoesNotExistException - If the object does not exist on the system.

java.io.UnsupportedEncodingException - If the character encoding is not supported.

getSystem
```
public AS400 getSystem()
```
Returns the system.

Returns:
The 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 system.

ObjectDoesNotExistException - If the object does not exist on the system.

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)

isShared
```
public boolean isShared()
```
Indicates whether the pool is a shared system pool.
Note: In some cases, this method may incorrectly report false for a shared pool; for example, if the object was constructed using SystemPool(system, poolIdentifier), and the pool name is not *MACHINE, *BASE, *INTERACT, *SPOOL, or *SHRPOOL1-60.

Returns:
true if it's a shared system pool, false otherwise.

loadInformation
```
public void loadInformation()
                     throws AS400SecurityException,
                            ErrorCompletingRequestException,
                            java.lang.InterruptedException,
                            java.io.IOException,
                            ObjectDoesNotExistException,
                            java.io.UnsupportedEncodingException
```
Loads the system pool information. The system and the system pool name or identifier 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 system.

ObjectDoesNotExistException - If the object does not exist on the system.

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.

isValidNameForSharedPool
```
public static final boolean isValidNameForSharedPool(java.lang.String name)
```
Indicates whether the pool name is a valid name for a shared system pool.
Note: In some cases, this method may incorrectly report false for a name that actually specifies a shared pool; for example, for a shared pool with a non-standard name.

Returns:
true if poolName is *MACHINE, *BASE, *INTERACT, *SPOOL, or *SHRPOOLxx; false otherwise.

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 system; false if every get or set should communicate with the system 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 minimum 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.
Note: This method is supported only for shared pools, not for subsystem (non-shared) pools.

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 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 system.

ObjectDoesNotExistException - If the object does not exist on the system.

java.beans.PropertyVetoException - If the change is vetoed.

java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
isShared()

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 minimum 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.
Note: This method is supported only for shared pools, not for subsystem (non-shared) pools.

Parameters:
value - The new maximum faults-per-second guideline.

Throws:

AS400Exception - If the 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 system.

ObjectDoesNotExistException - If the object does not exist on the system.

java.beans.PropertyVetoException - If the change is vetoed.

java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
isShared()

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.
Note: This method is supported only for shared pools, not for subsystem (non-shared) pools.

Parameters:
value - The new maximum pool size.

Throws:

AS400Exception - If the 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 system.

ObjectDoesNotExistException - If the object does not exist on the system.

java.beans.PropertyVetoException - If the change is vetoed.

java.io.UnsupportedEncodingException - If the character encoding is not supported.
See Also:
isShared()

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.

Methods inherited from class java.lang.Object

CALCULATE

CALCULATE_INT

SystemPool

SystemPool

SystemPool

SystemPool

SystemPool

SystemPool

addPropertyChangeListener

addVetoableChangeListener

commitCache

equals

hashCode

getActiveToIneligible

getActiveToWait

getDatabaseFaults

getDatabasePages

getDescription

getMaximumActiveThreads

getActivityLevel

getNonDatabaseFaults

getNonDatabasePages

getPagingOption

getPoolIdentifier

getIdentifier

getPoolName

setPerThreadFaults

setPoolActivityLevel

setActivityLevel

setPoolName

setName

setPoolSize

setSize

setPriority

setSystem

toString