Package zowe.client.sdk.zostso.lifecycle

Class StopTso

java.lang.Object

zowe.client.sdk.zostso.lifecycle.StopTso

public class StopTso
extends Object

Stop active TSO address space using servlet key

Version:

2.0

Author:

Frank Giordano

Constructor Summary

Constructors

Constructor	Description
StopTso(ZosConnection connection)	StopTso constructor
StopTso(ZosConnection connection, ZosmfRequest request)	Alternative StopTso constructor with ZoweRequest object.

Method Summary

Modifier and Type	Method	Description
StartStopResponse	stop(String servletKey)	Stop TSO address space and populates response with StartStopResponse, @see StartStopResponse
ZosmfTsoResponse	stopCommon(StopTsoParams commandParams)	Sends REST call to z/OSMF for stopping active TSO address space

Methods inherited from class java.lang.Object

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

Constructor Detail

StopTso

public StopTso(ZosConnection connection)

StopTso constructor

Parameters:

connection - connection information, see ZosConnection object

StopTso

public StopTso(ZosConnection connection,
               ZosmfRequest request)

Alternative StopTso constructor with ZoweRequest object. This is mainly used for internal code unit testing with mockito, and it is not recommended to be used by the larger community.

Parameters:

connection - connection information, see ZosConnection object

request - any compatible ZoweRequest Interface object

Method Detail

stop

public StartStopResponse stop(String servletKey)
                       throws ZosmfRequestException

Stop TSO address space and populates response with StartStopResponse, @see StartStopResponse

Parameters:

servletKey - unique servlet entry identifier

Returns:

start stop response, see StartStopResponse object

Throws:

ZosmfRequestException - request error state

stopCommon

public ZosmfTsoResponse stopCommon(StopTsoParams commandParams)
                            throws ZosmfRequestException

Sends REST call to z/OSMF for stopping active TSO address space

Parameters:

commandParams - command parameters, see commandParams object

Returns:

z/OSMF response object, see ZosmfTsoResponse object

Throws:

ZosmfRequestException - request error state