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

Class UssSetAcl

java.lang.Object

zowe.client.sdk.zosfiles.uss.methods.UssSetAcl

public class UssSetAcl
extends Object

Provides Unix System Services (USS) setfacl functionality

z/OSMF REST API

Version:

2.0

Author:

James Kostrewski

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Response	delete(String targetPath, String value)	Deletes the specified ACL entry from the file or directory
Response	deleteByType(String targetPath, DeleteAclType deleteType)	Delete all extended ACL entries by type (setfacl -D type):
Response	modify(String targetPath, String value)	Modifies the specified ACL entry for the file or directory
Response	set(String targetPath, String value)	Sets the ACL for a USS file or directory
Response	setAclCommon(String targetPath, SetAclParams params)	Sets the ACL for a USS file or directory request driven by SetAclParams object settings

Methods inherited from class java.lang.Object

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

Constructor Detail

UssSetAcl

public UssSetAcl(ZosConnection connection)

UssSetAcl Constructor

Parameters:

connection - connection information, see ZosConnection object

UssSetAcl

public UssSetAcl(ZosConnection connection,
                 ZosmfRequest request)

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

set

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

Sets the ACL for a USS file or directory

Parameters:

targetPath - target path of the file or directory

value - sets the extended ACL entries that are specified by 'entries'

Returns:

Response object

Throws:

ZosmfRequestException - request error state

modify

public Response modify(String targetPath,
                       String value)
                throws ZosmfRequestException

Modifies the specified ACL entry for the file or directory

Parameters:

targetPath - target path of the file or directory

value - modifies the extended ACL entries that are specified by 'entries'

Returns:

Response object

Throws:

ZosmfRequestException - request error state

delete

public Response delete(String targetPath,
                       String value)
                throws ZosmfRequestException

Deletes the specified ACL entry from the file or directory

Parameters:

targetPath - target path of the file or directory

value - deletes the extended ACL entries that are specified by 'entries'

Returns:

Response object

Throws:

ZosmfRequestException - request error state

deleteByType

public Response deleteByType(String targetPath,
                             DeleteAclType deleteType)
                      throws ZosmfRequestException

Delete all extended ACL entries by type (setfacl -D type):

Parameters:

targetPath - target path of the file or directory

deleteType - deletes the extended ACL entries that are specified by type

Returns:

Response object

Throws:

ZosmfRequestException - request error state

setAclCommon

public Response setAclCommon(String targetPath,
                             SetAclParams params)
                      throws ZosmfRequestException

Sets the ACL for a USS file or directory request driven by SetAclParams object settings

Parameters:

targetPath - target path of the file or directory

params - SetAclParams object to drive the request

Returns:

Response object

Throws:

ZosmfRequestException - request error state