A B C D E F G I O P R S T U

A

ApiWrapper - class org.dbtutools.DbtuTools.core.ApiWrapper.

Wrapper class, covers the dbtuapiwrapper binary related stuff.

B

bBetweenCheckEnabled - Variable in class org.edelbyte.util.UnixCfgParser

Field holding the activation status of the Between Check mechanism (default is false).

BindFile - class org.dbtutools.DbtuTools.core.db2.BindFile.

Wrapper class, implementing DB2 bindfile related stuff.

C

COMMENT_TOKEN - Static variable in class org.edelbyte.util.UnixCfgParser

Constant holding the token used for the comment detection within the stream.

CONFIG_SOURCE_UNIXCFG - Static variable in class org.dbtutools.DbtuTools.core.ConfigService

Constant standing for a Unix Configuration files as Config Source.

CONFIG_SOURCE_UNKNOWN - Static variable in class org.dbtutools.DbtuTools.core.ConfigService

Constant standing for an unknown Config Source.

ConfigService - class org.dbtutools.DbtuTools.core.ConfigService.

One of the central services offered to all the DbtuTools tools (of course, others can use them as well).

The class works as a wrapper, covering the configuration stuff and hiding the different Config Sources and their types.

ConfigService() - Constructor for class org.dbtutools.DbtuTools.core.ConfigService

Creates a new instance of this class which addresses the current DB2 Instance, but no DB2 database(s).

ConfigService(String) - Constructor for class org.dbtutools.DbtuTools.core.ConfigService

Creates a new instance of this class which addresses the given DB2 Instance, but no DB2 database(s).

ConfigService(String, String) - Constructor for class org.dbtutools.DbtuTools.core.ConfigService

Creates a new instance of this class which addresses the given DB2 Instance, as well as the given DB2 database.

ConfigService(String, String[]) - Constructor for class org.dbtutools.DbtuTools.core.ConfigService

Creates a new instance of this class which addresses the given DB2 Instance, as well as the given DB2 database(s).

CONTINUATION_TOKEN - Static variable in class org.edelbyte.util.UnixCfgParser

Constant holding the token used for the line continuation detection within the stream.

createTempFile() - Static method in class org.dbtutools.DbtuTools.core.os.TempFile

Creates a File class instance, pointing to a newly created (empty) temporary file, which is located in the /opt/dbtutools tree.

Remark: The name of the temporary file is based on the following format: t<yyyymmddhhmmss>p<nnnn>n<n>.tmp The first token contains time and date; the next token represents the parent process id.

D

DiagLog - class org.dbtutools.DbtuTools.core.db2.DiagLog.

Wrapper class, implementing db2diag.log file related stuff.

E

ENDIAN_TYPE_BIG - Static variable in class org.dbtutools.DbtuTools.core.ApiWrapper

Constant standing for all big endian platforms as most RISC machines are.

ENDIAN_TYPE_BIG - Static variable in class org.dbtutools.DbtuTools.core.os.System

Constant standing for all big endian platforms as most RISC machines are.

ENDIAN_TYPE_LITTLE - Static variable in class org.dbtutools.DbtuTools.core.ApiWrapper

Constant standing for all little endian platforms as systems with Intel x86 processor(s) are.

ENDIAN_TYPE_LITTLE - Static variable in class org.dbtutools.DbtuTools.core.os.System

Constant standing for all little endian platforms as systems with Intel x86 processor(s) are.

EQUALS_TOKEN - Static variable in class org.edelbyte.util.UnixCfgParser

Constant holding the token used for the key and value pair separation within the stream.

F

FFFF_TOKEN - Static variable in class org.dbtutools.DbtuTools.core.db2.DiagLog

Constant holding a special token for the hexadecimal code, found within the db2diag.log file.

G

getBetweenBeginToken() - Method in class org.edelbyte.util.UnixCfgParser

Returns the token, which indicates the beginning of the key and value pairs part (from the UnixCfgParser.oBetweenBeginToken field).

getBetweenEndToken() - Method in class org.edelbyte.util.UnixCfgParser

Returns the token, which indicates the end of the key and value pairs part (from the UnixCfgParser.oBetweenEndToken field).

getConfigSourceSettings() - Method in class org.dbtutools.DbtuTools.core.ConfigService

This method determines how to find and read the Config Sources.

getEndianType() - Static method in class org.dbtutools.DbtuTools.core.ApiWrapper

Detects and returns the endian type of the current running platform.

getEndianType() - Static method in class org.dbtutools.DbtuTools.core.os.System

Detects and returns the endian type of the current running platform.

Background: The detection is done by calling the ApiWrapper.getEndianType() method.

getInstance() - Static method in class org.dbtutools.DbtuTools.core.OptDbtuToolsTree

Creates and returns an instance of this class which addresses the /opt/dbtutools tree for the current DB2 Instance.

getInstance() - Static method in class org.dbtutools.DbtuTools.core.db2.Instance

Creates and returns an instance of this class which addresses the current DB2 Instance.

getInstanceName() - Method in class org.dbtutools.DbtuTools.core.db2.Instance

Returns the DB2 Instance name (from the Instance.oInstanceName field).

getOsFamily() - Static method in class org.dbtutools.DbtuTools.core.os.System

Detects and returns the operating system family.

Background: The detection is done by calling the System.getOsFamily() method.

getOsFamily() - Static method in class org.edelbyte.util.System

Detects and returns the operating system family.

Background: The detection is done by interpreting the value of java.lang.System.getProperty("os.name");

getParentProcessId() - Static method in class org.dbtutools.DbtuTools.core.os.System

Detects and returns the Parent Process ID (identifies the caller of the Java program).

Background: The detection is done by interpreting the value of java.lang.System.getProperty("PPID");

getPathNames() - Method in class org.dbtutools.DbtuTools.core.OptDbtuToolsTree

Returns the /opt/dbtutools tree path names (based on the OptDbtuToolsTree.oTreeRoot field).

getProperty(String, String, String) - Method in class org.dbtutools.DbtuTools.core.ConfigService

Searches the different properties fields for the specified property key.

getProperty(String, String, String, String) - Method in class org.dbtutools.DbtuTools.core.ConfigService

Searches the different properties fields for the specified property key.

I

iConfigSourceType - Variable in class org.dbtutools.DbtuTools.core.ConfigService

Field holding the Config Source type.

Instance - class org.dbtutools.DbtuTools.core.db2.Instance.

Wrapper class, implementing DB2 Instance related stuff.

Instance() - Constructor for class org.dbtutools.DbtuTools.core.db2.Instance

Creates a new instance of this class and addressed the current DB2 Instance.

Background: This constructor calls a private method which interprets the value returned by java.lang.System.getProperty("DB2INSTANCE");

Instance(String) - Constructor for class org.dbtutools.DbtuTools.core.db2.Instance

Creates a new instance of this class - addressing the provided DB2 Instance name.

Remark: Please notice, the constructor does not check for the existence of the given DB2 instance!

isBetweenCheckEnabled() - Method in class org.edelbyte.util.UnixCfgParser

Returns true for the case, that the Between Check mechanism is active.

The Between Check mechanism ensures, that there are key and value pairs between the so called BetweenBegin and BetweenEnd tokens (see UnixCfgParser.getBetweenBeginToken() and UnixCfgParser.getBetweenEndToken()) only.

O

oBetweenBeginToken - Variable in class org.edelbyte.util.UnixCfgParser

Field holding the token, which indicates the beginning of the key and value pairs part of the stream.

oBetweenEndToken - Variable in class org.edelbyte.util.UnixCfgParser

Field holding the token, which indicates the end of the key and value pairs part of the stream.

oDatabaseNames - Variable in class org.dbtutools.DbtuTools.core.ConfigService

Field holding the given DB2 Database name(s).

oDatabaseProperties - Variable in class org.dbtutools.DbtuTools.core.ConfigService

Field holding the Database level properties read from the Config Source.

oDb2Instance - Variable in class org.dbtutools.DbtuTools.core.OptDbtuToolsTree

Field holding the given DB2 Instance name.

oInstanceName - Variable in class org.dbtutools.DbtuTools.core.ConfigService

Field holding the given DB2 Instance name.

oInstanceName - Variable in class org.dbtutools.DbtuTools.core.db2.Instance

Field holding the name of the DB2 instance, which is addressed by the instance of this class.

oInstanceProperties - Variable in class org.dbtutools.DbtuTools.core.ConfigService

Field holding the Instance level properties read from the Config Source.

oOptTreeInstanceCfg - Variable in class org.dbtutools.DbtuTools.core.ConfigService

Field holding the path for the DB2 Instance configuration files within the /opt/dbtutools tree.

oOptTreeRoot - Variable in class org.dbtutools.DbtuTools.core.ConfigService

Field holding the machine wide /opt/dbtutools tree root.

OptDbtuToolsTree - class org.dbtutools.DbtuTools.core.OptDbtuToolsTree.

Wrapper class, implementing the /opt/dbtutools tree related stuff.

OptDbtuToolsTree() - Constructor for class org.dbtutools.DbtuTools.core.OptDbtuToolsTree

Creates a new instance of this class and addresses the /opt/dbtutools tree for the current DB2 Instance.

OptDbtuToolsTree(Instance) - Constructor for class org.dbtutools.DbtuTools.core.OptDbtuToolsTree

Creates a new instance of this class and addresses the /opt/dbtutools tree for the given DB2 Instance.

OptDbtuToolsTree(String) - Constructor for class org.dbtutools.DbtuTools.core.OptDbtuToolsTree

Creates a new instance of this class and addresses the /opt/dbtutools tree for the given DB2 Instance name.

org.dbtutools.DbtuTools.core - package org.dbtutools.DbtuTools.core

Contains the DbtuTools framework related core classes.

org.dbtutools.DbtuTools.core.db2 - package org.dbtutools.DbtuTools.core.db2

Contains the DB2 related core classes.

org.dbtutools.DbtuTools.core.os - package org.dbtutools.DbtuTools.core.os

Contains the Operating System related core classes.

org.edelbyte.util - package org.edelbyte.util

Provides generic classes and services, which are used by other EdelByte.org projects too.

OS_FAMILY_UNIX - Static variable in class org.dbtutools.DbtuTools.core.os.System

Constant standing for the Unix operating systems, like IBM's AIX, Linux, Sun Solaris and others.

OS_FAMILY_UNIX - Static variable in class org.edelbyte.util.System

Constant standing for the Unix operating systems, like IBM's AIX, Linux, Sun Solaris and others.

OS_FAMILY_WINTEL - Static variable in class org.dbtutools.DbtuTools.core.os.System

Constant standing for all DOS succession operating systems, like the Microsoft Windows family and IBM's OS/2.

OS_FAMILY_WINTEL - Static variable in class org.edelbyte.util.System

Constant standing for all DOS succession operating systems, like the Microsoft Windows family and IBM's OS/2.

oTreeRoot - Variable in class org.dbtutools.DbtuTools.core.OptDbtuToolsTree

Field holding the machine wide /opt/dbtutools tree root.

P

parse(BufferedReader) - Method in class org.edelbyte.util.UnixCfgParser

Reads key and value pairs from a java.io.BufferedReader (or one of its subclasses).

The parser reads the stream line wise using the readLine() method of the object given by the oReader parameter.

print(String) - Static method in class org.edelbyte.util.Trace

println(String) - Static method in class org.edelbyte.util.Trace

R

refresh(boolean) - Method in class org.dbtutools.DbtuTools.core.ConfigService

As the name says, the method (re)reads the Config Sources and stores all found properties in the corresponding object fields.

Please notice, that this method covers the Config Source for the DB2 Instance only.

refresh(boolean, String) - Method in class org.dbtutools.DbtuTools.core.ConfigService

As the name says, the method (re)reads the Config Sources and stores all found properties in the corresponding object fields.

refresh(boolean, String[]) - Method in class org.dbtutools.DbtuTools.core.ConfigService

As the name says, the method (re)reads the Config Sources and stores all found properties in the corresponding object fields.

refreshAll() - Method in class org.dbtutools.DbtuTools.core.ConfigService

As the name says, the method (re)reads all Config Sources and stores all found properties in the corresponding object fields.

S

setBetweenBeginToken(String) - Method in class org.edelbyte.util.UnixCfgParser

Set a alternative value for the BetweenBegin token, which is used by the Between Check mechanism.

setBetweenCheckEnabled(boolean) - Method in class org.edelbyte.util.UnixCfgParser

Enables or disables the Between Check mechanism while parsing the stream.

The Between Check mechanism ensures, that there are key and value pairs between the so called BetweenBegin and BetweenEnd tokens (see UnixCfgParser.getBetweenBeginToken() and UnixCfgParser.getBetweenEndToken()) only.

setBetweenEndToken(String) - Method in class org.edelbyte.util.UnixCfgParser

Set a alternative value for the BetweenEnd token, which is used by the Between Check mechanism.

System - class org.dbtutools.DbtuTools.core.os.System.

The System class provides operating system related stuff.

System - class org.edelbyte.util.System.

The System class provides operating system related stuff.

T

TempFile - class org.dbtutools.DbtuTools.core.os.TempFile.

This class should be used to create temporary files within the /opt/dbtutools tree.

toInternalReturnCode(String, String) - Static method in class org.dbtutools.DbtuTools.core.db2.DiagLog

Converts a given hexadecimal code found in the db2diag.log file into an DB2 Internal Return Code.

Remark: Please notice; the hexadecimal code could represent a SQL Message Code as well.

toSqlCode(String, String) - Static method in class org.dbtutools.DbtuTools.core.db2.DiagLog

Converts a given hexadecimal code found in the db2diag.log file into an SQL Message Code.

Remark: Please notice; the hexadecimal code could represent a DB2 Internal Return Code as well.

toTimestamp(String) - Static method in class org.dbtutools.DbtuTools.core.db2.BindFile

Converts a given Consistency Token into a timestamp.

Background: The Consistency Token is a unique identifier, which is used to ensure, the application and bindfile/package are based on the same build.

Trace - class org.edelbyte.util.Trace.

TRACE_TOKEN - Static variable in class org.edelbyte.util.Trace

Trace() - Constructor for class org.edelbyte.util.Trace

U

UnixCfgParser - class org.edelbyte.util.UnixCfgParser.

A basic Unix configuration file parser.

UnixCfgParser() - Constructor for class org.edelbyte.util.UnixCfgParser

Creates a new instance of this class.

UnknownValueException - exception org.edelbyte.util.UnknownValueException.

Checked exception thrown in cases where no useful return code can be provided / returned.

UnknownValueException() - Constructor for class org.edelbyte.util.UnknownValueException

Constructs an UnknownValueException with no detailed message.

UnknownValueException(String) - Constructor for class org.edelbyte.util.UnknownValueException

Constructs an UnknownValueException with the specified detailed message.

A B C D E F G I O P R S T U