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

Class UssExtAttr

java.lang.Object

zowe.client.sdk.zosfiles.uss.methods.UssExtAttr

public class UssExtAttr
extends Object

Provides Unix System Services (USS) extattr functionality

Version:

2.0

Author:

James Kostrewski

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	display(String targetPath)	Returns a response string documenting listing attributes
Response	reset(String targetPath, String value)	Resets the attributes of a file or directory
Response	set(String targetPath, String value)	Extends the attributes of a file or directory

Methods inherited from class java.lang.Object

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

Constructor Detail

UssExtAttr

public UssExtAttr(ZosConnection connection)

UssCopy Constructor

Parameters:

connection - connection information, see ZosConnection object

UssExtAttr

public UssExtAttr(ZosConnection connection,
                  ZosmfRequest request)
           throws Exception

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

display

public String display(String targetPath)
               throws Exception

Returns a response string documenting listing attributes

Parameters:

targetPath - path to the file or directory

Returns:

string output

Throws:

Exception - processing error

set

public Response set(String targetPath,
                    String value)
             throws Exception

Extends the attributes of a file or directory

Parameters:

targetPath - path to the file or directory

value - one or more of the following character: a,l,p,s

Returns:

Response object

Throws:

Exception - invalid value character sequence specified

reset

public Response reset(String targetPath,
                      String value)
               throws Exception

Resets the attributes of a file or directory

Parameters:

targetPath - path to the file or directory

value - one or more of the following character: a,l,p,s

Returns:

Response object

Throws:

Exception - invalid value character sequence specified