Uses of Class
zowe.client.sdk.rest.exception.ZosmfRequestException

Packages that use ZosmfRequestException

Package	Description
zowe.client.sdk.rest	Http functionality used by the SDK via UNIREST library.
zowe.client.sdk.utility	Set of utilities for SDK packages
zowe.client.sdk.zosconsole.method	z/OS mvs console functionality provided by the SDK
zowe.client.sdk.zosfiles.dsn.methods	z/OS dataset and member files functionality provided by the SDK
zowe.client.sdk.zosfiles.uss.methods	z/OS Unix System Services (USS) files functionality provided by the SDK
zowe.client.sdk.zosjobs.methods	z/OS jobs functionality provided by the SDK
zowe.client.sdk.zoslogs.method	z/OS log functionality provided by the SDK
zowe.client.sdk.zosmfauth.methods	z/OSMF authentication services functionality provided by the SDK
zowe.client.sdk.zosmfinfo.methods	z/OSMF informational functionality by the SDK
zowe.client.sdk.zostso.methods	z/OS tso command functionality by the SDK

Uses of ZosmfRequestException in zowe.client.sdk.rest

Methods in zowe.client.sdk.rest that throw ZosmfRequestException

Modifier and Type	Method	Description
<T> Response	ZosmfRequest.buildResponse(kong.unirest.core.HttpResponse<T> reply)	Build a Response object from a given HttpResponse reply
Response	DeleteJsonZosmfRequest.executeRequest()	Perform the http rest request
Response	GetJsonZosmfRequest.executeRequest()	Perform the http rest request
Response	GetStreamZosmfRequest.executeRequest()	Perform the http rest request
Response	GetTextZosmfRequest.executeRequest()	Perform the http rest request
Response	PostJsonZosmfRequest.executeRequest()	Perform the http rest request
Response	PutJsonZosmfRequest.executeRequest()	/** Perform the http rest request
Response	PutStreamZosmfRequest.executeRequest()	Perform the http rest request
Response	PutTextZosmfRequest.executeRequest()	Perform the http rest request
abstract Response	ZosmfRequest.executeRequest()	Perform the http rest request

Uses of ZosmfRequestException in zowe.client.sdk.utility

Methods in zowe.client.sdk.utility that throw ZosmfRequestException

Modifier and Type	Method	Description
static String	TsoUtil.getResponseStr(ZosmfRequest request)	Helper method calls to perform the request http request and returns the response object as a string value.
static org.json.simple.JSONObject	JsonParserUtil.parse(String item)	This method is a wrapper for JSONParser().parse() call to parse z/OSMF response which may return ZosmfRequestException.
static org.json.simple.JSONArray	JsonParserUtil.parseArray(String item)	This method is a wrapper for JSONParser().parse() call to parse z/OSMF response which may return ZosmfRequestException.

Uses of ZosmfRequestException in zowe.client.sdk.zosconsole.method

Methods in zowe.client.sdk.zosconsole.method that throw ZosmfRequestException

Modifier and Type	Method	Description
ConsoleResponse	IssueConsole.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	IssueConsole.issueCommand(String command, String consoleName)	Issue an MVS console command on a given console name done synchronously - meaning solicited (direct command responses) are gathered immediately after the command is issued.
ConsoleResponse	IssueConsole.issueCommandCommon(String consoleName, IssueConsoleInputData consoleInputData)	Issue an MVS console command on a given console name driven by IssueConsoleInputData settings done synchronously

Uses of ZosmfRequestException in zowe.client.sdk.zosfiles.dsn.methods

Methods in zowe.client.sdk.zosfiles.dsn.methods that throw ZosmfRequestException

Modifier and Type	Method	Description
Response	DsnCopy.copy(String fromDataSetName, String toDataSetName, boolean replace, boolean copyAllMembers)	This copy method allows the following copy operations:
Response	DsnCopy.copyCommon(DsnCopyInputData copyInputData)	Copy dataset or dataset member request driven by DsnCopyInputData object settings
Response	DsnCreate.create(String dataSetName, DsnCreateInputData createInputData)	Creates a new dataset with specified parameters
Response	DsnRename.dataSetName(String dataSetName, String newDataSetName)	Change the existing dataset name (source) to a new dataset name (destination)
Response	DsnDelete.delete(String dataSetName)	Delete a dataset
Response	DsnDelete.delete(String dataSetName, String memberName)	Delete a dataset member
InputStream	DsnGet.get(String targetName, DsnDownloadInputData downloadInputData)	Retrieve sequential dataset or dataset member content
List<Dataset>	DsnList.getDatasets(String dataSetName, DsnListInputData listInputData)	Get a list of Dataset objects
Dataset	DsnGet.getDsnInfo(String dataSetName)	Retrieve dataset information.
List<Member>	DsnList.getMembers(String dataSetName, DsnListInputData listInputData)	Get a list of member objects from a partition Dataset
Response	DsnRename.memberName(String fromDataSetName, String memberName, String newMemberName)	Change the existing member name (source) to a new member name (destination) within a partition dataset
Response	DsnWrite.write(String dataSetName, String content)	Replaces the content of an existing sequential data set with new content.
Response	DsnWrite.write(String dataSetName, String memberName, String content)	Replaces the content of a member of a partitioned data set (PDS or PDSE) with new content.

Uses of ZosmfRequestException in zowe.client.sdk.zosfiles.uss.methods

Methods in zowe.client.sdk.zosfiles.uss.methods that throw ZosmfRequestException

Modifier and Type	Method	Description
Response	UssChangeTag.binary(String fileNamePath)	Change the tag of a UNIX file to a binary type
Response	UssChangeMode.change(String targetPath, UssChangeModeInputData changeModeInputData)	Change the mode of a UNIX file or directory request driven by UssChangeModeInputData object settings
Response	UssChangeOwner.change(String targetPath, String owner)	Perform chown operation on a UNIX file or directory
Response	UssChangeOwner.changeCommon(String targetPath, UssChangeOwnerInputData changeOwnerInputData)	Perform chown operation on a UNIX file or directory request driven by UssChangeOwnerInputData object settings
Response	UssChangeTag.changeCommon(String fileNamePath, UssChangeTagInputData changeTagInputData)	Change tag of a UNIX file request driven by UssChangeTagInputData object settings
Response	UssCopy.copy(String fromPath, String targetPath)	Copy a Unix file or directory to another location
Response	UssCopy.copyCommon(String targetPath, UssCopyInputData copyInputData)	Copy a Unix file or directory to another location request driven by UssCopyInputData object settings
Response	UssCreate.create(String targetPath, UssCreateInputData createInputData)	Perform UNIX create a file or directory name request driven by UssCreateInputData object settings.
Response	UssCreate.createZfs(String fileSystemName)	Create a ZFS using default values of 755 permissions, 10 primary and 2 secondary cylinders allocated, and a timeout of 20 seconds.
Response	UssCreate.createZfsCommon(String fileSystemName, UssCreateZfsInputData createZfsInputData)	Create a ZFS request driven by the UssCreateZfsInputData object settings.
Response	UssDelete.delete(String targetPath)	Perform UNIX delete file or directory name request
Response	UssDelete.delete(String targetPath, boolean recursive)	Perform UNIX delete file or directory name request with a recursive flag
Response	UssSetAcl.delete(String targetPath, String value)	Deletes the specified ACL entry from the file or directory
Response	UssSetAcl.deleteByType(String targetPath, DeleteAclType deleteType)	Delete all extended ACL entries by type (setfacl -D type):
Response	UssDelete.deleteZfs(String fileSystemName)	Delete UNIX zFS Filesystem
String	UssExtAttr.display(String targetPath)	Returns a response string documenting listing attributes
Response	UssChangeTag.get(String fileNamePath)	Retrieve existing UNIX file tag information
String	UssGetAcl.get(String targetPath, boolean useCommas)	Get the ACL for a USS file or directory
Response	UssGetAcl.getAclCommon(String targetPath, UssGetAclInputData getAclInputData)	Get the ACL for a USS file or directory
byte[]	UssGet.getBinary(String fileNamePath)	Get the binary contents of a UNIX file
Response	UssGet.getCommon(String fileNamePath, UssGetInputData getInputData)	Get the contents of a UNIX file driven by the UssGetInputData object settings
List<UnixFile>	UssList.getFiles(UssListInputData listInputData)	Perform a list of UNIX files operation
String	UssGet.getText(String fileNamePath)	Get the text contents of a UNIX file
List<UnixZfs>	UssList.getZfsSystems(UssListZfsInputData listZfsInputData)	Perform a list of UNIX filesystems operation
Response	UssSetAcl.modify(String targetPath, String value)	Modifies the specified ACL entry for the file or directory
Response	UssMount.mount(String fileSystemName, String mountPoint, String fsType)	Perform mount of a file system name to the UNIX file system.
Response	UssMount.mountCommon(String fileSystemName, UssMountInputData mountInputData)	Perform mount or unmount of a file system name request driven by UssMountInputData settings
Response	UssMove.move(String fromPath, String targetPath)	Move a UNIX file or directory with overwriting set as true
Response	UssMove.move(String fromPath, String targetPath, boolean overwrite)	Move a UNIX file or directory with overwritten value specified
Response	UssChangeTag.remove(String fileNamePath)	Remove tag of a UNIX file
Response	UssExtAttr.reset(String targetPath, String value)	Resets the attributes of a file or directory
Response	UssExtAttr.set(String targetPath, String value)	Extends the attributes of a file or directory
Response	UssSetAcl.set(String targetPath, String value)	Sets the ACL for a USS file or directory
Response	UssSetAcl.setAclCommon(String targetPath, UssSetAclInputData setAclInputData)	Sets the ACL for a USS file or directory request driven by UssSetAclInputData object settings
Response	UssChangeTag.text(String fileNamePath, String codeSet)	Change the tag of a UNIX file to a text type
Response	UssMount.unmount(String fileSystemName)	Perform unmounting of a file system name
Response	UssWrite.writeBinary(String fileNamePath, byte[] content)	Perform UNIX write binary content request
Response	UssWrite.writeCommon(String fileNamePath, UssWriteInputData writeInputData)	Perform UNIX write request driven by UssWriteInputData settings
Response	UssWrite.writeText(String fileNamePath, String content)	Perform UNIX write text content request

Uses of ZosmfRequestException in zowe.client.sdk.zosjobs.methods

Methods in zowe.client.sdk.zosjobs.methods that throw ZosmfRequestException

Modifier and Type	Method	Description
Response	JobCancel.cancel(String jobName, String jobId, String version)	Cancel a job on z/OS by job name and job id values.
Response	JobCancel.cancelByJob(Job job, String version)	Cancel a job on z/OS by job object.
Response	JobCancel.cancelCommon(JobModifyInputData modifyInputData)	Cancel a job on z/OS by JobModifyInputData object.
Response	JobDelete.delete(String jobName, String jobId, String version)	Cancel and purge a job from spool.
Response	JobDelete.deleteByJob(Job job, String version)	Cancel and purge a job from spool.
Response	JobDelete.deleteCommon(JobModifyInputData modifyInputData)	Delete a job on z/OS by JobModifyInputData object.
List<Job>	JobGet.getAll()	Get jobs (defaults to the user ID of the session as an owner).
Job	JobGet.getById(String jobId)	Get a job by job id.
List<Job>	JobGet.getByOwner(String owner)	Get jobs that are owned by a certain user or pattern of users.
List<Job>	JobGet.getByOwnerAndPrefix(String owner, String prefix)	Get a list of jobs that match an owner and prefix.
List<Job>	JobGet.getByPrefix(String prefix)	Get jobs that match a job name by prefix.
List<Job>	JobGet.getCommon(JobGetInputData getInputData)	Get jobs filtered by owner and prefix.
String	JobGet.getJcl(String jobName, String jobId)	Get JCL from a job.
String	JobGet.getJclByJob(Job job)	Get JCL from a job.
String	JobGet.getJclCommon(CommonJobInputData commonInputData)	Get the JCL that was used to submit a job.
String	JobGet.getSpoolContent(String jobName, String jobId, int spoolId)	Get spool content from a job using the job name, job ID, and spool ID number.
String	JobGet.getSpoolContent(JobFile jobFile)	Get spool content from a job (keeping a naming convention pattern with this duplication function).
String	JobGet.getSpoolContentCommon(JobFile jobFile)	Get spool file content from a job file definition.
List<JobFile>	JobGet.getSpoolFiles(String jobName, String jobId)	Get a list of all spool files for a job.
List<JobFile>	JobGet.getSpoolFilesByJob(Job job)	Get a list of all job spool files for a job.
List<JobFile>	JobGet.getSpoolFilesCommon(CommonJobInputData commonInputData)	Get a list of all job spool files for a job.
Job	JobGet.getStatus(String jobName, String jobId)	Get the status and other details (e.g., owner, return code) for a job, including step-data.
Job	JobGet.getStatusByJob(Job job)	Get the status and other details (e.g., owner, return code) for a job, including step-data.
Job	JobGet.getStatusCommon(CommonJobInputData commonInputData)	Get the status and other details (e.g., owner, return code) for a job, including step-data.
String	JobGet.getStatusValue(String jobName, String jobId)	Get the status value only for a given job name and id.
String	JobGet.getStatusValueByJob(Job job)	Get the status value for a given job object.
boolean	JobMonitor.isRunning(JobMonitorInputData monitorInputData)	Determines if a given job is in a running state or not.
Job	JobSubmit.submit(String jobDataSet)	Submit a job on z/OS.
Job	JobSubmit.submitByJcl(String jcl, String internalReaderRecfm, String internalReaderLrecl)	Submit a string of JCL to run
Job	JobSubmit.submitCommon(JobSubmitInputData submitInputData)	Submit a job on z/OS.
Job	JobSubmit.submitJclCommon(JobSubmitJclInputData submitJclInputData)	Submit a JCL string to run which can contain JCL symbolic substitutions
boolean	JobMonitor.waitByMessage(String jobName, String jobId, String message)	Given the jobname/jobid, wait for the given message from the job.
boolean	JobMonitor.waitByMessage(Job job, String message)	Given a Job document (has jobname/jobid), wait for the given message from the job.
Job	JobMonitor.waitByOutputStatus(String jobName, String jobId)	Given the jobname/jobid, wait for the status of the job to be "OUTPUT".
Job	JobMonitor.waitByOutputStatus(Job job)	Given a Job document (has jobname/jobid), wait for the status of the job to be "OUTPUT".
Job	JobMonitor.waitByStatus(String jobName, String jobId, JobStatus.Type statusType)	Given the jobname/jobid, wait for the given status of the job.
Job	JobMonitor.waitByStatus(Job job, JobStatus.Type statusType)	Given a Job document (has jobname/jobid), wait for the given status of the job.
boolean	JobMonitor.waitMessageCommon(JobMonitorInputData monitorInputData, String message)	Given jobname/jobid, check for the desired message continuously (based on the interval and attempts specified).
Job	JobMonitor.waitStatusCommon(JobMonitorInputData monitorInputData)	Given jobname/jobid, check for the desired "status" (default is "OUTPUT") continuously (based on the interval and attempts specified).

Uses of ZosmfRequestException in zowe.client.sdk.zoslogs.method

Methods in zowe.client.sdk.zoslogs.method that throw ZosmfRequestException

Modifier and Type	Method	Description
ZosLogResponse	ZosLog.issueCommand(ZosLogInputData logInputData)	Issue a z/OSMF log command and return log data.

Uses of ZosmfRequestException in zowe.client.sdk.zosmfauth.methods

Methods in zowe.client.sdk.zosmfauth.methods that throw ZosmfRequestException

Modifier and Type	Method	Description
Response	ZosmfPassword.changePassword(PasswordInputData pwdInputData)	Change the password or passphrase for a specified User ID driven by PasswordInputData object settings
ZosmfLoginResponse	ZosmfLogin.login()	Request to log into the server and retrieve authentication tokens
Response	ZosmfLogout.logout(kong.unirest.core.Cookie token)	Request to log out of server and delete authentication cookie token

Uses of ZosmfRequestException in zowe.client.sdk.zosmfinfo.methods

Methods in zowe.client.sdk.zosmfinfo.methods that throw ZosmfRequestException

Modifier and Type	Method	Description
ZosmfInfoResponse	ZosmfStatus.get()	Get z/OSMF information
ZosmfSystemsResponse	ZosmfSystems.get()	List systems defined to z/OSMF

Uses of ZosmfRequestException in zowe.client.sdk.zostso.methods

Methods in zowe.client.sdk.zostso.methods that throw ZosmfRequestException

Modifier and Type	Method	Description
List<String>	TsoCmd.issueCommand(String command)	Issue TSO command API call to process the given command via z/OSMF restful api
List<String>	TsoCmd.issueCommand(String command, StartTsoInputData inputData)	Issue TSO command API call to process the given command via z/OSMF restful with given custom parameters for the start TSO session call
TsoCommonResponse	TsoPing.ping(String sessionId)	Send a ping request to z/OSMF TSO to keep the session alive
String	TsoReply.reply(String sessionId)	Send a request to z/OSMF TSO for additional TSO message data from a valid already started TSO session.
String	TsoSend.sendCommand(String sessionId, String command)	Make the second request to send TSO the command to perform via z/OSMF
TsoStartResponse	TsoStart.start(StartTsoInputData inputData)	Make the first TSO request to start the TSO session and retrieve its session id (servletKey).
TsoCommonResponse	TsoStop.stop(String sessionId)	Stop the TSO session by session id (servletKey)