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, ZosmfRequest request)	Alternative IssueCommand constructor with ZoweRequest object.

Method Summary

Modifier and Type	Method	Description
ConsoleResponse	issueCommand(String command)	Issue an MVS console command on default console name (Defcn) done synchronously - meaning solicited (direct command responses) are gathered immediately after the command is issued.
ConsoleResponse	issueCommand(String command, String consoleName)	Issue an MVS console command on given console name done synchronously - meaning solicited (direct command responses) are gathered immediately after the command is issued.
ConsoleResponse	issueCommandCommon(String consoleName, IssueConsoleParams params)	Issue an MVS console command on given console name driven by IssueConsoleParams settings done synchronously

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,
                    ZosmfRequest request)

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

Method Detail

issueCommand

public ConsoleResponse issueCommand(String command)
                             throws Exception

Issue an MVS console command on default console name (Defcn) 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:

command - string value that represents command to issue

Returns:

ConsoleResponse object

Throws:

Exception - processing error

issueCommand

public ConsoleResponse issueCommand(String command,
                                    String consoleName)
                             throws Exception

Issue an MVS console command on given console name 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:

command - string value representing console command to issue

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

Returns:

ConsoleResponse object

Throws:

Exception - processing error

issueCommandCommon

public ConsoleResponse issueCommandCommon(String consoleName,
                                          IssueConsoleParams params)
                                   throws Exception

Issue an MVS console command on given console name driven by IssueConsoleParams settings done synchronously

Parameters:

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

params - synchronous console issue parameters, see ZosmfIssueParams object

Returns:

command response on resolve, see ZosmfIssueResponse object

Throws:

Exception - processing error