com.novell.admin.ns

Interface NSFileRights

public interface NSFileRights

This interface represents file rights.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TRUSTEE_ACCESSCONTROL This bit is set if the trustee has access control rights to the file, or access control rights in the directory.
static int	TRUSTEE_CREATE This bit is set if the trustee has create rights to the file, or create rights in the corresponding directory.
static int	TRUSTEE_DELETE This bit is set if the trustee can delete the file or directory.
static int	TRUSTEE_MODIFY This bit is set if the trustee can modify the status flags of the corresponding file, or modify the status flags of files in the corresponding directory.
static short	TRUSTEE_NONE This constant represents a trustee right value with no rights set.
static int	TRUSTEE_READ This bit is set if the trustee can read the file, or read files in the corresponding directory.
static int	TRUSTEE_SEARCH This bit is set for file scan abilities.
static int	TRUSTEE_SUPERVISOR This bit is set if the trustee has supervisor rights to the corresponding file, or supervisor rights to the corresponding directory and its sub-files.
static int	TRUSTEE_WRITE This bit is set if the trustee can write to the file, or write to files in the corresponding directory.

Method Summary

Modifier and Type	Method and Description
int	addRights(int addRights) Adds the specified addRights to the current rights.
int	getRights() Returns all the rights an object has.
boolean	hasRights(int checkRights) Determines if current rights include all of the specified checkRights.
int	removeRights(int removeRights) Remove the specified removeRights from the current rights.
void	setRights(int newRights) Sets all the rights.

Field Detail

TRUSTEE_NONE

static final short TRUSTEE_NONE

This constant represents a trustee right value with no rights set.

See Also:

Constant Field Values

TRUSTEE_READ

static final int TRUSTEE_READ

This bit is set if the trustee can read the file, or read files in the corresponding directory.

See Also:

Constant Field Values

TRUSTEE_WRITE

static final int TRUSTEE_WRITE

This bit is set if the trustee can write to the file, or write to files in the corresponding directory.

See Also:

Constant Field Values

TRUSTEE_CREATE

static final int TRUSTEE_CREATE

This bit is set if the trustee has create rights to the file, or create rights in the corresponding directory.

See Also:

Constant Field Values

TRUSTEE_DELETE

static final int TRUSTEE_DELETE

This bit is set if the trustee can delete the file or directory. If the right is to a directory, the trustee can delete files in the directory.

See Also:

Constant Field Values

TRUSTEE_ACCESSCONTROL

static final int TRUSTEE_ACCESSCONTROL

This bit is set if the trustee has access control rights to the file, or access control rights in the directory. Access Control or "Parental" rights include the ability to add, modify, and remove trustees associated with the corresponding file or directory, including its sub-directories. This also includes the ability to create and delete the file or to create and delete sub-directories.

See Also:

Constant Field Values

TRUSTEE_SEARCH

static final int TRUSTEE_SEARCH

This bit is set for file scan abilities. It is set if the trustee can search (File Scan) the corresponding file or directory. If the right is to a directory, this bit allows the trustee to search or scan for all files in the directory.

See Also:

Constant Field Values

TRUSTEE_MODIFY

static final int TRUSTEE_MODIFY

This bit is set if the trustee can modify the status flags of the corresponding file, or modify the status flags of files in the corresponding directory. In addition, this bit gives the trustee the right to rename the file or directory and its sub-files.

See Also:

Constant Field Values

TRUSTEE_SUPERVISOR

static final int TRUSTEE_SUPERVISOR

This bit is set if the trustee has supervisor rights to the corresponding file, or supervisor rights to the corresponding directory and its sub-files.

See Also:

Constant Field Values

Method Detail

getRights

int getRights()
       throws SPIException

Returns all the rights an object has.

Returns:

The object rights.

Throws:

SPIException

setRights

void setRights(int newRights)
        throws SPIException

Sets all the rights. Any current rights are replaced.

Parameters:

newRights - - bit mask of the current privileges Example: (TRUSTEE_READ | TRUSTEE_WRITE | TRUSTEE_CREATE)

Throws:

SPIException

hasRights

boolean hasRights(int checkRights)
           throws SPIException

Determines if current rights include all of the specified checkRights.

Parameters:

checkRights - - the rights to check for - multiple rights may be or'ed together Example: (TRUSTEE_READ | TRUSTEE_WRITE)

Returns:

True if the object has all specified rights, false otherwise.

Throws:

SPIException

addRights

int addRights(int addRights)
       throws SPIException

Adds the specified addRights to the current rights.

Parameters:

addRights - - the rights to add to the current rights - multiple rights may be or'ed together Example: (TRUSTEE_READ | TRUSTEE_WRITE)

Returns:

the new current rights with addRights added.

Throws:

SPIException

removeRights

int removeRights(int removeRights)
          throws SPIException

Remove the specified removeRights from the current rights.

Parameters:

removeRights - - the rights to remove from current rights - multiple rights may be or'ed together Example: (TRUSTEE_READ | TRUSTEE_WRITE)

Returns:

the new current rights with removeRights removed.

Throws:

SPIException