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.zosmfinfo.methods	z/OSMF informational functionality by the SDK
zowe.client.sdk.zostso.lifecycle	z/OS tso console life cycle (start, send, and stop) processing
zowe.client.sdk.zostso.method	z/OS tso command functionality by the SDK
zowe.client.sdk.zostso.service	z/OS tso console service processing

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.HttpResponse<T> reply)	Build Response object from 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 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 given console name done synchronously - meaning solicited (direct command responses) are gathered immediately after the command is issued.
ConsoleResponse	IssueConsole.issueCommandCommon(String consoleName, IssueConsoleParams params)	Issue an MVS console command on given console name driven by IssueConsoleParams 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(CopyParams params)	Copy dataset or dataset member request driven by CopyParams object settings
Response	DsnCreate.create(String dataSetName, CreateParams params)	Creates a new dataset with specified parameters
Response	DsnRename.dataSetName(String dataSetName, String newDataSetName)	Change the existing dataset name (source) to 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, DownloadParams params)	Retrieve sequential dataset or dataset member content
List<Dataset>	DsnList.getDatasets(String dataSetName, ListParams params)	Get a list of Dataset objects
Dataset	DsnGet.getDsnInfo(String dataSetName)	Retrieve dataset information.
List<Member>	DsnList.getMembers(String dataSetName, ListParams params)	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 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 tag of a UNIX file to binary type
Response	UssChangeMode.change(String targetPath, ChangeModeParams params)	Change the mode of a UNIX file or directory request driven by ChangeModeParams object settings
Response	UssChangeOwner.change(String targetPath, String owner)	Perform chown operation on UNIX file or directory
Response	UssChangeOwner.changeCommon(String targetPath, ChangeOwnerParams params)	Perform chown operation on UNIX file or directory request driven by ChangeOwnerParams object settings
Response	UssChangeTag.changeCommon(String fileNamePath, ChangeTagParams params)	Change tag of a UNIX file request driven by ChangeTagParams object settings
Response	UssCopy.copy(String fromPath, String targetPath)	Copy a Unix file or directory to another location
Response	UssCopy.copyCommon(String targetPath, CopyParams params)	Copy a Unix file or directory to another location request driven by CopyParams object settings
Response	UssCreate.create(String targetPath, CreateParams params)	Perform UNIX create file or directory name request driven by CreateParams 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, CreateZfsParams params)	Create a ZFS request driven by the CreateZfsParams 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 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, GetAclParams params)	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, GetParams params)	Get the contents of a UNIX file driven by the GetParams object settings
List<UnixFile>	UssList.getFiles(ListParams params)	Perform list of UNIX files operation
String	UssGet.getText(String fileNamePath)	Get the text contents of a UNIX file
List<UnixZfs>	UssList.getZfsSystems(ListZfsParams params)	Perform 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, MountParams params)	Perform mount or unmount of a file system name request driven by MountParams settings
Response	UssMove.move(String fromPath, String targetPath)	Move a UNIX file or directory with overwrite set as true
Response	UssMove.move(String fromPath, String targetPath, boolean overwrite)	Move a UNIX file or directory with overwrite 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, SetAclParams params)	Sets the ACL for a USS file or directory request driven by SetAclParams object settings
Response	UssChangeTag.text(String fileNamePath, String codeSet)	Change tag of a UNIX file to text type
Response	UssMount.unmount(String fileSystemName)	Perform unmount of a file system name
Response	UssWrite.writeBinary(String fileNamePath, byte[] content)	Perform UNIX write binary content request
Response	UssWrite.writeCommon(String fileNamePath, WriteParams params)	Perform UNIX write request driven by WriteParams 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 that resides in a z/OS data set.
Response	JobCancel.cancelByJob(Job job, String version)	Cancel a job that resides in a z/OS data set.
Response	JobCancel.cancelCommon(ModifyJobParams params)	Cancel a job that resides in a z/OS data set.
Response	JobDelete.delete(String jobName, String jobId, String version)	Cancel and purge job from spool.
Response	JobDelete.deleteByJob(Job job, String version)	Cancel and purge job from spool.
Response	JobDelete.deleteCommon(ModifyJobParams params)	Delete a job that resides in a z/OS data set.
List<Job>	JobGet.getAll()	Get jobs (defaults to the user ID of the session as 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(GetJobParams params)	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(CommonJobParams params)	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 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(CommonJobParams params)	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.
Job	JobGet.getStatusByJob(Job job)	Get the status and other details (e.g.
Job	JobGet.getStatusCommon(CommonJobParams params)	Get the status and other details (e.g.
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(MonitorJobWaitForParams params)	Determines if a given job is in a running state or not.
Job	JobSubmit.submit(String jobDataSet)	Submit a job that resides in a z/OS dataset.
Job	JobSubmit.submitByJcl(String jcl, String internalReaderRecfm, String internalReaderLrecl)	Submit a string of JCL to run
Job	JobSubmit.submitCommon(SubmitJobParams params)	Submit a job that resides in a z/OS dataset.
Job	JobSubmit.submitJclCommon(SubmitJclParams params)	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, waits for the given message from the job.
boolean	JobMonitor.waitByMessage(Job job, String message)	Given a Job document (has jobname/jobid), waits for the given message from the job.
Job	JobMonitor.waitByOutputStatus(String jobName, String jobId)	Given the jobname/jobid, waits for the status of the job to be "OUTPUT".
Job	JobMonitor.waitByOutputStatus(Job job)	Given a Job document (has jobname/jobid), waits for the status of the job to be "OUTPUT".
Job	JobMonitor.waitByStatus(String jobName, String jobId, JobStatus.Type statusType)	Given the jobname/jobid, waits for the given status of the job.
Job	JobMonitor.waitByStatus(Job job, JobStatus.Type statusType)	Given a Job document (has jobname/jobid), waits for the given status of the job.
boolean	JobMonitor.waitMessageCommon(MonitorJobWaitForParams params, String message)	Given jobname/jobid, checks for the desired message continuously (based on the interval and attempts specified).
Job	JobMonitor.waitStatusCommon(MonitorJobWaitForParams params)	Given jobname/jobid, checks 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
ZosLogReply	ZosLog.issueCommand(ZosLogParams params)	Issue a z/OSMF log command and return log data.

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.lifecycle

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

Modifier and Type	Method	Description
CollectedResponses	SendTso.getAllResponses(ZosmfTsoResponse tso)	Collects responses from address space until it reaches prompt
SendResponse	SendTso.sendDataToTsoCollect(String servletKey, String command)	API method to send data to already started TSO address space, but will read TSO data until a PROMPT is reached.
ZosmfTsoResponse	SendTso.sendDataToTsoCommon(SendTsoParams commandParams)	API method to send data to already started TSO address space
StartStopResponses	StartTso.start(String accountNumber, StartTsoParams params)	Start TSO address space with provided parameters.
ZosmfTsoResponse	StartTso.startCommon(StartTsoParams commandParams)	Start TSO address space with provided parameters
StartStopResponse	StopTso.stop(String servletKey)	Stop TSO address space and populates response with StartStopResponse, @see StartStopResponse
ZosmfTsoResponse	StopTso.stopCommon(StopTsoParams commandParams)	Sends REST call to z/OSMF for stopping active TSO address space

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

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

Modifier and Type	Method	Description
IssueResponse	IssueTso.issueCommand(String accountNumber, String command)	API method to start a TSO address space, issue a command, collect responses until prompt is reached, and terminate the address space.
IssueResponse	IssueTso.issueCommand(String accountNumber, String command, StartTsoParams startParams)	API method to start a TSO address space with provided parameters, issue a command, collect responses until prompt is reached, and terminate the address space.

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

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

Modifier and Type	Method	Description
ZosmfTsoResponse	TsoResponseService.getZosmfTsoResponse()	Retrieve tso response