com.novell.admin.ns

Interface NSFileNamespace

public interface NSFileNamespace

A simple namespace interface for limited Netware File System access

Method Summary

Modifier and Type	Method and Description
void	addNSFileTrustee(ObjectEntry volumeOE, NSFileObject fileObject, NSFileTrustee trusteeObject, int retryCount) Adds a Trustee for a File System object.
void	createNSFileObject(ObjectEntry volumeOE, NSFileObject fileObject) Creates a File or Directory
void	deleteNSFileObject(ObjectEntry volumeOE, NSFileObject fileObject) Delete a File or Directory
void	deleteNSFileTrustee(ObjectEntry volumeOE, NSFileObject fileObject, java.lang.String trusteeName) Deletes a Trustee for a File System object.
NSFileObject[]	getNSFileChildren(ObjectEntry volumeOE, NSFileObject dirObject) Get all the subordinate objects in a Directory
NSFileObject[]	getNSFileChildren(ObjectEntry volumeOE, NSFileObject dirObject, java.lang.String namePattern) Gets the subordinate objects in a Directory based upon a name pattern
void	getNSFileObjectType(ObjectEntry volumeOE, NSFileObject fileObject) Determine the type of the NSFileObject.
void	getNSFileObjectTypes(ObjectEntry volumeOE, NSFileObject[] nsfileobjectearr) Determine the type of the NSFileObject in the specified array.
void	getNSFileTrustee(ObjectEntry volumeOE, NSFileObject fileObject, java.lang.String trusteeName) Gets a single Trustee and assigned rights or all Trustee's and their assigned rights from the file system.
void	getNSFileTrustees(ObjectEntry volumeOE, NSFileObject fileObject) Gets all of the NSFileObject's Trustees and their assigned rights from the file system.
NSFileRights	getTrusteeNSFileEffectiveRights(ObjectEntry volumeOE, java.lang.String trusteeName, NSFileObject fileObject) Gets the Trustee's effective rights for a NSFileObject
NSFileObject[]	getTrusteeNSFileList(ObjectEntry volumeOE, java.lang.String trusteeName, boolean determineTrusteeRights, boolean determineFileType) Get a list of files and directories the trustee has explicit rights to
NSFileObject	newNSFileObject(java.lang.String name) Get a new NSFileObject
NSFileObject	newNSFileObject(java.lang.String name, int type) Get a new NSFileObject for a file or directory
NSFileRights	newNSFileRights(int fileRights) Get a new NSFileRights object with the provided rights.
NSFileRights	newNSFileRights(ObjectAttribute rightsAttr) Get the NSFileRights represented by the raw value contained in the ObjectAttribute.
NSFileTrustee	newNSFileTrustee(java.lang.String trusteeName, NSFileRights fileRights) Get a new NSFileTrustee with associated rights
void	setTrusteeRestriction(ObjectEntry objEntry, ObjectEntry trusteeOE, int limit) Modifies a File System volume by assigning a trustee with restrictions to it

Method Detail

newNSFileObject

NSFileObject newNSFileObject(java.lang.String name)
                      throws SPIException

Get a new NSFileObject

Parameters:

name - The file name. The type of NSFileObject is unspecified. For Netware File system both "/" and "\" are considered valid and there is no preceeding or trailing slashes. If any preceeding or trailing slashes exist, they will be removed. Example: "dir3/dir2/dir1/dirname" or "dir3\dir2\dir1\filename"

Returns:

the newly created NSFileObject object

Throws:

SPIException

newNSFileObject

NSFileObject newNSFileObject(java.lang.String name,
                             int type)
                      throws SPIException

Get a new NSFileObject for a file or directory

Parameters:

name - The file name. The type of NSFileObject is unspecified. For Netware File system both "/" and "\" are considered valid and there is no preceeding or trailing slashes. If any preceeding or trailing slashes exist, they will be removed. Example: "dir3/dir2/dir1/dirname" or "dir3\dir2\dir1\filename"

type - NSFileObject.TYPE_FILE, TYPE_DIRECTORY, TYPE_UNSPECIFIED, or TYPE_NOTEXIST if an unknown type is passed it will be changed to TYPE_UNSPECIFIED

Returns:

the newly created NSFileObject object

Throws:

SPIException

newNSFileRights

NSFileRights newNSFileRights(int fileRights)
                      throws SPIException

Get a new NSFileRights object with the provided rights.

Parameters:

fileRights - - a mask of the NSFileRights rights values. Use 0 if no rights are desired. Example: (NSFileRights.TRUSTEE_READ | NSFileRights.TRUSTEE_WRITE) see NSFileRights for additional values

Returns:

the newly created NSFileRights object

Throws:

SPIException

newNSFileRights

NSFileRights newNSFileRights(ObjectAttribute rightsAttr)
                      throws SPIException

Get the NSFileRights represented by the raw value contained in the ObjectAttribute. For example this may be the "Home Directory Rights" ObjectAttribute from the template object

Parameters:

rightsAttr - - an ObjectAttribute that contains the raw rights value which will be used to create the NSFileRights object.

Returns:

the newly created NSFileRights object

Throws:

SPIException

newNSFileTrustee

NSFileTrustee newNSFileTrustee(java.lang.String trusteeName,
                               NSFileRights fileRights)
                        throws SPIException

Get a new NSFileTrustee with associated rights

Parameters:

trusteeName - - full DN without tree name of the trustee example: "name.provo.novell"

fileRights - - the file rights that is associated with this trustee if "null" then a NSFileRights object with no rights will be created.

Returns:

the newly created NSFileTrustee object

Throws:

SPIException

getTrusteeNSFileList

NSFileObject[] getTrusteeNSFileList(ObjectEntry volumeOE,
                                    java.lang.String trusteeName,
                                    boolean determineTrusteeRights,
                                    boolean determineFileType)
                             throws SPIException

Get a list of files and directories the trustee has explicit rights to

Parameters:

volumeOE - - an NDS object entry for volume of the desired FileSystem

trusteeName - - full DN without tree name of the trustee Example: "name.provo.novell"

determineTrusteeRights - boolean if true it will determine the actual rights the trustee has to the file. Determining the rights is optional and takes longer to execute because it requires additional requests to the file system.

determineFileType - boolean if true it will determine the file type of the file objects that the trustee has explicit rights to. Determining filetype is optional and takes longer to execute because it requires additional requests to the file system. If determinFileType is true, the type of the NSFileObject will be NSFileObject.TYPE_FILE or NSFILEObject.TYPE_DIRECTORY. If determineFileType is false, the type will be NSFileObject.TYPE_UNSPECIFIED. The specific file type may be obtained later using the getNSFileObjectTypes method.

Returns:

an NSFileObject array containing an entry for each item the trustee has rights to. If determineTrusteeRights was set, the NSFileTrustee[] on the file object will contain one and only one entry with the actual rights of the trustee. If determineTrusteeRights was false, the NSFileTrustee[] will be a 0 length array.

Throws:

SPIException

getNSFileObjectType

void getNSFileObjectType(ObjectEntry volumeOE,
                         NSFileObject fileObject)
                  throws SPIException

Determine the type of the NSFileObject. This may also be used to determine if a NSFileObject exists on the file system volume.

Parameters:

volumeOE - - the NDS volume object entry where this file object exists

fileObject - the NSFileObject to determine the type of. The current type of the NSFileObjects is ignored and an underlying API is used to get the current type. The NSFileObject passed as a parameter with have the type field determined. NSFileObject.TYPE_FILE, TYPE_DIRECTORY, or TYPE_NOTEXIST will be returned in the type field. TYPE_NOTEXIST will be set when the specified file(s) cannot be found. Any other type of error will be thrown as an exception.

Throws:

SPIException - for any error except FILENOTFOUND. If FILENOTFOUND then the TYPE_NOTEXIST will be set in the NSFileObject.

getNSFileObjectTypes

void getNSFileObjectTypes(ObjectEntry volumeOE,
                          NSFileObject[] nsfileobjectearr)
                   throws SPIException

Determine the type of the NSFileObject in the specified array. This may also be used to determine if a NSFileObject exists on the file system volume.

Parameters:

volumeOE - - the NDS volume object entry where this file object exists

nsfileobjectearr - an array of 0 or greater length NSFileObjects to determine the type of. The current type of the NSFileObjects is ignored and an underlying API is used to get the current type. The nsfileobjectarray passed as a parameter with have the type field determined. NSFileObject.TYPE_FILE, TYPE_DIRECTORY, or TYPE_NOTEXIST will be returned in the type field. TYPE_NOTEXIST will be set when the specified file(s) cannot be found. Any other type of error will be thrown as an exception.

Throws:

SPIException - for any error except FILENOTFOUND. If FILENOTFOUND then the TYPE_NOTEXIST will be set in the NSFileObject array.

addNSFileTrustee

void addNSFileTrustee(ObjectEntry volumeOE,
                      NSFileObject fileObject,
                      NSFileTrustee trusteeObject,
                      int retryCount)
               throws SPIException

Adds a Trustee for a File System object. The current NSFileObject is not modified.

Parameters:

volumeOE - - the NDS volume object entry where this file object exists

fileObject - - a NSFileObject representing the file or directory. Any NSFileTrustees or attributes on the NSFileObject are ignored.

trusteeObject - - the NSFileTrustee with the associated rights to set

retryCount - - The number of 2 second intervals to sleep and retry if the trustee is not found because of a -601 error. This may be 0 but not negative.

Throws:

SPIException

deleteNSFileTrustee

void deleteNSFileTrustee(ObjectEntry volumeOE,
                         NSFileObject fileObject,
                         java.lang.String trusteeName)
                  throws SPIException

Deletes a Trustee for a File System object. The current NSFileObject is not modified.

Parameters:

volumeOE - - the NDS volume object entry where this file object exists

fileObject - - a NSFileObject representing the file or directory. Any NSFileTrustees or attributes on the NSFileObject are ignored.

trusteeName - - the trustee to delete from this NSFileObject

Throws:

SPIException

createNSFileObject

void createNSFileObject(ObjectEntry volumeOE,
                        NSFileObject fileObject)
                 throws SPIException

Creates a File or Directory

Parameters:

volumeOE - - the volume object entry where to create this file object.

fileObject - - A NSFileObject representing the file or directory. Any NSFileRights on this object is ignored for this call. The rights must be added through addNSFileTrustee()

Throws:

SPIException

deleteNSFileObject

void deleteNSFileObject(ObjectEntry volumeOE,
                        NSFileObject fileObject)
                 throws SPIException

Delete a File or Directory

Parameters:

volumeOE - - the volume object entry where to delete this file object.

fileObject - - A NSFileObject representing the file or directory to delete.

Throws:

SPIException

getNSFileChildren

NSFileObject[] getNSFileChildren(ObjectEntry volumeOE,
                                 NSFileObject dirObject)
                          throws SPIException

Get all the subordinate objects in a Directory

Parameters:

volumeOE - - the volume object entry where to look for the file objects.

dirObject - - A NSFileObject representing the directory to get the subordinate objects of.

Returns:

an NSFileObject array containing an entry for each item in the directory. The type of NSFileObject will be NSFileObject.TYPE_FILE or NSFILEObject.TYPE_DIRECTORY. The NSFileTrustees will not be set.

Throws:

SPIException

getNSFileChildren

NSFileObject[] getNSFileChildren(ObjectEntry volumeOE,
                                 NSFileObject dirObject,
                                 java.lang.String namePattern)
                          throws SPIException

Gets the subordinate objects in a Directory based upon a name pattern

Parameters:

volumeOE - - the volume object entry where to look for the file objects.

dirObject - - A NSFileObject representing the directory to get the subordinate objects of.

namePattern - - a pattern to search for which may include the wildcard characters "*" and "?". Use "*" to search for all subordinate objects. A namePattern of null will also search for all subordinate objects.

Returns:

an NSFileObject array containing an entry for each item in the directory. The type of NSFileObject will be NSFileObject.TYPE_FILE or NSFILEObject.TYPE_DIRECTORY. The NSFileTrustees will not be set.

Throws:

SPIException

getTrusteeNSFileEffectiveRights

NSFileRights getTrusteeNSFileEffectiveRights(ObjectEntry volumeOE,
                                             java.lang.String trusteeName,
                                             NSFileObject fileObject)
                                      throws SPIException

Gets the Trustee's effective rights for a NSFileObject

Parameters:

volumeOE - - the NDS volume object entry where this file object exists

trusteeName - - full DN without tree name of the trustee to set rights for example: "name.provo.novell"

fileObject - - a NSFileObject representing the file or directory to get the effective rights for

Returns:

a NSFileRights object that contains the trustees effective rights. This returns a separate NSFileRights with the effective rights for the trustee. It should not be confused with any NSFileTrustees that may exist on the current NSFileObject.

Throws:

SPIException - may be thrown.

getNSFileTrustees

void getNSFileTrustees(ObjectEntry volumeOE,
                       NSFileObject fileObject)
                throws SPIException

Gets all of the NSFileObject's Trustees and their assigned rights from the file system.

Parameters:

volumeOE - - the NDS volume object entry where this file object exists

fileObject - - a NSFileObject representing the file or directory to get the trustee and assigned rights for This returns all the trustees and assigned rights on the NSFileTrustee[] in the NSFileObject. If there are no trustees, a 0 length NSFileTrustee[] will be placed on the NSFileObject.

Throws:

SPIException - may be thrown.

getNSFileTrustee

void getNSFileTrustee(ObjectEntry volumeOE,
                      NSFileObject fileObject,
                      java.lang.String trusteeName)
               throws SPIException

Gets a single Trustee and assigned rights or all Trustee's and their assigned rights from the file system. The NSFileTrustee[] on the NSFileObject will be modified with the results.

Parameters:

volumeOE - - the NDS volume object entry where this file object exists

fileObject - - a NSFileObject representing the file or directory to get the trustee(s) and assigned rights for.

trusteeName - - full DN without tree name of the trustee to look up assigned rights on this file object for. If "null", all trustees and their assigned rights will be returned. Example: "name.provo.novell" If trusteeName was specified: A NSFileTrustee[] with one and only one NSFileTrustee with the assigned rights will be placed on the NSFileObject. If this specified trustee has no assigned rights to the file, a NSFileTrusteeObject with no assigned rights will be still be created. If trusteeName was "null": This returns all the trustees and assigned rights on the NSFileTrustee[] in the NSFileObject. If there are no trustees, a 0 length NSFileTrustee[] will be placed on the NSFileObject.

Throws:

SPIException - may be thrown.

setTrusteeRestriction

void setTrusteeRestriction(ObjectEntry objEntry,
                           ObjectEntry trusteeOE,
                           int limit)
                    throws SPIException

Modifies a File System volume by assigning a trustee with restrictions to it

Parameters:

objEntry - The File System ObjectEntry - this needs to be Volume object

trusteeOE - The trustee NDS User ObjectEntry

limit - The trustee's disk space limit for the File System volume in 1K blocks. Should be a mulitple of 4 since it sends the number of 4K blocks to JClient.

Throws:

SPIException