Package zowe.client.sdk.zosconsole.method

Class ConsoleGet

java.lang.Object

zowe.client.sdk.zosconsole.method.ConsoleGet

public class ConsoleGet
extends Object

Get synchronous z/OS console response messages from a console issue command request (see ConsoleCmd class).

This class is used to retrieve the console response messages not provided to the console issue command request within a certain time interval of approximately 3 seconds. It is possible that the command responses exist after the time interval and can be retrieved.

Response messages are stored in the response key of the console issue command request.

Version:

5.0

Author:

Frank Giordano

Constructor Summary

Constructors

Constructor	Description
ConsoleGet(ZosConnection connection)	ConsoleGet constructor

Method Summary

Modifier and Type	Method	Description
ConsoleGetResponse	getResponse(String responseKey)	Retrieve synchronous z/OS console response messages from a console issue command request's response value.
ConsoleGetResponse	getResponse(String responseKey, String consoleName)	Retrieve synchronous z/OS console response messages from a console issue command request's response value and console name.
ConsoleGetResponse	getResponseCommon(String responseKey, String consoleName, boolean processResponse)	Common method with all inputs to retrieve any outstanding synchronous z/OS console response messages from a console issue command request.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleGet

public ConsoleGet(ZosConnection connection)

ConsoleGet constructor

Parameters:

connection - for connection information, see ZosConnection object

Method Detail

getResponse

public ConsoleGetResponse getResponse(String responseKey)
                               throws ZosmfRequestException

Retrieve synchronous z/OS console response messages from a console issue command request's response value.

Parameters:

responseKey - response key from the issue console command request

Returns:

ConsoleResponse object

Throws:

ZosmfRequestException - request error state

getResponse

public ConsoleGetResponse getResponse(String responseKey,
                                      String consoleName)
                               throws ZosmfRequestException

Retrieve synchronous z/OS console response messages from a console issue command request's response value and console name.

Parameters:

responseKey - response key from the issue console command request

consoleName - name of the console that is used to issue the command

Returns:

ConsoleResponse object

Throws:

ZosmfRequestException - request error state

getResponseCommon

public ConsoleGetResponse getResponseCommon(String responseKey,
                                            String consoleName,
                                            boolean processResponse)
                                     throws ZosmfRequestException

Common method with all inputs to retrieve any outstanding synchronous z/OS console response messages from a console issue command request.

Parameters:

responseKey - response key from the issue console command request

consoleName - name of the console that is used to issue the command

processResponse - process console command response

Returns:

ConsoleResponse object

Throws:

ZosmfRequestException - request error state