com.ibm.as400.access.ProductList Maven / Gradle / Ivy
///////////////////////////////////////////////////////////////////////////////
//
// JTOpen (IBM Toolbox for Java - OSS version)
//
// Filename: ProductList.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-2001 International Business Machines Corporation and
// others. All rights reserved.
//
///////////////////////////////////////////////////////////////////////////////
package com.ibm.as400.access;
import java.io.IOException;
/**
* Represents a list of licensed products.
* @see com.ibm.as400.access.Product
**/
public class ProductList
{
private static final String copyright = "Copyright (C) 1997-2001 International Business Machines Corporation and others.";
private AS400 system_;
private String[] productIDs_ = new String[1];
private String[] productOptions_ = new String[1];
private String[] releaseLevels_ = new String[1];
private int currentProduct_ = 0;
private String filter_ = PRODUCT_FILTER_ALL;
private String option_ = PRODUCT_OPTION_ALL;
// Retrieve 1000 products at a time since we don't
// know how many are actually installed on the system
// until we make the first API call.
private int chunkSize_ = 1000;
/**
* Constant representing a list of all products.
**/
public static final String PRODUCT_FILTER_ALL = "*ALL";
/**
* Constant representing a list of all installed products.
**/
public static final String PRODUCT_FILTER_INSTALLED = "*INSTLD";
/**
* Constant representing a list of all installed products and all supported products.
**/
public static final String PRODUCT_FILTER_INSTALLED_OR_SUPPORTED = "*INSSPT";
/**
* Constant representing a list filtered by user-specified criteria.
**/
public static final String PRODUCT_FILTER_LIST = "*LIST";
/**
* Constant representing a list of all supported products.
**/
public static final String PRODUCT_FILTER_SUPPORTED = "*SUPPTD";
/**
* Constant representing a list of all product options.
**/
public static final String PRODUCT_OPTION_ALL = "*ALL";
/**
* Constant representing a list of all product options when specifying a list filter.
* This constant is only used when PRODUCT_FILTER_LIST is specified for the product filter.
**/
public static final String PRODUCT_OPTION_FILTER_LIST_ALL = " ";
/**
* Constant representing the base product option.
**/
public static final String PRODUCT_OPTION_BASE = "*BASE";
/**
* Constructs a ProductList. The system must be set before
* calling {@link #getProducts getProducts()}.
**/
public ProductList()
{
}
/**
* Constructs a ProductList for the specified system. The default product filter is PRODUCT_FILTER_ALL.
* The default product option is PRODUCT_OPTION_ALL.
* @param system The system from which to retrieve the list of products.
**/
public ProductList(AS400 system)
{
if (system == null) throw new NullPointerException("system");
system_ = system;
}
/**
* Adds a product to the list of products to retrieve when the product
* filter is set to PRODUCT_FILTER_LIST. If the product filter is not set to
* PRODUCT_FILTER_LIST, then the products added via this method are ignored when
* the list of products is retrieved from the system.
* @param productID The product ID, for example: "5722SS1" or "5769JC1". The length must be 7 characters.
* @param productOption The product option. Valid values are:
*
* - Any valid product option, e.g. "30".
*
- {@link #PRODUCT_OPTION_BASE PRODUCT_OPTION_BASE}
*
- {@link #PRODUCT_OPTION_FILTER_LIST_ALL PRODUCT_OPTION_FILTER_LIST_ALL}
*
* @param releaseLevel The product release level, for example "V5R1M0" or "V4R5M0". The length must be 6 characters.
* @see #clearProductsToRetrieve
**/
public void addProductToRetrieve(String productID, String productOption, String releaseLevel)
{
if (productID == null) throw new NullPointerException("productID");
if (productOption == null) throw new NullPointerException("productOption");
if (releaseLevel == null) throw new NullPointerException("releaseLevel");
String id = productID.toUpperCase().trim();
if (id.length() != 7)
{
throw new ExtendedIllegalArgumentException("productID", ExtendedIllegalArgumentException.LENGTH_NOT_VALID);
}
String option = productOption.toUpperCase();
if (!option.equals(PRODUCT_OPTION_FILTER_LIST_ALL))
{
option = option.trim();
if (option.equals(PRODUCT_OPTION_ALL))
{
// *ALL is not a valid parameter.
throw new ExtendedIllegalArgumentException("productOption", ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
}
if (!option.equals(PRODUCT_OPTION_BASE))
{
while (option.length() < 5)
{
option = "0"+option;
}
}
}
if (option.length() > 5)
{
throw new ExtendedIllegalArgumentException("productOption", ExtendedIllegalArgumentException.LENGTH_NOT_VALID);
}
String level = releaseLevel.toUpperCase().trim();
if (level.length() != 6)
{
throw new ExtendedIllegalArgumentException("releaseLevel", ExtendedIllegalArgumentException.LENGTH_NOT_VALID);
}
if (currentProduct_ >= productIDs_.length)
{
String[] temp = productIDs_;
int len = temp.length;
int len2 = temp.length*2;
productIDs_ = new String[len2];
System.arraycopy(temp, 0, productIDs_, 0, len);
temp = productOptions_;
productOptions_ = new String[len2];
System.arraycopy(temp, 0, productOptions_, 0, len);
temp = releaseLevels_;
releaseLevels_ = new String[len2];
System.arraycopy(temp, 0, releaseLevels_, 0, len);
}
productIDs_[currentProduct_] = id;
productOptions_[currentProduct_] = option;
releaseLevels_[currentProduct_++] = level;
}
/**
* Clears the list of products to retrieve and sets the product filter
* to {@link #PRODUCT_FILTER_ALL PRODUCT_FILTER_ALL}.
* @see #addProductToRetrieve
**/
public void clearProductsToRetrieve()
{
productIDs_ = new String[1];
productOptions_ = new String[1];
releaseLevels_ = new String[1];
currentProduct_ = 0;
filter_ = PRODUCT_FILTER_ALL;
}
/**
* Retrieves the list of products from the system.
* Use {@link #setProductFilter setProductFilter()} and
* {@link #setProductOption setProductOption()} to change the types of
* products that are returned.
* Use {@link #addProductToRetrieve addProductToRetrieve()} to add a
* specific product to retrieve and specify {@link #PRODUCT_FILTER_LIST PRODUCT_FILTER_LIST}
* for the product filter.
* @return The array of Product objects.
* @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 Product[] getProducts()
throws AS400Exception,
AS400SecurityException,
ErrorCompletingRequestException,
InterruptedException,
IOException,
ObjectDoesNotExistException
{
if (filter_.equals(PRODUCT_FILTER_LIST) && currentProduct_ == 0)
{
if (Trace.traceOn_)
{
Trace.log(Trace.ERROR, "ProductList filter is set to PRODUCT_FILTER_LIST but no products have been added.");
}
throw new ExtendedIllegalArgumentException("filter", ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
}
int ccsid = system_.getCcsid();
final ConvTable conv = ConvTable.getTable(ccsid, null);
final ProgramParameter[] parms = new ProgramParameter[6];
parms[0] = new ProgramParameter(197*chunkSize_); // output list
final byte[] inputInformation = new byte[40];
BinaryConverter.intToByteArray(chunkSize_, inputInformation, 0); // number of records to return
AS400Text text10 = new AS400Text(10, ccsid, system_);
text10.toBytes("*ALL", inputInformation, 4); // number of products to select
inputInformation[14] = (byte)0xF1; // '1' but it doesn't matter
inputInformation[15] = (byte)0xF1; // '1' but it doesn't matter
text10.toBytes(option_, inputInformation, 16); // product options to display
text10.toBytes(filter_, inputInformation, 26); // product
if (currentProduct_ > 0 && filter_.equals(PRODUCT_FILTER_LIST))
{
BinaryConverter.intToByteArray(currentProduct_, inputInformation, 36); // records in list
}
// records in list is 0 since we are not using *LIST for the product
parms[1] = new ProgramParameter(inputInformation); // input information
parms[2] = new ProgramParameter(conv.stringToByteArray("PRDS0200")); // format name
byte[] inputList = null;
if (currentProduct_ > 0 && filter_.equals(PRODUCT_FILTER_LIST))
{
inputList = new byte[18*currentProduct_];
AS400Text text5 = new AS400Text(5, ccsid, system_);
AS400Text text6 = new AS400Text(6, ccsid, system_);
AS400Text text7 = new AS400Text(7, ccsid, system_);
int offset = 0;
for (int i=0; i chunkSize_)
{
// Need to retrieve more.
if (Trace.traceOn_)
{
Trace.log(Trace.DIAGNOSTIC, "Increasing ProductList chunk size from "+chunkSize_+" to "+numRecords+" and re-retrieving.");
}
chunkSize_ = numRecords;
return getProducts();
}
byte[] outputList = parms[0].getOutputData();
int offset = 0;
Product[] products = new Product[numRecords];
for (int i=0; i
* {@link #PRODUCT_FILTER_INSTALLED PRODUCT_FILTER_INSTALLED}
* {@link #PRODUCT_FILTER_SUPPORTED PRODUCT_FILTER_SUPPORTED}
* {@link #PRODUCT_FILTER_INSTALLED_OR_SUPPORTED PRODUCT_FILTER_INSTALLED_OR_SUPPORTED}
* {@link #PRODUCT_FILTER_ALL PRODUCT_FILTER_ALL}
* {@link #PRODUCT_FILTER_LIST PRODUCT_FILTER_LIST}
*
* @param filter The product filter.
**/
public void setProductFilter(String filter)
{
if (filter == null) throw new NullPointerException("filter");
if (!filter.equals(PRODUCT_FILTER_INSTALLED) &&
!filter.equals(PRODUCT_FILTER_SUPPORTED) &&
!filter.equals(PRODUCT_FILTER_INSTALLED_OR_SUPPORTED) &&
!filter.equals(PRODUCT_FILTER_ALL) &&
!filter.equals(PRODUCT_FILTER_LIST))
{
throw new ExtendedIllegalArgumentException("filter", ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
}
filter_ = filter;
}
/**
* Sets the product option used to filter the list.
* Valid values are:
*
* - {@link #PRODUCT_OPTION_ALL PRODUCT_OPTION_ALL}
*
- {@link #PRODUCT_OPTION_BASE PRODUCT_OPTION_BASE}
*
* @param option The product option.
**/
public void setProductOption(String option)
{
if (option == null) throw new NullPointerException("option");
if (!option.equals(PRODUCT_OPTION_ALL) && !option.equals(PRODUCT_OPTION_BASE))
{
throw new ExtendedIllegalArgumentException("option", ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
}
option_ = option;
}
/**
* Sets the system.
* @param system The system.
**/
public void setSystem(AS400 system)
{
if (system == null) throw new NullPointerException("system");
system_ = system;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy