RSE
Release 3.4

org.eclipse.rse.services.files
Interface IFilePermissionsService


public interface IFilePermissionsService

Service used to get and set the permissions of a file. The getCapabilities(IHostFile) method must be implemented to tell clients what kinds of permission services are actually available on a concrete implementation.

Since:
3.0

Field Summary
static int FS_CAN_GET_ALL
           
static int FS_CAN_GET_GROUP
           
static int FS_CAN_GET_OWNER
           
static int FS_CAN_GET_PERMISSIONS
           
static int FS_CAN_SET_ALL
           
static int FS_CAN_SET_GROUP
           
static int FS_CAN_SET_OWNER
           
static int FS_CAN_SET_PERMISSIONS
           
 
Method Summary
 int getCapabilities(IHostFile file)
          Returns the capabilities of this file permissions service for the corresponding file.
 IHostFilePermissions getFilePermissions(IHostFile file, IProgressMonitor monitor)
          Gets the permissions for a file including the user and group owner
 void setFilePermissions(IHostFile file, IHostFilePermissions permissions, IProgressMonitor monitor)
          Sets the permissions for a file including the user and group owner as specified in the permissions
 

Field Detail

FS_CAN_GET_OWNER

static final int FS_CAN_GET_OWNER
See Also:
Constant Field Values

FS_CAN_GET_GROUP

static final int FS_CAN_GET_GROUP
See Also:
Constant Field Values

FS_CAN_GET_PERMISSIONS

static final int FS_CAN_GET_PERMISSIONS
See Also:
Constant Field Values

FS_CAN_SET_OWNER

static final int FS_CAN_SET_OWNER
See Also:
Constant Field Values

FS_CAN_SET_GROUP

static final int FS_CAN_SET_GROUP
See Also:
Constant Field Values

FS_CAN_SET_PERMISSIONS

static final int FS_CAN_SET_PERMISSIONS
See Also:
Constant Field Values

FS_CAN_GET_ALL

static final int FS_CAN_GET_ALL
See Also:
Constant Field Values

FS_CAN_SET_ALL

static final int FS_CAN_SET_ALL
See Also:
Constant Field Values
Method Detail

getFilePermissions

IHostFilePermissions getFilePermissions(IHostFile file,
                                        IProgressMonitor monitor)
                                        throws SystemMessageException
Gets the permissions for a file including the user and group owner

Parameters:
file - the remote file
monitor - the monitor for this potentially long running operation
Returns:
the host file permissions
Throws:
SystemMessageException - if an error occurs. Typically this would be one of those in the RemoteFileException family.

setFilePermissions

void setFilePermissions(IHostFile file,
                        IHostFilePermissions permissions,
                        IProgressMonitor monitor)
                        throws SystemMessageException
Sets the permissions for a file including the user and group owner as specified in the permissions

Parameters:
file - the remote file
permissions - the new permissions for this file
monitor - the monitor for this potentially long running operation
Throws:
SystemMessageException - if an error occurs. Typically this would be one of those in the RemoteFileException family.

getCapabilities

int getCapabilities(IHostFile file)
Returns the capabilities of this file permissions service for the corresponding file. If null is specified, this returns the general capabilities of this service.

Parameters:
file - the remote file
Returns:
the capabilities of this service against this file

RSE
Release 3.4

Copyright (c) IBM Corporation and others 2000, 2012. All Rights Reserved.