com.ibm.as400.access.PTFGroupList Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jt400 Show documentation
The Open Source version of the IBM Toolbox for Java
The newest version!
///////////////////////////////////////////////////////////////////////////////
//                                                                             
// JTOpen (IBM Toolbox for Java - OSS version)                              
//                                                                             
// Filename: PTFGroupList.java
//                                                                             
// The source code contained herein is licensed under the IBM Public License   
// Version 1.0, which has been approved by the Open Source Initiative.         
// Copyright (C) 1997-2003 International Business Machines Corporation and     
// others. All rights reserved.                                                
//                                                                             
///////////////////////////////////////////////////////////////////////////////

package com.ibm.as400.access;

import java.beans.PropertyVetoException;
import java.io.IOException;
import java.util.Calendar;
import java.util.Date;

 
/**
* Retrieves a list of all PTF groups that are known to a system. You can then use PTFGroup to
* get detailed information for a specific PTF group.
**/
public class PTFGroupList
{
  private AS400 system_;  

                                                         
  /**
   * Constructs a PTFGroupList object. 
   * @param system The system.
  **/
  public PTFGroupList(AS400 system)
  {
      if(system == null) throw new NullPointerException("system");
      setSystem(system);
  }

                       
  /**
   * Returns a list of all PTF groups that are known to the system.
   * @return The array of PTFGroups. 
   * @throws AS400Exception If an error occurs.
   * @throws  AS400SecurityException  If a security or authority error occurs.
   * @throws  ErrorCompletingRequestException  If an error occurs before the request is completed.
   * @throws  InterruptedException  If this thread is interrupted.
   * @throws  IOException  If an error occurs while communicating with the system.
   * @throws ObjectDoesNotExistException  If the object does not exist.
  **/
  public PTFGroup[] getPTFGroup()
  throws AS400Exception,
         AS400SecurityException,
         ErrorCompletingRequestException,
         InterruptedException,
         IOException,
         ObjectDoesNotExistException
  {
    try
    {
      int ccsid = system_.getCcsid();
      ConvTable conv = ConvTable.getTable(ccsid, null);

      ProgramParameter[] parms = new ProgramParameter[4];
      parms[0] = new ProgramParameter(conv.stringToByteArray(PTFGroup.USERSPACE_NAME));        //qualified user space name
      parms[0].setParameterType(ProgramParameter.PASS_BY_REFERENCE);
      parms[1] = new ProgramParameter(conv.stringToByteArray("LSTG0100"));        //Format name
      parms[1].setParameterType(ProgramParameter.PASS_BY_REFERENCE);
      parms[2] = new ProgramParameter(BinaryConverter.intToByteArray(ccsid));     //CCSID
      parms[2].setParameterType(ProgramParameter.PASS_BY_REFERENCE);
      parms[3] = new ProgramParameter(new byte[4]);                               // error code
      parms[3].setParameterType(ProgramParameter.PASS_BY_REFERENCE);

      ServiceProgramCall pc = new ServiceProgramCall(system_, "/QSYS.LIB/QPZGROUP.SRVPGM", "QpzListPtfGroups", ServiceProgramCall.NO_RETURN_VALUE, parms);
      // Note: The called API is not thread-safe.

      // Determine the needed scope of synchronization.
      Object lockObject;
      boolean willRunProgramsOnThread = pc.isStayOnThread();
      if (willRunProgramsOnThread) {
        // The calls will run in the job of the JVM, so lock for entire JVM.
        lockObject = PTFGroup.USERSPACE_NAME;
      }
      else {
        // The calls will run in the job of the Remote Command Host Server, so lock on the connection.
        lockObject = system_;
      }

      byte[] buf = null;
      synchronized(lockObject)        
      {
        UserSpace us = new UserSpace(system_, PTFGroup.USERSPACE_PATH);
        us.setMustUseProgramCall(true);
        if (!willRunProgramsOnThread)
        {
          us.setMustUseSockets(true);
          // Force the use of sockets when running natively but not on-thread.
          // We have to do it this way since UserSpace will otherwise make a native ProgramCall, and will use a different QTEMP library than that used by the host server.
        }
        try
        {
          us.create(256*1024, true, "", (byte)0, "User space for PTF Group list", "*EXCLUDE");
          if (!pc.run())
          {
            throw new AS400Exception(pc.getMessageList());
          }
          int size = us.getLength();
          buf = new byte[size];
          us.read(buf, 0);
        }
        finally
        {
          // Delete the temporary user space, to allow other threads to re-create and use it.
          try { us.delete(); }
          catch (Exception e) {
            Trace.log(Trace.ERROR, "Exception while deleting temporary user space", e);
          }
        }
      }
      int startingOffset = BinaryConverter.byteArrayToInt(buf, 124);      
      int numEntries = BinaryConverter.byteArrayToInt(buf, 132);
      int entrySize = BinaryConverter.byteArrayToInt(buf, 136);
      int entryCCSID = BinaryConverter.byteArrayToInt(buf, 140);
      conv = ConvTable.getTable(entryCCSID, null);
      int offset = 0;
      PTFGroup[] ptfs = new PTFGroup[numEntries];
      for (int i=0; i