Package zowe.client.sdk.zosfiles.dsn.methods

Class DsnGet

java.lang.Object

zowe.client.sdk.zosfiles.dsn.methods.DsnGet

public class DsnGet
extends Object

Provides retrieve dataset and member functionality

Version:

2.0

Author:

Nikunj Goyal, Frank Giordano

Constructor Summary

Constructors

Constructor	Description
DsnGet(ZosConnection connection)	DsnGet Constructor
DsnGet(ZosConnection connection, ZosmfRequest request)	Alternative DsnGet constructor with ZoweRequest object.

Method Summary

Modifier and Type	Method	Description
InputStream	get(String targetName, DownloadParams params)	Retrieve sequential dataset or dataset member content
Dataset	getDsnInfo(String dataSetName)	Retrieve dataset information.

Methods inherited from class java.lang.Object

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

Constructor Detail

DsnGet

public DsnGet(ZosConnection connection)

DsnGet Constructor

Parameters:

connection - connection information, see ZOSConnection object

DsnGet

public DsnGet(ZosConnection connection,
              ZosmfRequest request)

Alternative DsnGet 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

getDsnInfo

public Dataset getDsnInfo(String dataSetName)
                   throws ZosmfRequestException

Retrieve dataset information.

Parameters:

dataSetName - sequential or partition dataset (e.g. 'DATASET.LIB')

Returns:

dataset object

Throws:

ZosmfRequestException - request error state

get

public InputStream get(String targetName,
                       DownloadParams params)
                throws ZosmfRequestException

Retrieve sequential dataset or dataset member content

Parameters:

targetName - name of a sequential dataset e.g. DATASET.SEQ.DATA or a dataset member e.g. DATASET.LIB(MEMBER))

params - download params parameters, see DownloadParams object

Returns:

a content stream

Throws:

ZosmfRequestException - request error state