Package zowe.client.sdk.zosfiles.uss.methods

Class UssGet

java.lang.Object

zowe.client.sdk.zosfiles.uss.methods.UssGet

public class UssGet
extends Object

Provides Unix System Services (USS) read from object functionality

z/OSMF REST API

Version:

4.0

Author:

James Kostrewski, Frank Giordano

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
byte[]	getBinary(String fileNamePath)	Get the binary contents of a UNIX file
Response	getCommon(String fileNamePath, GetParams params)	Get the contents of a UNIX file driven by the GetParams object settings
String	getText(String fileNamePath)	Get the text contents of a UNIX file

Methods inherited from class java.lang.Object

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

Constructor Detail

UssGet

public UssGet(ZosConnection connection)

UssGet Constructor

Parameters:

connection - connection information, see ZosConnection object

UssGet

public UssGet(ZosConnection connection,
              ZosmfRequest request)

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

getBinary

public byte[] getBinary(String fileNamePath)
                 throws ZosmfRequestException

Get the binary contents of a UNIX file

Parameters:

fileNamePath - file name with a path

Returns:

the byte array contents of the file

Throws:

ZosmfRequestException - request error state

getText

public String getText(String fileNamePath)
               throws ZosmfRequestException

Get the text contents of a UNIX file

Parameters:

fileNamePath - file name with a path

Returns:

the text contents of a file

Throws:

ZosmfRequestException - request error state

getCommon

public Response getCommon(String fileNamePath,
                          GetParams params)
                   throws ZosmfRequestException

Get the contents of a UNIX file driven by the GetParams object settings

Parameters:

fileNamePath - file name with a path

params - GetParams object to drive the request

Returns:

Response object

Throws:

ZosmfRequestException - request error state