|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IZOSConnection
Abstraction of a connection to a z/OS system
Nested Class Summary | |
---|---|
static class |
IZOSConnection.DataSetArguments
Parameter object used when creating datasets |
Field Summary | |
---|---|
static java.lang.String |
CATEGORY_ID
z/OS connection category ID |
static java.lang.String |
COPYRIGHT
|
static java.lang.String |
FTP_DESCRIPTOR_ID
z/OS FTP connection type ID |
Method Summary | |
---|---|
void |
cancelJob(java.lang.String jobID)
Cancels an active job |
boolean |
canPerform(java.lang.String actionID,
java.lang.String iD)
Returns a boolean indicating whether or not this z/OS connection is capable of performing the indicated action. |
void |
changePermissions(java.lang.String anHFSEntry,
java.lang.String octal)
Sets the permissions of an HFS resource |
void |
createDataSet(java.lang.String dataSetName,
IZOSConnection.DataSetArguments dataSetArguments)
Creates a new dataset using the supplied IZOSConnection.DataSetArguments . |
void |
createDataSet(java.lang.String dataSetName,
java.lang.String basedOnDataSetPath,
java.io.InputStream contents)
Creates a new dataset based on an existing dataset |
ZOSConnectionResponse |
createDataSetMember(java.lang.String dataSetName,
java.lang.String memberName)
Creates a new member in an existing PDS. |
void |
createFolderHFS(java.lang.String aPath)
Creates a new folder in HFS |
void |
deleteDataSet(java.lang.String dataSetName,
java.lang.String memberName)
Deletes a member of a PDS. |
void |
deleteJob(java.lang.String jobID)
Deletes a job from the z/OS job queue |
void |
deletePathHFS(java.lang.String folderName)
Deletes a named folder in HFS |
boolean |
existsHFS(java.lang.String aPath)
Determines whether or not the supplied HFS path exists |
boolean |
existsHFSFile(java.lang.String path,
java.lang.String aName)
Determines whether a particular HFS file exists |
ZOSConnectionResponse |
getDataSet(java.lang.String dataSetName)
Retrieve metadata for a named dataset. |
ZOSConnectionResponse |
getDataSetMember(java.lang.String dataSetName,
java.lang.String memberName)
Retrieve metadata for a dataset member. |
java.util.List<ZOSConnectionResponse> |
getDataSetMembers(java.lang.String dataSetName)
Retrive a list of children of a dataset. |
java.io.ByteArrayOutputStream |
getFileHFS(java.lang.String fileName,
FileType aFileType)
Retrieve the contents of a file from HFS |
java.util.List<ZOSConnectionResponse> |
getHFSChildren(java.lang.String aPath,
boolean includeHiddenFiles)
Returns metadata for all children of a given HFS path. |
java.io.ByteArrayOutputStream |
getJobSpool(java.lang.String jobID)
Return the job spool for a named job |
void |
perform(java.lang.String request,
java.lang.String argument)
Deprecated. not used |
void |
recallDataSetMember(java.lang.String dataSetName,
java.lang.String memberName)
Recalls a migrated dataset. |
java.io.ByteArrayOutputStream |
retrieveDataSetMember(java.lang.String dataSetName,
java.lang.String memberName)
Retrieve the contents of a PDS member. |
java.io.ByteArrayOutputStream |
retrieveSequentialDataSet(java.lang.String dataSetName)
Retrieves the contents of a sequential dataset. |
void |
saveDataSetMember(java.lang.String dataSetName,
java.lang.String memberName,
java.io.InputStream dataSetContents)
Saves the data provided by the supplied InputStream to the identified dataset member. |
void |
saveFileHFS(java.lang.String filePath,
java.io.InputStream fileContents,
FileType aFileType)
Saves the contents of an InputStream to an HFS file. |
java.io.ByteArrayOutputStream |
submitDataSetMember(java.lang.String dataSetName,
java.lang.String memberName)
Submits a PDS member as a job. |
ZOSConnectionResponse |
submitJob(java.io.InputStream stream)
Submits the contents of the supplied input stream to the z/OS job queue |
Methods inherited from interface com.ibm.cics.zos.comm.IZOSJobConnection |
---|
getJob, getJobs, getJobSteps, getJobStepSpool |
Methods inherited from interface com.ibm.cics.core.comm.IConnection |
---|
connect, disconnect, getConfiguration, getHost, getName, getPort, getUserID, isConnected, isSecure, setConfiguration |
Field Detail |
---|
static final java.lang.String COPYRIGHT
static final java.lang.String CATEGORY_ID
static final java.lang.String FTP_DESCRIPTOR_ID
Method Detail |
---|
java.util.List<ZOSConnectionResponse> getDataSetMembers(java.lang.String dataSetName) throws ConnectionException
dataSetName
- string to find the children for.
List
of ZOSConnectionResponse
s, which may be empty.
ConnectionException
- if there is any problem completing the request.java.io.ByteArrayOutputStream retrieveDataSetMember(java.lang.String dataSetName, java.lang.String memberName) throws ConnectionException
dataSetName
- name of the PDSmemberName
- name of the member of the PDS
ByteArrayOutputStream
containing the contents of the member
ConnectionException
- if a problem occurs retrieving the member contentsvoid recallDataSetMember(java.lang.String dataSetName, java.lang.String memberName) throws ConnectionException
dataSetName
- name of the dataset to recallmemberName
-
ConnectionException
- if there is any problem recalling the datasetjava.io.ByteArrayOutputStream retrieveSequentialDataSet(java.lang.String dataSetName) throws ConnectionException
dataSetName
- name of the dataset
ConnectionException
- if there is a problem retrieving the contentsjava.io.ByteArrayOutputStream submitDataSetMember(java.lang.String dataSetName, java.lang.String memberName) throws ConnectionException
dataSetName
- containing dataset namememberName
- member to submit
ConnectionException
- if there is a problem submitting the membervoid saveDataSetMember(java.lang.String dataSetName, java.lang.String memberName, java.io.InputStream dataSetContents) throws ConnectionException
InputStream
to the identified dataset member.
dataSetName
- the name of a datasetmemberName
- the name of a member in that datasetdataSetContents
- data to write
ConnectionException
- if there is any problem writing datavoid deleteDataSet(java.lang.String dataSetName, java.lang.String memberName) throws ConnectionException
dataSetName
- name of a datasetmemberName
- name of the member
ConnectionException
- if there is a problem deleting the membervoid createDataSet(java.lang.String dataSetName, IZOSConnection.DataSetArguments dataSetArguments) throws ConnectionException
IZOSConnection.DataSetArguments
.
dataSetName
- dataset namedataSetArguments
- set of parameters to use when constructing the dataset
ConnectionException
- if there is a problem constructing the datasetZOSConnectionResponse getDataSet(java.lang.String dataSetName) throws ConnectionException, ZOSFileNotFoundException
dataSetName
- name of a dataset
ZOSConnectionResponse
containing metadata for that dataset.
ZOSFileNotFoundException
- if the named dataset can not be found.
ConnectionException
- if there is a problem retrieving the metadata.ZOSConnectionResponse getDataSetMember(java.lang.String dataSetName, java.lang.String memberName) throws ConnectionException, ZOSFileNotFoundException
dataSetName
- name of a datasetmemberName
- name of a member within the dataset
ZOSConnectionResponse
containing metadata for that dataset.
ZOSFileNotFoundException
- if the dataset or member can't be found
ConnectionException
- if a problem occurs retrieving the metadataZOSConnectionResponse createDataSetMember(java.lang.String dataSetName, java.lang.String memberName) throws ConnectionException
dataSetName
- name of a PDSmemberName
- name of the member to create
ZOSConnectionResponse
containing metadata for the new dataset member
ConnectionException
- if a problem occurs when creating the new membervoid createDataSet(java.lang.String dataSetName, java.lang.String basedOnDataSetPath, java.io.InputStream contents) throws ConnectionException
dataSetName
- name of the new datasetbasedOnDataSetPath
- name of an existing dataset to base the new dataset oncontents
- contents to set to the new dataset
ConnectionException
- if a problem occurs when creating the new datasetjava.util.List<ZOSConnectionResponse> getHFSChildren(java.lang.String aPath, boolean includeHiddenFiles) throws ConnectionException
aPath
- pathincludeHiddenFiles
- whether or not to include hidden files
List
of ZOSConnectionResponse
containing metadata for all applicable children
ConnectionException
- if a problem occursboolean existsHFS(java.lang.String aPath) throws ConnectionException
aPath
- path to investigate
ConnectionException
- if a problem occursboolean existsHFSFile(java.lang.String path, java.lang.String aName) throws ConnectionException
path
- root pathaName
- file name
ConnectionException
- if a problem occursvoid createFolderHFS(java.lang.String aPath) throws ConnectionException
aPath
- path of the new folder to create
ConnectionException
- if a problem occursvoid deletePathHFS(java.lang.String folderName) throws ConnectionException
folderName
- name of the folder to delete
ConnectionException
- if a problem occursvoid saveFileHFS(java.lang.String filePath, java.io.InputStream fileContents, FileType aFileType) throws ConnectionException
InputStream
to an HFS file.
filePath
- path of the file to save tofileContents
- contents to saveaFileType
- transfer type
ConnectionException
- if a problem occursjava.io.ByteArrayOutputStream getFileHFS(java.lang.String fileName, FileType aFileType) throws ConnectionException
fileName
- name of the fileaFileType
- transfer type
ByteArrayOutputStream
containing the contents of the file
ConnectionException
- if a problem occursjava.io.ByteArrayOutputStream getJobSpool(java.lang.String jobID) throws ConnectionException
jobID
- ID of the target job
ByteArrayOutputStream
containing the spool for the named job
ConnectionException
- if a problem occursZOSConnectionResponse submitJob(java.io.InputStream stream) throws ConnectionException
stream
- InputStream
containing JCL for a job
ZOSConnectionResponse
containing metadata for the job.
ConnectionException
- if a problem occursvoid deleteJob(java.lang.String jobID) throws ConnectionException
jobID
- ID of the job to delete
ConnectionException
- if a problem occursvoid cancelJob(java.lang.String jobID) throws ConnectionException, ZOSFileNotFoundException, ZOSPermissionDeniedException
jobID
- ID of the target job
ConnectionException
- if a problem occurs
ZOSPermissionDeniedException
- if there was a permissions problem
ZOSFileNotFoundException
- if a job with the supplied ID did not existboolean canPerform(java.lang.String actionID, java.lang.String iD)
IZOSConstants
.
actionID
- ID of an action to enquireiD
- ID of the action target
@Deprecated void perform(java.lang.String request, java.lang.String argument) throws ConnectionException
ConnectionException
void changePermissions(java.lang.String anHFSEntry, java.lang.String octal) throws ConnectionException
anHFSEntry
- target HFS resourceoctal
- octal permission value
ConnectionException
- if a problem occurs
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |