com.ibm.are.platform
Interface ProductInfo

All Known Implementing Classes:
IBMiProductInfo

public interface ProductInfo

The ProductInfo interface defines an abstract set of information about the ARE product installed on the OS where ARE is running.

Version:
1.0
Author:
IBM

Field Summary
static java.lang.String COPYRIGHT
          Copyright for class bytecode
 
Method Summary
 boolean checkProductRequirements(java.util.logging.Logger logger)
          During ARE startup, this method is called to verify that all product requirements needed by ARE or the template being used are met.
 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 product name for the OS where ARE is installed and running
 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
 

Field Detail

COPYRIGHT

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

See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
Retrieves the ARE product name for the OS where ARE is installed and running

Returns:
The ARE product name for the OS where ARE is installed and running

getJarDirectory

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

Returns:
The location in the file system where the ARE product jar files are.

getScriptDirectory

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

Returns:
The location in the file system where the ARE product scripts are.

isProductJar

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

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

boolean checkProductRequirements(java.util.logging.Logger logger)
During ARE startup, this method is called to verify that all product requirements needed by ARE or the template being used are met.

Parameters:
logger - A logger to use for logging any problems or details
Returns:
true if all requirements are met, false if they are not