com.ibm.di.fc
Class zOSTSOCommandLine

java.lang.Object
  com.ibm.di.fc.Function
      com.ibm.di.fc.zOSTSOCommandLine

All Implemented Interfaces:

FunctionInterface, VersionInfoInterface

public class zOSTSOCommandLine
extends Function

Field Summary

static String	ENTRY_ATTR_APPC_RETCODE
static String	ENTRY_ATTR_CMD
static String	ENTRY_ATTR_COMMAND_OUTPUT
static String	ENTRY_ATTR_TSO_CMD_RETCODE
static boolean	isLibLoaded
static String	LIB_NAME
int	mATBOK
static String	MSG_NO_RESPONSE
static int[]	PARAMS_LEN
static String	PARM_DEST_LU_NAME
static int	PARM_DEST_LU_NAME_ID
static String	PARM_MODE_NAME
static int	PARM_MODE_NAME_ID
static String	PARM_PARTNERTP
static int	PARM_PARTNERTP_ID
static String	PARM_SRC_LU_NAME
static int	PARM_SRC_LU_NAME_ID
static String	PARM_USER_ID
static int	PARM_USER_ID_ID
static String	PARM_USER_PSW
static int	PARM_USER_PSW_ID

Fields inherited from class com.ibm.di.fc.Function

logger

Constructor Summary

zOSTSOCommandLine()

Method Summary

void	debug(String msg) Writes a message to the log if debug/detailed logging is turned on
protected String	executeTSO(String aTsoCmd) Executes the TSO command passed as parameter.
String	getVersion()
void	initAndPrepareForConversation()
void	initialize(Object aParam) This method is/should be called once after the object has been given its configuration
static void	loadLibrary()
void	logmsg(String msg) Logs the msg string value to the currently used log
Object	perform(Object aInObject) This is the main method of a Function Component.
protected void	readZOSParam(String aParamName, int aParamId, boolean aRequired, boolean aToLog, boolean aToUpperCase)
void	terminate() This method is/should be called once before the object is released

Methods inherited from class com.ibm.di.fc.Function

getConfiguration, getContext, getLog, getParam, getUI, initialize, setConfiguration, setContext, setLog, setParam, updateSchema, verifyInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LIB_NAME

public static final String LIB_NAME

See Also:

Constant Field Values

PARM_PARTNERTP

public static final String PARM_PARTNERTP

See Also:

Constant Field Values

PARM_DEST_LU_NAME

public static final String PARM_DEST_LU_NAME

See Also:

Constant Field Values

PARM_SRC_LU_NAME

public static final String PARM_SRC_LU_NAME

See Also:

Constant Field Values

PARM_MODE_NAME

public static final String PARM_MODE_NAME

See Also:

Constant Field Values

PARM_USER_ID

public static final String PARM_USER_ID

See Also:

Constant Field Values

PARM_USER_PSW

public static final String PARM_USER_PSW

See Also:

Constant Field Values

PARM_PARTNERTP_ID

public static final int PARM_PARTNERTP_ID

See Also:

Constant Field Values

PARM_DEST_LU_NAME_ID

public static final int PARM_DEST_LU_NAME_ID

See Also:

Constant Field Values

PARM_SRC_LU_NAME_ID

public static final int PARM_SRC_LU_NAME_ID

See Also:

Constant Field Values

PARM_MODE_NAME_ID

public static final int PARM_MODE_NAME_ID

See Also:

Constant Field Values

PARM_USER_ID_ID

public static final int PARM_USER_ID_ID

See Also:

Constant Field Values

PARM_USER_PSW_ID

public static final int PARM_USER_PSW_ID

See Also:

Constant Field Values

PARAMS_LEN

public static final int[] PARAMS_LEN

ENTRY_ATTR_CMD

public static final String ENTRY_ATTR_CMD

See Also:

Constant Field Values

ENTRY_ATTR_COMMAND_OUTPUT

public static final String ENTRY_ATTR_COMMAND_OUTPUT

See Also:

Constant Field Values

ENTRY_ATTR_APPC_RETCODE

public static final String ENTRY_ATTR_APPC_RETCODE

See Also:

Constant Field Values

ENTRY_ATTR_TSO_CMD_RETCODE

public static final String ENTRY_ATTR_TSO_CMD_RETCODE

See Also:

Constant Field Values

MSG_NO_RESPONSE

public static final String MSG_NO_RESPONSE

See Also:

Constant Field Values

isLibLoaded

public static boolean isLibLoaded

mATBOK

public int mATBOK

Constructor Detail

zOSTSOCommandLine

public zOSTSOCommandLine()

Method Detail

initialize

public void initialize(Object aParam)
                throws Exception

Description copied from class: Function

This method is/should be called once after the object has been given its configuration

Specified by:

initialize in interface FunctionInterface

Overrides:

initialize in class Function

Parameters:

aParam - this object provides information to the Function Component needed on initialization

Throws:

Exception - An exception is thrown if the initialization fails.

readZOSParam

protected void readZOSParam(String aParamName,
                            int aParamId,
                            boolean aRequired,
                            boolean aToLog,
                            boolean aToUpperCase)
                     throws Exception

Throws:

Exception

initAndPrepareForConversation

public void initAndPrepareForConversation()
                                   throws Exception

Throws:

Exception

loadLibrary

public static void loadLibrary()

perform

public Object perform(Object aInObject)
               throws Exception

Description copied from interface: FunctionInterface

This is the main method of a Function Component. This method is called for the Function Component to actually do its job. The implementation of this methods performs the function which the Function Component was created to do.

Parameters:

aInObject - the input to the function

Returns:

the output from the function

Throws:

Exception - An exception is thrown if this method fails.

executeTSO

protected String executeTSO(String aTsoCmd)
                     throws Exception

Executes the TSO command passed as parameter.

Parameters:

aTsoCmd - The TSO command to be executed.

Returns:

The result of the z/OS TSO command.

Throws:

Exception

terminate

public void terminate()
               throws Exception

Description copied from class: Function

This method is/should be called once before the object is released

Specified by:

terminate in interface FunctionInterface

Overrides:

terminate in class Function

Throws:

Exception - An exception is thrown if this method fails.

logmsg

public void logmsg(String msg)

Description copied from class: Function

Logs the msg string value to the currently used log

Specified by:

logmsg in interface FunctionInterface

Overrides:

logmsg in class Function

Parameters:

msg - The message appearing in the log

debug

public void debug(String msg)

Description copied from class: Function

Writes a message to the log if debug/detailed logging is turned on

Specified by:

debug in interface FunctionInterface

Overrides:

debug in class Function

Parameters:

msg - The message

getVersion

public String getVersion()