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

Class UssChangeTag

java.lang.Object

zowe.client.sdk.zosfiles.uss.methods.UssChangeTag

public class UssChangeTag
extends Object

Provides Unix System Services (USS) chtag functionality

z/OSMF REST API

Version:

2.0

Author:

James Kostrewski

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Response	changeCommon(String fileNamePath, ChangeTagParams params)	Change tag of a UNIX file request driven by ChangeTagParams object settings
Response	changeToBinary(String fileNamePath)	Change tag of a UNIX file to binary type
Response	changeToText(String fileNamePath, String codeSet)	Change tag of a UNIX file to text type
Response	remove(String fileNamePath)	Remove tag of a UNIX file
Response	retrieve(String fileNamePath)	Retrieve existing UNIX file tag information

Methods inherited from class java.lang.Object

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

Constructor Detail

UssChangeTag

public UssChangeTag(ZosConnection connection)

UssChangeTag Constructor

Parameters:

connection - connection information, see ZosConnection object

UssChangeTag

public UssChangeTag(ZosConnection connection,
                    ZoweRequest request)
             throws Exception

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

Throws:

Exception - processing error

Method Detail

changeToBinary

public Response changeToBinary(String fileNamePath)
                        throws Exception

Change tag of a UNIX file to binary type

Parameters:

fileNamePath - file name with path

Returns:

Response Object

Throws:

Exception - processing error

changeToText

public Response changeToText(String fileNamePath,
                             String codeSet)
                      throws Exception

Change tag of a UNIX file to text type

Parameters:

fileNamePath - file name with path

codeSet - code set name. i.e. IBM-1047

Returns:

Response Object

Throws:

Exception - processing error

remove

public Response remove(String fileNamePath)
                throws Exception

Remove tag of a UNIX file

Parameters:

fileNamePath - file name with path

Returns:

Response Object

Throws:

Exception - processing error

retrieve

public Response retrieve(String fileNamePath)
                  throws Exception

Retrieve existing UNIX file tag information

Parameters:

fileNamePath - file name with path

Returns:

Response Object

Throws:

Exception - processing error

changeCommon

public Response changeCommon(String fileNamePath,
                             ChangeTagParams params)
                      throws Exception

Change tag of a UNIX file request driven by ChangeTagParams object settings

Parameters:

fileNamePath - file name with path

params - parameters for the change tag request, see ChangeTagParams object

Returns:

Response Object

Throws:

Exception - processing error