com.ibm.are.platform.impl
Class IBMiProductInfo

java.lang.Object
  extended by com.ibm.are.platform.impl.IBMiProductInfo
All Implemented Interfaces:
ProductInfo

public class IBMiProductInfo
extends java.lang.Object
implements ProductInfo

The IBMiProductInfo class provides a set of information about the ARE Core installed on the system where ARE is running.

Version:
1.0
Author:
IBM

Field Summary
static java.lang.String COPYRIGHT
          Copyright for class bytecode
static java.lang.String MIN_REQUIRED_TOOLBOX_VERSION
          Default minimum required IBM Toolbox for Java level required to use the base plugin supported shipped with ARE.
static java.lang.String PROP_REQ_TOOLBOX_VERSION
          Property in the template configuration that specifies the minimum required IBM Toolbox for Java level required to verify a system using that template.
 
Constructor Summary
IBMiProductInfo()
           
 
Method Summary
 boolean checkProductRequirements(java.util.logging.Logger logger)
          Checks that the version of the IBM Toolbox for Java installed on the system meets the minimum required Toolbox level for the template that is being used to verify the system.
 java.io.File getJarDirectory()
          Retrieves the location in the file system where the ARE product jar files are.
 java.lang.String getName()
          Retrieves the ARE Core product name on the IBM i system
 java.io.File getScriptDirectory()
          Retrieves the location in the file system where the ARE product scripts are.
 boolean isProductJar(java.io.File jarFileName)
          Determines if the specified file is an ARE product jar file
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright for class bytecode

See Also:
Constant Field Values

PROP_REQ_TOOLBOX_VERSION

public static final java.lang.String PROP_REQ_TOOLBOX_VERSION
Property in the template configuration that specifies the minimum required IBM Toolbox for Java level required to verify a system using that template.

See Also:
Constant Field Values

MIN_REQUIRED_TOOLBOX_VERSION

public static final java.lang.String MIN_REQUIRED_TOOLBOX_VERSION
Default minimum required IBM Toolbox for Java level required to use the base plugin supported shipped with ARE.

See Also:
Constant Field Values
Constructor Detail

IBMiProductInfo

public IBMiProductInfo()
Method Detail

getName

public java.lang.String getName()
Retrieves the ARE Core product name on the IBM i system

Specified by:
getName in interface ProductInfo
Returns:
The ARE Core product name on the IBM i system

getJarDirectory

public java.io.File getJarDirectory()
Retrieves the location in the file system where the ARE product jar files are.

Specified by:
getJarDirectory in interface ProductInfo
Returns:
The location in the file system where the ARE product jar files are.

getScriptDirectory

public java.io.File getScriptDirectory()
Retrieves the location in the file system where the ARE product scripts are.

Specified by:
getScriptDirectory in interface ProductInfo
Returns:
The location in the file system where the ARE product scripts are.

isProductJar

public boolean isProductJar(java.io.File jarFileName)
Determines if the specified file is an ARE product jar file

Specified by:
isProductJar in interface ProductInfo
Parameters:
jarFileName - The jar file to check
Returns:
true if the specified file is an ARE product jar file, false if it is not

checkProductRequirements

public boolean checkProductRequirements(java.util.logging.Logger logger)
Checks that the version of the IBM Toolbox for Java installed on the system meets the minimum required Toolbox level for the template that is being used to verify the system.

Specified by:
checkProductRequirements in interface ProductInfo
Parameters:
logger - A logger to use for logging any problems or details
Returns:
true if the IBM Toolbox for Java version meets the minimum required level, false if it does not