org.eclipse.rse.services.files
Interface IHostFilePermissions

All Known Implementing Classes:

HostFilePermissions

public interface IHostFilePermissions

Interface for file permission and ownership support in RSE IFileService. An implementation of an IHostFilePermissions object is expected to be a data storage for permission and ownership information.

Since:

3.0

Field Summary

static int	PERM_ANY_EXECUTE
static int	PERM_ANY_READ
static int	PERM_ANY_WRITE
static int	PERM_GROUP_EXECUTE Permission constant indicating that the group can execute this file
static int	PERM_GROUP_READ Permission constant indicating that the group can read this file
static int	PERM_GROUP_WRITE Permission constant indicating that the group can write to this file
static int	PERM_OTHER_EXECUTE Permission constant indicating that other users can execute to this file
static int	PERM_OTHER_READ Permission constant indicating that other users can read this file
static int	PERM_OTHER_WRITE Permission constant indicating that other users can write to this file
static int	PERM_USER_EXECUTE Permission constant indicating that the user can execute this file
static int	PERM_USER_READ Permission constant indicating that the user can read this file
static int	PERM_USER_WRITE Permission constant indicating that the user can write to this file

Method Summary

Object	clone() Creates and returns a copy of this object, as specified by the Object.clone() contract.
String	getGroupOwner() returns the group owner of the file
boolean	getPermission(int bitmask) Test if any of the permission bits from the bitmask are set.
int	getPermissionBits() Get the set of permission bits.
String	getUserOwner() returns the user owner of the file
void	setGroupOwner(String group) Sets the group owner attribute
void	setPermission(int bitmask, boolean value) Set or reset all the permission bits from the given bitmask.
void	setPermissionBits(int bits) Set the permission bits
void	setUserOwner(String user) Sets the user owner attribute
String	toAlphaString() return permissions in rwxrwxrwx form

Field Detail

PERM_USER_READ

public static final int PERM_USER_READ

Permission constant indicating that the user can read this file

See Also:

Constant Field Values

PERM_USER_WRITE

public static final int PERM_USER_WRITE

Permission constant indicating that the user can write to this file

See Also:

Constant Field Values

PERM_USER_EXECUTE

public static final int PERM_USER_EXECUTE

Permission constant indicating that the user can execute this file

See Also:

Constant Field Values

PERM_GROUP_READ

public static final int PERM_GROUP_READ

Permission constant indicating that the group can read this file

See Also:

Constant Field Values

PERM_GROUP_WRITE

public static final int PERM_GROUP_WRITE

Permission constant indicating that the group can write to this file

See Also:

Constant Field Values

PERM_GROUP_EXECUTE

public static final int PERM_GROUP_EXECUTE

Permission constant indicating that the group can execute this file

See Also:

Constant Field Values

PERM_OTHER_READ

public static final int PERM_OTHER_READ

Permission constant indicating that other users can read this file

See Also:

Constant Field Values

PERM_OTHER_WRITE

public static final int PERM_OTHER_WRITE

Permission constant indicating that other users can write to this file

See Also:

Constant Field Values

PERM_OTHER_EXECUTE

public static final int PERM_OTHER_EXECUTE

Permission constant indicating that other users can execute to this file

See Also:

Constant Field Values

PERM_ANY_READ

public static final int PERM_ANY_READ

See Also:

Constant Field Values

PERM_ANY_WRITE

public static final int PERM_ANY_WRITE

See Also:

Constant Field Values

PERM_ANY_EXECUTE

public static final int PERM_ANY_EXECUTE

See Also:

Constant Field Values

Method Detail

setPermission

public void setPermission(int bitmask,
                          boolean value)

Set or reset all the permission bits from the given bitmask.

Parameters:

bitmask - the permission(s) bits to modify

value - whether to turn on off of the permission(s) Example: setPermission(PERM_USER_WRITE | PERM_GROUP_WRITE, true);

getPermission

public boolean getPermission(int bitmask)

Test if any of the permission bits from the bitmask are set.

Parameters:

bitmask - the permission(s) to check for

Returns:

true if one of the permission bits is set Example: getPermission(PERM_USER_WRITE | PERM_GROUP_WRITE)

getPermissionBits

public int getPermissionBits()

Get the set of permission bits.

Returns:

set of permission bits

setPermissionBits

public void setPermissionBits(int bits)

Set the permission bits

Parameters:

bits - the set of permission bits

toAlphaString

public String toAlphaString()

return permissions in rwxrwxrwx form

getUserOwner

public String getUserOwner()

returns the user owner of the file

Returns:

the user owner

getGroupOwner

public String getGroupOwner()

returns the group owner of the file

Returns:

the group owner

setUserOwner

public void setUserOwner(String user)

Sets the user owner attribute

Parameters:

user - the user owner attribute

setGroupOwner

public void setGroupOwner(String group)

Sets the group owner attribute

Parameters:

group - the group owner attribute

clone

public Object clone()
             throws CloneNotSupportedException

Creates and returns a copy of this object, as specified by the Object.clone() contract. Each implementer of the IHostFilePermission API must properly implement this method and implement the Cloneable interface.

Returns:

the cloned object

Throws:

CloneNotSupportedException - if an instance cannot be cloned for any reason, e.g. because its state contains complex objects that cannot be cloned.

See Also:

Object.clone()