Package zosconsole

Class IssueCommand

java.lang.Object

zosconsole.IssueCommand

public class IssueCommand
extends Object

Issue MVS Console commands by using a system console

Version:

1.0

Author:

Frank Giordano

Constructor Summary

Constructors

Constructor	Description
IssueCommand(ZOSConnection connection)	IssueCommand constructor

Method Summary

Modifier and Type	Method	Description
ZosmfIssueParams	buildZosmfConsoleApiParameters(IssueParams params)	Build ZosmfIssueParams object from provided parameters
ConsoleResponse	issue(IssueParams params)	Issue an MVS console command done synchronously - meaning solicited (direct command responses) are gathered immediately after the command is issued.
ZosmfIssueResponse	issueCommon(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
ConsoleResponse	issueSimple(String theCommand)	Simple issue console command method.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueCommand

public IssueCommand(ZOSConnection connection)

IssueCommand constructor

Parameters:

connection - connection information, see ZOSConnection object

Method Detail

issueCommon

public ZosmfIssueResponse issueCommon(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

issue

public ConsoleResponse issue(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

issueSimple

public ConsoleResponse issueSimple(String theCommand)
                            throws Exception

Simple 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

buildZosmfConsoleApiParameters

public ZosmfIssueParams buildZosmfConsoleApiParameters(IssueParams params)

Build ZosmfIssueParams object from provided parameters

Parameters:

params - parameters for issue command, see IssueParams object

Returns:

request body parameters, see ZosmfIssueParams object