psdi.iface.router

Class SSHHandler

java.lang.Object

psdi.iface.router.BaseRouterHandler

psdi.iface.router.SSHHandler

All Implemented Interfaces:

CommandLineConstants, RouterHandler

public class SSHHandler
extends BaseRouterHandler
implements CommandLineConstants

SSHHandler supports to connect to remote system using SSH and allows to execute service request commands, and captures the response back.

Field Summary

Fields

Modifier and Type	Field and Description
static MXLogger	INTEGRATIONLOGGER Integration logger for logging messages related to MAXIMO startup.
com.ibm.tivoli.remoteaccess.SSHProtocol	sshConnectionObj Remote connection object

Fields inherited from class psdi.iface.router.BaseRouterHandler

endPointPropVals, epName, metaData

Fields inherited from interface psdi.iface.app.common.CommandLineConstants

CL_CMD_ARG, CL_CMD_PATTERN, CL_ENV_SETUP_CMD, CL_WORKING_DIR, CLRESPONSEERR, CLRESPONSEOUT, CLRETURNCODE, CMDTIMEOUT, CONNTIMEOUT, HOST, IGNORE_SETUP_ERR, MAX_RETRY, PORTNO, RETRY_INTERVAL, SSHEXIT

Fields inherited from interface psdi.iface.router.RouterHandler

BIDICONFIG, PASSWORD, USERNAME

Constructor Summary

Constructors

Constructor and Description
SSHHandler()
SSHHandler(MaxEndPointInfo endPointInfo)

Method Summary

Modifier and Type	Method and Description
int	getCmdTimeOut()
int	getConnTimeOut()
java.lang.String	getHost()
boolean	getIgnoreSetupErr()
int	getMaxRetry()
int	getPort()
java.util.List	getProperties()
int	getRetryInterval()
java.lang.String	getSshExitName()
java.lang.String	getUserId()
byte[]	invoke(java.util.Map metaData, byte[] data) All directly extending classes should call super.invoke(metaData, data) before proceeding with the invoke.

Methods inherited from class psdi.iface.router.BaseRouterHandler

getBooleanPropertyValue, getBooleanPropertyValue, getDatePropertyValue, getDoublePropertyValue, getIntPropertyValue, getLongPropertyValue, getOverrideValue, getPropertyValue, isOverridden, isPropertyOverridable

Methods inherited from class java.lang.Object

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

Field Detail

INTEGRATIONLOGGER

public static final MXLogger INTEGRATIONLOGGER

Integration logger for logging messages related to MAXIMO startup.

sshConnectionObj

public com.ibm.tivoli.remoteaccess.SSHProtocol sshConnectionObj

Remote connection object

Constructor Detail

SSHHandler

public SSHHandler()

SSHHandler

public SSHHandler(MaxEndPointInfo endPointInfo)

Parameters:

endPointInfo -

Method Detail

getProperties

public java.util.List getProperties()

Specified by:

getProperties in interface RouterHandler

Returns:

the List of supported properties.

getUserId

public java.lang.String getUserId()

Returns:

the userid.

getHost

public java.lang.String getHost()

Returns:

the hostname.

getPort

public int getPort()

Returns:

the port number.

getRetryInterval

public int getRetryInterval()

Returns:

connection retry interval.

getMaxRetry

public int getMaxRetry()

Returns:

connection maximum retry times.

getIgnoreSetupErr

public boolean getIgnoreSetupErr()

Returns:

the setup error ignore flag.

getSshExitName

public java.lang.String getSshExitName()

Returns:

the exit class name.

getConnTimeOut

public int getConnTimeOut()

Returns:

the max. amount of time to establish connection.

getCmdTimeOut

public int getCmdTimeOut()

Returns:

the max. amount of time to execute cmd.

invoke

public byte[] invoke(java.util.Map metaData,
                     byte[] data)
              throws MXException

Description copied from class: BaseRouterHandler

All directly extending classes should call super.invoke(metaData, data) before proceeding with the invoke.

Specified by:

invoke in interface RouterHandler

Overrides:

invoke in class BaseRouterHandler

Returns:

the Bidi transformed data to be collected and used by the descendant classes

Throws:

MXException

See Also:

RouterHandler.invoke(java.util.Map, byte[])