Package zowe.client.sdk.zosconsole.method

Class IssueConsole

java.lang.Object

zowe.client.sdk.zosconsole.method.IssueConsole

public class IssueConsole
extends Object

Issue MVS Console commands by using a system console

Version:

2.0

Author:

Frank Giordano

Constructor Summary

Constructors

Constructor	Description
IssueConsole(ZosConnection connection)	IssueCommand constructor
IssueConsole(ZosConnection connection, ZoweRequest request)	Alternative IssueCommand constructor with ZoweRequest object.

Method Summary

Modifier and Type	Method	Description
ConsoleResponse	issueCommand(String theCommand)	Issue console command method.
ConsoleResponse	issueCommand(IssueParams params)	Issue an MVS console command done synchronously - meaning solicited (direct command responses) are gathered immediately after the command is issued.
ZosmfIssueResponse	issueCommonCommand(String consoleName, ZosmfIssueParams commandParams)	Issue an MVS console command, returns "raw" z/OSMF response
ZosmfIssueResponse	issueDefConsoleCommon(ZosmfIssueParams commandParams)	Issue an MVS console command in default console, returns "raw" z/OSMF response

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueConsole

public IssueConsole(ZosConnection connection)

IssueCommand constructor

Parameters:

connection - connection information, see ZOSConnection object

IssueConsole

public IssueConsole(ZosConnection connection,
                    ZoweRequest request)
             throws Exception

Alternative IssueCommand 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

Throws:

Exception - processing error

Method Detail

issueCommand

public ConsoleResponse issueCommand(IssueParams params)
                             throws Exception

Issue an MVS console command done synchronously - meaning solicited (direct command responses) are gathered immediately after the command is issued. However, after (according to the z/OSMF REST API documentation) approximately 3 seconds the response will be returned.

Parameters:

params - console issue parameters, see IssueParams object

Returns:

command response on resolve, see ConsoleResponse object

Throws:

Exception - processing error

issueCommonCommand

public ZosmfIssueResponse issueCommonCommand(String consoleName,
                                             ZosmfIssueParams commandParams)
                                      throws Exception

Issue an MVS console command, returns "raw" z/OSMF response

Parameters:

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

commandParams - synchronous console issue parameters, see ZosmfIssueParams object

Returns:

command response on resolve, see ZosmfIssueResponse object

Throws:

Exception - processing error

issueDefConsoleCommon

public ZosmfIssueResponse issueDefConsoleCommon(ZosmfIssueParams commandParams)
                                         throws Exception

Issue an MVS console command in default console, returns "raw" z/OSMF response

Parameters:

commandParams - synchronous console issue parameters, see ZosmfIssueParams object

Returns:

command response on resolve, see ZosmfIssueResponse object

Throws:

Exception - processing error

issueCommand

public ConsoleResponse issueCommand(String theCommand)
                             throws Exception

Issue console command method. Does not accept parameters, so all defaults on the z/OSMF API are taken.

Parameters:

theCommand - string command to issue

Returns:

command response on resolve, see ConsoleResponse object

Throws:

Exception - processing error