com.citrix.sharefile.api.entities

Class SFAccessControlsEntity

java.lang.Object

com.citrix.sharefile.api.entities.SFEntitiesBase

com.citrix.sharefile.api.entities.SFAccessControlsEntity

public class SFAccessControlsEntity
extends SFEntitiesBase

Field Summary

Fields inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

client

Constructor Summary

Constructors

Constructor and Description
SFAccessControlsEntity(ISFApiClient client)

Method Summary

Methods

Modifier and Type	Method and Description
ISFQuery	bulkDelete(java.net.URI folderUrl, java.util.ArrayList<java.lang.String> principalIds) Delete multiple access controls ["id1","id2",...]
ISFQuery	bulkDeleteForPrincipal(java.util.ArrayList<java.lang.String> folderIds, java.lang.String principalId) Delete multiple access controls for principal ["id1","id2",...]
ISFQuery<SFAccessControlBulkResult>	bulkSet(java.net.URI url, SFAccessControlsBulkParams bulkParams) Create or Update multiple AccessControls for a given Item { "NotifyUser":true, "NotifyMessage":"msg", "AccessControlParams": [ { "AccessControl": { "Principal" : { "Id":"existing_user_id" }, "CanUpload" : true, "CanDownload" : false, "CanView" : true }, "NotifyUser":false }, { "AccessControl": { "Principal" : { "Id":"group_id" }, "CanUpload" : false, "CanDownload" : true, "CanView" : true }, "Recursive":true }, { "AccessControl": { "Principal" : { "Email":"new_or_existing_user@a.com" }, "CanUpload" : false, "CanDownload" : true, "CanView" : true } } ] } All the AccessControls are created or updated for a single Item identified by the Item id in the URI.
ISFQuery<SFAccessControlBulkResult>	bulkSetForPrincipal(SFAccessControlsBulkParams bulkParams, java.lang.String principalId) Update multiple access controls for a single principal { "NotifyUser":true, "NotifyMessage":"msg", "AccessControlParams": [ { "AccessControl": { "Item": { "Id": "item-id-1" }, "Principal" : { "Id":"existing_user_id" }, "CanUpload" : true, "CanDownload" : false, "CanView" : true }, "NotifyUser":false }, { "AccessControl": { "Item": { "Id": "item-id-3" }, "Principal" : { "Id":"group_id" }, "CanUpload" : false, "CanDownload" : true, "CanView" : true }, "Recursive":true }, { "AccessControl": { "Item": { "Id": "item-id-2" }, "Principal" : { "Email":"new_or_existing_user@a.com" }, "CanUpload" : false, "CanDownload" : true, "CanView" : true } } ] }
ISFQuery<SFAccessControlBulkResult>	clone(SFAccessControlsCloneParams accessControlsCloneParams) Recursively clones multiple access controls for a multiple users { "FolderId":"top-level-folder-id", "UserId":"source-user-id", "CloneUserIds": [ "clone-user-id-1", "clone-user-id-2", "clone-user-id-3" ] }
ISFQuery<SFAccessControl>	createByItem(java.net.URI url, SFAccessControl accessControl) Create AccessControl { "Principal":{"url":"https://account.sf-api.com/v3/Groups(id)"}, "CanUpload":true, "CanDownload":true, "CanView":true, "CanDelete":true, "CanManagePermissions":true, "Message":"Message" } Creates a new Access Controls entry for a given Item.
ISFQuery<SFAccessControl>	createByItem(java.net.URI url, SFAccessControl accessControl, java.lang.Boolean recursive) Create AccessControl { "Principal":{"url":"https://account.sf-api.com/v3/Groups(id)"}, "CanUpload":true, "CanDownload":true, "CanView":true, "CanDelete":true, "CanManagePermissions":true, "Message":"Message" } Creates a new Access Controls entry for a given Item.
ISFQuery<SFAccessControl>	createByItem(java.net.URI url, SFAccessControl accessControl, java.lang.Boolean recursive, java.lang.Boolean sendDefaultNotification) Create AccessControl { "Principal":{"url":"https://account.sf-api.com/v3/Groups(id)"}, "CanUpload":true, "CanDownload":true, "CanView":true, "CanDelete":true, "CanManagePermissions":true, "Message":"Message" } Creates a new Access Controls entry for a given Item.
ISFQuery<SFAccessControl>	createByItem(java.net.URI url, SFAccessControl accessControl, java.lang.Boolean recursive, java.lang.Boolean sendDefaultNotification, java.lang.String message) Create AccessControl { "Principal":{"url":"https://account.sf-api.com/v3/Groups(id)"}, "CanUpload":true, "CanDownload":true, "CanView":true, "CanDelete":true, "CanManagePermissions":true, "Message":"Message" } Creates a new Access Controls entry for a given Item.
ISFQuery	delete(java.net.URI url) Delete AccessControl Deletes an AccessControl entry by itemID and principalID.
ISFQuery<SFAccessControl>	get(java.net.URI url) Get AccessControl by ID Retrieves a single Access Control entry for a given Item and Principal
ISFQuery<SFODataFeed<SFAccessControl>>	getByItem(java.net.URI url) Get AccessControl List By Item Retrieves the Access Control List for a given Item.
ISFQuery	notifyUsers(java.net.URI folderUrl, SFNotifyUsersParams notifyUsersParams) Notify users that they have access to the parent folder [ { UserIds: ["id1", "id2"], CustomMessage: "Message content goes here" } ] All users should have access to the parent folder
ISFQuery<SFAccessControl>	updateByItem(java.net.URI url, SFAccessControl accessControl) Update AccessControl { "Principal":{"Email":"user@domain.com"}, "CanUpload":true, "CanDownload":true, "CanView":true, "CanDelete":true, "CanManagePermissions":true } Updates an existing Access Controls of a given Item.
ISFQuery<SFAccessControl>	updateByItem(java.net.URI url, SFAccessControl accessControl, java.lang.Boolean recursive) Update AccessControl { "Principal":{"Email":"user@domain.com"}, "CanUpload":true, "CanDownload":true, "CanView":true, "CanDelete":true, "CanManagePermissions":true } Updates an existing Access Controls of a given Item.

Methods inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

getEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

SFAccessControlsEntity

public SFAccessControlsEntity(ISFApiClient client)

Method Detail

get

public ISFQuery<SFAccessControl> get(java.net.URI url)
                              throws InvalidOrMissingParameterException

Get AccessControl by ID Retrieves a single Access Control entry for a given Item and Principal

Returns:

A single AccessControl object matching the query

Throws:

InvalidOrMissingParameterException

getByItem

public ISFQuery<SFODataFeed<SFAccessControl>> getByItem(java.net.URI url)
                                                 throws InvalidOrMissingParameterException

Get AccessControl List By Item Retrieves the Access Control List for a given Item.

Parameters:

url -

Returns:

Access Control List of the given object ID.

Throws:

InvalidOrMissingParameterException

createByItem

public ISFQuery<SFAccessControl> createByItem(java.net.URI url,
                                     SFAccessControl accessControl,
                                     java.lang.Boolean recursive,
                                     java.lang.Boolean sendDefaultNotification,
                                     java.lang.String message)
                                       throws InvalidOrMissingParameterException

Create AccessControl { "Principal":{"url":"https://account.sf-api.com/v3/Groups(id)"}, "CanUpload":true, "CanDownload":true, "CanView":true, "CanDelete":true, "CanManagePermissions":true, "Message":"Message" } Creates a new Access Controls entry for a given Item. Access controls can only define a single Principal, which can be either a Group or User. The 'Principal' element is specified as an object - you should populate either the URL or the ID reference.

Parameters:

url -

accessControl -

recursive - (default: false)

message - (default: null)

sendDefaultNotification - (default: false)

Returns:

the created or modified AccessControl instance

Throws:

InvalidOrMissingParameterException

createByItem

public ISFQuery<SFAccessControl> createByItem(java.net.URI url,
                                     SFAccessControl accessControl,
                                     java.lang.Boolean recursive,
                                     java.lang.Boolean sendDefaultNotification)
                                       throws InvalidOrMissingParameterException

Create AccessControl { "Principal":{"url":"https://account.sf-api.com/v3/Groups(id)"}, "CanUpload":true, "CanDownload":true, "CanView":true, "CanDelete":true, "CanManagePermissions":true, "Message":"Message" } Creates a new Access Controls entry for a given Item. Access controls can only define a single Principal, which can be either a Group or User. The 'Principal' element is specified as an object - you should populate either the URL or the ID reference.

Parameters:

url -

accessControl -

recursive - (default: false)

sendDefaultNotification - (default: false)

Returns:

the created or modified AccessControl instance

Throws:

InvalidOrMissingParameterException

createByItem

public ISFQuery<SFAccessControl> createByItem(java.net.URI url,
                                     SFAccessControl accessControl,
                                     java.lang.Boolean recursive)
                                       throws InvalidOrMissingParameterException

Create AccessControl { "Principal":{"url":"https://account.sf-api.com/v3/Groups(id)"}, "CanUpload":true, "CanDownload":true, "CanView":true, "CanDelete":true, "CanManagePermissions":true, "Message":"Message" } Creates a new Access Controls entry for a given Item. Access controls can only define a single Principal, which can be either a Group or User. The 'Principal' element is specified as an object - you should populate either the URL or the ID reference.

Parameters:

url -

accessControl -

recursive - (default: false)

Returns:

the created or modified AccessControl instance

Throws:

InvalidOrMissingParameterException

createByItem

public ISFQuery<SFAccessControl> createByItem(java.net.URI url,
                                     SFAccessControl accessControl)
                                       throws InvalidOrMissingParameterException

Create AccessControl { "Principal":{"url":"https://account.sf-api.com/v3/Groups(id)"}, "CanUpload":true, "CanDownload":true, "CanView":true, "CanDelete":true, "CanManagePermissions":true, "Message":"Message" } Creates a new Access Controls entry for a given Item. Access controls can only define a single Principal, which can be either a Group or User. The 'Principal' element is specified as an object - you should populate either the URL or the ID reference.

Parameters:

url -

accessControl -

Returns:

the created or modified AccessControl instance

Throws:

InvalidOrMissingParameterException

updateByItem

public ISFQuery<SFAccessControl> updateByItem(java.net.URI url,
                                     SFAccessControl accessControl,
                                     java.lang.Boolean recursive)
                                       throws InvalidOrMissingParameterException

Update AccessControl { "Principal":{"Email":"user@domain.com"}, "CanUpload":true, "CanDownload":true, "CanView":true, "CanDelete":true, "CanManagePermissions":true } Updates an existing Access Controls of a given Item. The Principal element cannot be modified, it is provided in the Body to identity the AccessControl element to be modified. You can provide an ID, Email or URL on the Principal object.

Parameters:

url -

accessControl -

recursive - (default: false)

Returns:

the created or modified AccessControl instance

Throws:

InvalidOrMissingParameterException

updateByItem

public ISFQuery<SFAccessControl> updateByItem(java.net.URI url,
                                     SFAccessControl accessControl)
                                       throws InvalidOrMissingParameterException

Update AccessControl { "Principal":{"Email":"user@domain.com"}, "CanUpload":true, "CanDownload":true, "CanView":true, "CanDelete":true, "CanManagePermissions":true } Updates an existing Access Controls of a given Item. The Principal element cannot be modified, it is provided in the Body to identity the AccessControl element to be modified. You can provide an ID, Email or URL on the Principal object.

Parameters:

url -

accessControl -

Returns:

the created or modified AccessControl instance

Throws:

InvalidOrMissingParameterException

delete

public ISFQuery delete(java.net.URI url)
                throws InvalidOrMissingParameterException

Delete AccessControl Deletes an AccessControl entry by itemID and principalID. This method does not return any object, a 204 (No Content) response indicates success.

Throws:

InvalidOrMissingParameterException

bulkSet

public ISFQuery<SFAccessControlBulkResult> bulkSet(java.net.URI url,
                                          SFAccessControlsBulkParams bulkParams)
                                            throws InvalidOrMissingParameterException

Create or Update multiple AccessControls for a given Item { "NotifyUser":true, "NotifyMessage":"msg", "AccessControlParams": [ { "AccessControl": { "Principal" : { "Id":"existing_user_id" }, "CanUpload" : true, "CanDownload" : false, "CanView" : true }, "NotifyUser":false }, { "AccessControl": { "Principal" : { "Id":"group_id" }, "CanUpload" : false, "CanDownload" : true, "CanView" : true }, "Recursive":true }, { "AccessControl": { "Principal" : { "Email":"new_or_existing_user@a.com" }, "CanUpload" : false, "CanDownload" : true, "CanView" : true } } ] } All the AccessControls are created or updated for a single Item identified by the Item id in the URI. AccessControl.Item Ids are not allowed. If an AccessControl doesn't specify NotifyUser or NotifyMessage property their values are inherited from the corresponding top-level properties. The Principal can be identified by Id or Email (Users). If a User with the specified email does not exist it will be created. Defaults for NotifyUser and Recursive are false. See AccessControlsBulkParams for other details.

Parameters:

url -

bulkParams -

Returns:

AccessControlBulkResult

Throws:

InvalidOrMissingParameterException

bulkSetForPrincipal

public ISFQuery<SFAccessControlBulkResult> bulkSetForPrincipal(SFAccessControlsBulkParams bulkParams,
                                                      java.lang.String principalId)
                                                        throws InvalidOrMissingParameterException

Update multiple access controls for a single principal { "NotifyUser":true, "NotifyMessage":"msg", "AccessControlParams": [ { "AccessControl": { "Item": { "Id": "item-id-1" }, "Principal" : { "Id":"existing_user_id" }, "CanUpload" : true, "CanDownload" : false, "CanView" : true }, "NotifyUser":false }, { "AccessControl": { "Item": { "Id": "item-id-3" }, "Principal" : { "Id":"group_id" }, "CanUpload" : false, "CanDownload" : true, "CanView" : true }, "Recursive":true }, { "AccessControl": { "Item": { "Id": "item-id-2" }, "Principal" : { "Email":"new_or_existing_user@a.com" }, "CanUpload" : false, "CanDownload" : true, "CanView" : true } } ] }

Parameters:

principalId -

bulkParams -

Returns:

AccessControlBulkResult

Throws:

InvalidOrMissingParameterException

clone

public ISFQuery<SFAccessControlBulkResult> clone(SFAccessControlsCloneParams accessControlsCloneParams)
                                          throws InvalidOrMissingParameterException

Recursively clones multiple access controls for a multiple users { "FolderId":"top-level-folder-id", "UserId":"source-user-id", "CloneUserIds": [ "clone-user-id-1", "clone-user-id-2", "clone-user-id-3" ] }

Parameters:

accessControlsCloneParams -

Returns:

Cloned access controls

Throws:

InvalidOrMissingParameterException

bulkDelete

public ISFQuery bulkDelete(java.net.URI folderUrl,
                  java.util.ArrayList<java.lang.String> principalIds)
                    throws InvalidOrMissingParameterException

Delete multiple access controls ["id1","id2",...]

Parameters:

folderUrl -

principalIds -

Throws:

InvalidOrMissingParameterException

bulkDeleteForPrincipal

public ISFQuery bulkDeleteForPrincipal(java.util.ArrayList<java.lang.String> folderIds,
                              java.lang.String principalId)
                                throws InvalidOrMissingParameterException

Delete multiple access controls for principal ["id1","id2",...]

Parameters:

principalId -

folderIds -

Throws:

InvalidOrMissingParameterException

notifyUsers

public ISFQuery notifyUsers(java.net.URI folderUrl,
                   SFNotifyUsersParams notifyUsersParams)
                     throws InvalidOrMissingParameterException

Notify users that they have access to the parent folder [ { UserIds: ["id1", "id2"], CustomMessage: "Message content goes here" } ] All users should have access to the parent folder

Parameters:

folderUrl -

notifyUsersParams -

Throws:

InvalidOrMissingParameterException