org.ogf.saga.namespace
Interface NSDirectory

All Superinterfaces:

Async, Cloneable, Iterable<URL>, NSEntry, Permissions<NSEntry>, SagaObject

All Known Subinterfaces:

Directory, LogicalDirectory

public interface NSDirectory
extends NSEntry, Iterable<URL>

Represents a namespace entry that is a directory, and defines additional methods for them. This interface extends Iterable, which allows an application to iterate over the entries in this directory. Implementations can use getNumEntries() and getEntry(int) to implement an iterator, but will have to encapsulate the exceptions that these methods can throw in either a RuntimeException or a Error.

Field Summary

Fields inherited from interface org.ogf.saga.SagaObject

NO_WAIT, WAIT_FOREVER

Method Summary

Task<NSDirectory,Void>	changeDir(TaskMode mode, URL dir) Creates a task that changes the working directory.
void	changeDir(URL dir) Changes the working directory.
void	copy(String source, URL target) Copies the source entry to another part of the namespace.
void	copy(String source, URL target, int flags) Copies the source entry to another part of the namespace.
Task<NSDirectory,Void>	copy(TaskMode mode, String source, URL target) Creates a task that copies the source entry to another part of the namespace.
Task<NSDirectory,Void>	copy(TaskMode mode, String source, URL target, int flags) Creates a task that copies the source entry to another part of the namespace.
Task<NSDirectory,Void>	copy(TaskMode mode, URL source, URL target) Creates a task that copies source the entry to another part of the namespace.
Task<NSDirectory,Void>	copy(TaskMode mode, URL source, URL target, int flags) Creates a task that copies source the entry to another part of the namespace.
void	copy(URL source, URL target) Copies the source entry to another part of the namespace.
void	copy(URL source, URL target, int flags) Copies the source entry to another part of the namespace.
Task<NSDirectory,Boolean>	exists(TaskMode mode, URL name) Creates a task that queries for the existence of an entry.
boolean	exists(URL name) Queries for the existence of an entry.
List<URL>	find(String pattern) Finds entries in the directory and below that match the specified pattern.
List<URL>	find(String pattern, int flags) Finds entries in the directory and below that match the specified pattern.
Task<NSDirectory,List<URL>>	find(TaskMode mode, String pattern) Creates a task that finds entries in the directory and below that match the specified pattern.
Task<NSDirectory,List<URL>>	find(TaskMode mode, String pattern, int flags) Creates a task that finds entries in the directory and below that match the specified pattern.
URL	getEntry(int entry) Gives the name of an entry in the directory based upon the enumeration defined by getNumEntries().
Task<NSDirectory,URL>	getEntry(TaskMode mode, int entry) Creates a task that gives the name of an entry in the directory based upon the enumeration defined by getNumEntries().
Task<NSDirectory,Long>	getMTime(TaskMode mode, URL name) Creates a task that determines the last modification time of the specified name.
long	getMTime(URL name) Returns the time of the last modification in seconds since epoch (01.01.1970) of the specified name.
int	getNumEntries() Obtains the number of entries in this directory.
Task<NSDirectory,Integer>	getNumEntries(TaskMode mode) Creates a task that obtains the number of entries in this directory.
Task<NSDirectory,Boolean>	isDir(TaskMode mode, URL name) Creates a task that tests the name for being a directory.
boolean	isDir(URL name) Tests the name for being a directory.
Task<NSDirectory,Boolean>	isEntry(TaskMode mode, URL name) Creates a task that tests the name for being a namespace entry.
boolean	isEntry(URL name) Tests the name for being a namespace entry.
Task<NSDirectory,Boolean>	isLink(TaskMode mode, URL name) Creates a task that tests the name for being a link.
boolean	isLink(URL name) Tests the name for being a link.
void	link(String source, URL target) Creates a symbolic link from the specified target to the specified source.
void	link(String source, URL target, int flags) Creates a symbolic link from the specified target to the specified source.
Task<NSDirectory,Void>	link(TaskMode mode, String source, URL target) Creates a task that creates a symbolic link from the specified target to the specified source.
Task<NSDirectory,Void>	link(TaskMode mode, String source, URL target, int flags) Creates a task that creates a symbolic link from the specified target to the specified source.
Task<NSDirectory,Void>	link(TaskMode mode, URL source, URL target) Creates a task that creates a symbolic link from the specified target to the specified source.
Task<NSDirectory,Void>	link(TaskMode mode, URL source, URL target, int flags) Creates a task that creates a symbolic link from the specified target to the specified source.
void	link(URL source, URL target) Creates a symbolic link from the specified target to the specified source.
void	link(URL source, URL target, int flags) Creates a symbolic link from the specified target to the specified source.
List<URL>	list() Lists entries in the directory.
List<URL>	list(int flags) Lists entries in the directory.
List<URL>	list(String pattern) Lists entries in the directory that match the specified pattern.
List<URL>	list(String pattern, int flags) Lists entries in the directory that match the specified pattern.
Task<NSDirectory,List<URL>>	list(TaskMode mode) Creates a task that lists entries in the directory.
Task<NSDirectory,List<URL>>	list(TaskMode mode, int flags) Creates a task that lists entries in the directory.
Task<NSDirectory,List<URL>>	list(TaskMode mode, String pattern) Creates a task that lists entries in the directory that match the specified pattern.
Task<NSDirectory,List<URL>>	list(TaskMode mode, String pattern, int flags) Creates a task that lists entries in the directory that match the specified pattern.
Task<NSDirectory,Void>	makeDir(TaskMode mode, URL target) Creates a task that creates a new directory.
Task<NSDirectory,Void>	makeDir(TaskMode mode, URL target, int flags) Creates a task that creates a new directory.
void	makeDir(URL target) Creates a new directory.
void	makeDir(URL target, int flags) Creates a new directory.
void	move(String source, URL target) Renames the specified source to the specified target, or move the specified source to the specified target if the target is a directory.
void	move(String source, URL target, int flags) Renames the specified source to the specified target, or move the specified source to the specified target if the target is a directory.
Task<NSDirectory,Void>	move(TaskMode mode, String source, URL target) Creates a task that renames the specified source to the specified target, or move the specified source to the specified target if the target is a directory.
Task<NSDirectory,Void>	move(TaskMode mode, String source, URL target, int flags) Creates a task that renames the specified source to the specified target, or move the specified source to the specified target if the target is a directory.
Task<NSDirectory,Void>	move(TaskMode mode, URL source, URL target) Creates a task that renames the specified source to the specified target, or move the specified source to the specified target if the target is a directory.
Task<NSDirectory,Void>	move(TaskMode mode, URL source, URL target, int flags) Creates a task that renames the specified source to the specified target, or move the specified source to the specified target if the target is a directory.
void	move(URL source, URL target) Renames the specified source to the specified target, or move the specified source to the specified target if the target is a directory.
void	move(URL source, URL target, int flags) Renames the specified source to the specified target, or move the specified source to the specified target if the target is a directory.
Task<NSDirectory,NSEntry>	open(TaskMode mode, URL name) Creates a task that creates a new NamespaceEntry instance.
Task<NSDirectory,NSEntry>	open(TaskMode mode, URL name, int flags) Creates a task that creates a new NamespaceEntry instance.
NSEntry	open(URL name) Creates a new NamespaceEntry instance.
NSEntry	open(URL name, int flags) Creates a new NamespaceEntry instance.
Task<NSDirectory,NSDirectory>	openDir(TaskMode mode, URL name) Creates a task that creates a new NamespaceDirectory instance.
Task<NSDirectory,NSDirectory>	openDir(TaskMode mode, URL name, int flags) Creates a task that creates a new NamespaceDirectory instance.
NSDirectory	openDir(URL name) Creates a new NamespaceDirectory instance.
NSDirectory	openDir(URL name, int flags) Creates a new NamespaceDirectory instance.
void	permissionsAllow(String target, String id, int permissions) Allows the specified permissions for the specified id.
void	permissionsAllow(String target, String id, int permissions, int flags) Allows the specified permissions for the specified id.
Task<NSDirectory,Void>	permissionsAllow(TaskMode mode, String target, String id, int permissions) Creates a task that enables the specified permissions for the specified id.
Task<NSDirectory,Void>	permissionsAllow(TaskMode mode, String target, String id, int permissions, int flags) Creates a task that enables the specified permissions for the specified id.
Task<NSDirectory,Void>	permissionsAllow(TaskMode mode, URL target, String id, int permissions) Creates a task that enables the specified permissions for the specified id.
Task<NSDirectory,Void>	permissionsAllow(TaskMode mode, URL target, String id, int permissions, int flags) Creates a task that enables the specified permissions for the specified id.
void	permissionsAllow(URL target, String id, int permissions) Allows the specified permissions for the specified id.
void	permissionsAllow(URL target, String id, int permissions, int flags) Allows the specified permissions for the specified id.
void	permissionsDeny(String target, String id, int permissions) Denies the specified permissions for the specified id.
void	permissionsDeny(String target, String id, int permissions, int flags) Denies the specified permissions for the specified id.
Task<NSDirectory,Void>	permissionsDeny(TaskMode mode, String target, String id, int permissions) Creates a task that disables the specified permissions for the specified id.
Task<NSDirectory,Void>	permissionsDeny(TaskMode mode, String target, String id, int permissions, int flags) Creates a task that disables the specified permissions for the specified id.
Task<NSDirectory,Void>	permissionsDeny(TaskMode mode, URL target, String id, int permissions) Creates a task that disables the specified permissions for the specified id.
Task<NSDirectory,Void>	permissionsDeny(TaskMode mode, URL target, String id, int permissions, int flags) Creates a task that disables the specified permissions for the specified id.
void	permissionsDeny(URL target, String id, int permissions) Denies the specified permissions for the specified id.
void	permissionsDeny(URL target, String id, int permissions, int flags) Denies the specified permissions for the specified id.
Task<NSDirectory,URL>	readLink(TaskMode mode, URL name) Creates a task that returns the URL representing the link target.
URL	readLink(URL name) Returns the URL representing the link target.
void	remove(String target) Removes the specified entry.
void	remove(String target, int flags) Removes the specified entry.
Task<NSDirectory,Void>	remove(TaskMode mode, String target) Creates a task that removes the specified entry.
Task<NSDirectory,Void>	remove(TaskMode mode, String target, int flags) Creates a task that removes the specified entry.
Task<NSDirectory,Void>	remove(TaskMode mode, URL target) Creates a task that removes the specified entry.
Task<NSDirectory,Void>	remove(TaskMode mode, URL target, int flags) Creates a task that removes the specified entry.
void	remove(URL target) Removes the specified entry.
void	remove(URL target, int flags) Removes the specified entry.

Methods inherited from interface org.ogf.saga.namespace.NSEntry

close, close, close, close, copy, copy, copy, copy, getCWD, getCWD, getMTime, getMTime, getName, getName, getURL, getURL, isDir, isDir, isEntry, isEntry, isLink, isLink, link, link, link, link, move, move, move, move, permissionsAllow, permissionsAllow, permissionsDeny, permissionsDeny, readLink, readLink, remove, remove, remove, remove

Methods inherited from interface org.ogf.saga.SagaObject

clone, getId, getSession

Methods inherited from interface org.ogf.saga.permissions.Permissions

getGroup, getGroup, getOwner, getOwner, permissionsAllow, permissionsAllow, permissionsCheck, permissionsCheck, permissionsDeny, permissionsDeny

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

changeDir

void changeDir(URL dir)
               throws NotImplementedException,
                      IncorrectURLException,
                      AuthenticationFailedException,
                      AuthorizationFailedException,
                      PermissionDeniedException,
                      BadParameterException,
                      IncorrectStateException,
                      DoesNotExistException,
                      TimeoutException,
                      NoSuccessException

Changes the working directory.

Parameters:

dir - the directory to change to.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

BadParameterException - is thrown when the specified URL contains an invalid directory name.

DoesNotExistException - is thrown when the specified directory does not exist.

IncorrectStateException - is thrown when the NSDirectory is already closed.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

IncorrectURLException - is thrown when an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

list

List<URL> list(String pattern,
               int flags)
               throws NotImplementedException,
                      AuthenticationFailedException,
                      AuthorizationFailedException,
                      PermissionDeniedException,
                      BadParameterException,
                      IncorrectStateException,
                      TimeoutException,
                      NoSuccessException,
                      IncorrectURLException

Lists entries in the directory that match the specified pattern. If the pattern is an empty string, all entries are listed. The only allowed flags are NONE and DEREFERENCE.

Parameters:

pattern - name or pattern to list.

flags - defining the operation modus.

Returns:

the matching entries.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when illegal flags are specified: only NONE and DEREFERENCE are allowed.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown when an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

list

List<URL> list(int flags)
               throws NotImplementedException,
                      AuthenticationFailedException,
                      AuthorizationFailedException,
                      PermissionDeniedException,
                      BadParameterException,
                      IncorrectStateException,
                      TimeoutException,
                      NoSuccessException,
                      IncorrectURLException

Lists entries in the directory. The only allowed flag are NONE and DEREFERENCE.

Parameters:

flags - defining the operation modus.

Returns:

the directory entries.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when illegal flags are specified: only NONE and DEREFERENCE are allowed.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown when an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

list

List<URL> list(String pattern)
               throws NotImplementedException,
                      AuthenticationFailedException,
                      AuthorizationFailedException,
                      PermissionDeniedException,
                      BadParameterException,
                      IncorrectStateException,
                      TimeoutException,
                      NoSuccessException,
                      IncorrectURLException

Lists entries in the directory that match the specified pattern. If the pattern is an empty string, all entries are listed.

Parameters:

pattern - name or pattern to list.

Returns:

the matching entries.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when illegal flags are specified: only NONE and DEREFERENCE are allowed.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown when an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

list

List<URL> list()
               throws NotImplementedException,
                      AuthenticationFailedException,
                      AuthorizationFailedException,
                      PermissionDeniedException,
                      BadParameterException,
                      IncorrectStateException,
                      TimeoutException,
                      NoSuccessException,
                      IncorrectURLException

Lists entries in the directory.

Returns:

the directory entries.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when illegal flags are specified: only NONE and DEREFERENCE are allowed.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown when an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

find

List<URL> find(String pattern,
               int flags)
               throws NotImplementedException,
                      AuthenticationFailedException,
                      AuthorizationFailedException,
                      PermissionDeniedException,
                      BadParameterException,
                      IncorrectStateException,
                      TimeoutException,
                      NoSuccessException

Finds entries in the directory and below that match the specified pattern. If the pattern is an empty string, all entries are listed.

Parameters:

pattern - name or pattern to find.

flags - defining the operation modus.

Returns:

the matching entries.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when illegal flags are specified: only RECURSIVE is allowed.

IncorrectStateException - is thrown when the NSDirectory is already closed.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

find

List<URL> find(String pattern)
               throws NotImplementedException,
                      AuthenticationFailedException,
                      AuthorizationFailedException,
                      PermissionDeniedException,
                      BadParameterException,
                      IncorrectStateException,
                      TimeoutException,
                      NoSuccessException

Finds entries in the directory and below that match the specified pattern. If the pattern is an empty string, all entries are listed.

Parameters:

pattern - name or pattern to find.

Returns:

the matching entries.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when illegal flags are specified: only RECURSIVE is allowed.

IncorrectStateException - is thrown when the NSDirectory is already closed.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

exists

boolean exists(URL name)
               throws NotImplementedException,
                      IncorrectURLException,
                      AuthenticationFailedException,
                      AuthorizationFailedException,
                      PermissionDeniedException,
                      BadParameterException,
                      IncorrectStateException,
                      TimeoutException,
                      NoSuccessException

Queries for the existence of an entry.

Parameters:

name - to be tested for existence.

Returns:

true if the name exists.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URL contains an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown when an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

getMTime

long getMTime(URL name)
              throws NotImplementedException,
                     IncorrectURLException,
                     DoesNotExistException,
                     AuthenticationFailedException,
                     AuthorizationFailedException,
                     PermissionDeniedException,
                     BadParameterException,
                     IncorrectStateException,
                     TimeoutException,
                     NoSuccessException

Returns the time of the last modification in seconds since epoch (01.01.1970) of the specified name.

Parameters:

name - the name of which the last modification time must be returned.

Returns:

the last modification time.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URL contains an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown when an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

DoesNotExistException - is thrown if the specified name does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

isDir

boolean isDir(URL name)
              throws NotImplementedException,
                     IncorrectURLException,
                     DoesNotExistException,
                     AuthenticationFailedException,
                     AuthorizationFailedException,
                     PermissionDeniedException,
                     BadParameterException,
                     IncorrectStateException,
                     TimeoutException,
                     NoSuccessException

Tests the name for being a directory.

Parameters:

name - to be tested.

Returns:

true if the name represents a directory.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URL contains an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown when an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

DoesNotExistException - is thrown if the specified name does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

isEntry

boolean isEntry(URL name)
                throws NotImplementedException,
                       IncorrectURLException,
                       DoesNotExistException,
                       AuthenticationFailedException,
                       AuthorizationFailedException,
                       PermissionDeniedException,
                       BadParameterException,
                       IncorrectStateException,
                       TimeoutException,
                       NoSuccessException

Tests the name for being a namespace entry.

Parameters:

name - to be tested.

Returns:

true if the name represents a non-directory entry.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URL contains an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown when an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

DoesNotExistException - is thrown if the specified name does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

isLink

boolean isLink(URL name)
               throws NotImplementedException,
                      IncorrectURLException,
                      DoesNotExistException,
                      AuthenticationFailedException,
                      AuthorizationFailedException,
                      PermissionDeniedException,
                      BadParameterException,
                      IncorrectStateException,
                      TimeoutException,
                      NoSuccessException

Tests the name for being a link.

Parameters:

name - to be tested.

Returns:

true if the name represents a link.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URL contains an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown when an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

DoesNotExistException - is thrown if the specified name does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

readLink

URL readLink(URL name)
             throws NotImplementedException,
                    IncorrectURLException,
                    DoesNotExistException,
                    AuthenticationFailedException,
                    AuthorizationFailedException,
                    PermissionDeniedException,
                    BadParameterException,
                    IncorrectStateException,
                    TimeoutException,
                    NoSuccessException

Returns the URL representing the link target.

Parameters:

name - the name of the link.

Returns:

the resolved name.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URL contains an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown when an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

DoesNotExistException - is thrown if the specified name does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

getNumEntries

int getNumEntries()
                  throws NotImplementedException,
                         AuthenticationFailedException,
                         AuthorizationFailedException,
                         PermissionDeniedException,
                         IncorrectStateException,
                         TimeoutException,
                         NoSuccessException

Obtains the number of entries in this directory.

Returns:

the number of entries.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

IncorrectStateException - is thrown when the NSDirectory is already closed.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

getEntry

URL getEntry(int entry)
             throws NotImplementedException,
                    AuthenticationFailedException,
                    AuthorizationFailedException,
                    PermissionDeniedException,
                    IncorrectStateException,
                    DoesNotExistException,
                    TimeoutException,
                    NoSuccessException

Gives the name of an entry in the directory based upon the enumeration defined by getNumEntries().

Parameters:

entry - index of the entry to get.

Returns:

the name of the entry.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

IncorrectStateException - is thrown when the NSDirectory is already closed.

DoesNotExistException - is thrown when the index is invalid.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

copy

void copy(URL source,
          URL target,
          int flags)
          throws NotImplementedException,
                 AuthenticationFailedException,
                 AuthorizationFailedException,
                 PermissionDeniedException,
                 IncorrectURLException,
                 BadParameterException,
                 IncorrectStateException,
                 AlreadyExistsException,
                 DoesNotExistException,
                 TimeoutException,
                 NoSuccessException

Copies the source entry to another part of the namespace.

Parameters:

source - name to copy.

target - name to copy to.

flags - defining the operation modus.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URLs contain an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - is thrown if the specified target URL already exists, and the OVERWRITE flag is not given.

DoesNotExistException - is thrown if the source does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

copy

void copy(URL source,
          URL target)
          throws NotImplementedException,
                 AuthenticationFailedException,
                 AuthorizationFailedException,
                 PermissionDeniedException,
                 IncorrectURLException,
                 BadParameterException,
                 IncorrectStateException,
                 AlreadyExistsException,
                 DoesNotExistException,
                 TimeoutException,
                 NoSuccessException

Copies the source entry to another part of the namespace.

Parameters:

source - name to copy.

target - name to copy to.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URLs contain an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - is thrown if the specified target URL already exists, and the OVERWRITE flag is not given.

DoesNotExistException - is thrown if the source does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

copy

void copy(String source,
          URL target,
          int flags)
          throws NotImplementedException,
                 AuthenticationFailedException,
                 AuthorizationFailedException,
                 PermissionDeniedException,
                 IncorrectURLException,
                 BadParameterException,
                 IncorrectStateException,
                 AlreadyExistsException,
                 DoesNotExistException,
                 TimeoutException,
                 NoSuccessException

Copies the source entry to another part of the namespace. The source may contain wildcards.

Parameters:

source - name to copy.

target - name to copy to.

flags - defining the operation modus.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URLs contain an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - is thrown if the specified target URL already exists, and the OVERWRITE flag is not given.

DoesNotExistException - is thrown if the source does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

copy

void copy(String source,
          URL target)
          throws NotImplementedException,
                 AuthenticationFailedException,
                 AuthorizationFailedException,
                 PermissionDeniedException,
                 IncorrectURLException,
                 BadParameterException,
                 IncorrectStateException,
                 AlreadyExistsException,
                 DoesNotExistException,
                 TimeoutException,
                 NoSuccessException

Copies the source entry to another part of the namespace. The source may contain wildcards.

Parameters:

source - name to copy.

target - name to copy to.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URLs contain an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - is thrown if the specified target URL already exists, and the OVERWRITE flag is not given.

DoesNotExistException - is thrown if the source does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

link

void link(URL source,
          URL target,
          int flags)
          throws NotImplementedException,
                 AuthenticationFailedException,
                 AuthorizationFailedException,
                 PermissionDeniedException,
                 IncorrectURLException,
                 BadParameterException,
                 IncorrectStateException,
                 AlreadyExistsException,
                 DoesNotExistException,
                 TimeoutException,
                 NoSuccessException

Creates a symbolic link from the specified target to the specified source.

Parameters:

source - name to link to.

target - name of the link.

flags - defining the operation modus.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URLs contain an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - is thrown if the specified target URL already exists, and the OVERWRITE flag is not given.

DoesNotExistException - is thrown if the source does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

link

void link(URL source,
          URL target)
          throws NotImplementedException,
                 AuthenticationFailedException,
                 AuthorizationFailedException,
                 PermissionDeniedException,
                 IncorrectURLException,
                 BadParameterException,
                 IncorrectStateException,
                 AlreadyExistsException,
                 DoesNotExistException,
                 TimeoutException,
                 NoSuccessException

Creates a symbolic link from the specified target to the specified source.

Parameters:

source - name to link to.

target - name of the link.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URLs contain an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - is thrown if the specified target URL already exists, and the OVERWRITE flag is not given.

DoesNotExistException - is thrown if the source does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

link

void link(String source,
          URL target,
          int flags)
          throws NotImplementedException,
                 AuthenticationFailedException,
                 AuthorizationFailedException,
                 PermissionDeniedException,
                 IncorrectURLException,
                 BadParameterException,
                 IncorrectStateException,
                 AlreadyExistsException,
                 DoesNotExistException,
                 TimeoutException,
                 NoSuccessException

Creates a symbolic link from the specified target to the specified source. The source may contain wildcards.

Parameters:

source - name to link to.

target - name of the link.

flags - defining the operation modus.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URLs contain an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - is thrown if the specified target URL already exists, and the OVERWRITE flag is not given.

DoesNotExistException - is thrown if the source does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

link

void link(String source,
          URL target)
          throws NotImplementedException,
                 AuthenticationFailedException,
                 AuthorizationFailedException,
                 PermissionDeniedException,
                 IncorrectURLException,
                 BadParameterException,
                 IncorrectStateException,
                 AlreadyExistsException,
                 DoesNotExistException,
                 TimeoutException,
                 NoSuccessException

Creates a symbolic link from the specified target to the specified source. The source may contain wildcards.

Parameters:

source - name to link to.

target - name of the link.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URLs contain an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - is thrown if the specified target URL already exists, and the OVERWRITE flag is not given.

DoesNotExistException - is thrown if the source does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

move

void move(URL source,
          URL target,
          int flags)
          throws NotImplementedException,
                 AuthenticationFailedException,
                 AuthorizationFailedException,
                 PermissionDeniedException,
                 IncorrectURLException,
                 BadParameterException,
                 IncorrectStateException,
                 AlreadyExistsException,
                 DoesNotExistException,
                 TimeoutException,
                 NoSuccessException

Renames the specified source to the specified target, or move the specified source to the specified target if the target is a directory.

Parameters:

source - name to move.

target - name to move to.

flags - defining the operation modus.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URLs contain an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - is thrown if the specified target URL already exists, and the OVERWRITE flag is not given.

DoesNotExistException - is thrown if the source does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

move

void move(URL source,
          URL target)
          throws NotImplementedException,
                 AuthenticationFailedException,
                 AuthorizationFailedException,
                 PermissionDeniedException,
                 IncorrectURLException,
                 BadParameterException,
                 IncorrectStateException,
                 AlreadyExistsException,
                 DoesNotExistException,
                 TimeoutException,
                 NoSuccessException

Renames the specified source to the specified target, or move the specified source to the specified target if the target is a directory.

Parameters:

source - name to move.

target - name to move to.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URLs contain an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - is thrown if the specified target URL already exists, and the OVERWRITE flag is not given.

DoesNotExistException - is thrown if the source does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

move

void move(String source,
          URL target,
          int flags)
          throws NotImplementedException,
                 AuthenticationFailedException,
                 AuthorizationFailedException,
                 PermissionDeniedException,
                 IncorrectURLException,
                 BadParameterException,
                 IncorrectStateException,
                 AlreadyExistsException,
                 DoesNotExistException,
                 TimeoutException,
                 NoSuccessException

Renames the specified source to the specified target, or move the specified source to the specified target if the target is a directory. The source may contain wildcards.

Parameters:

source - name to move.

target - name to move to.

flags - defining the operation modus.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URLs contain an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - is thrown if the specified target URL already exists, and the OVERWRITE flag is not given.

DoesNotExistException - is thrown if the source does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

move

void move(String source,
          URL target)
          throws NotImplementedException,
                 AuthenticationFailedException,
                 AuthorizationFailedException,
                 PermissionDeniedException,
                 IncorrectURLException,
                 BadParameterException,
                 IncorrectStateException,
                 AlreadyExistsException,
                 DoesNotExistException,
                 TimeoutException,
                 NoSuccessException

Renames the specified source to the specified target, or move the specified source to the specified target if the target is a directory. The source may contain wildcards.

Parameters:

source - name to move.

target - name to move to.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URLs contain an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - is thrown if the specified target URL already exists, and the OVERWRITE flag is not given.

DoesNotExistException - is thrown if the source does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

remove

void remove(URL target,
            int flags)
            throws NotImplementedException,
                   AuthenticationFailedException,
                   AuthorizationFailedException,
                   PermissionDeniedException,
                   IncorrectURLException,
                   BadParameterException,
                   IncorrectStateException,
                   DoesNotExistException,
                   TimeoutException,
                   NoSuccessException

Removes the specified entry.

Parameters:

target - name to remove.

flags - defining the operation modus.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified name is an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

DoesNotExistException - is thrown if the target does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

remove

void remove(URL target)
            throws NotImplementedException,
                   AuthenticationFailedException,
                   AuthorizationFailedException,
                   PermissionDeniedException,
                   IncorrectURLException,
                   BadParameterException,
                   IncorrectStateException,
                   DoesNotExistException,
                   TimeoutException,
                   NoSuccessException

Removes the specified entry.

Parameters:

target - name to remove.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified name is an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

DoesNotExistException - is thrown if the target does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

remove

void remove(String target,
            int flags)
            throws NotImplementedException,
                   AuthenticationFailedException,
                   AuthorizationFailedException,
                   PermissionDeniedException,
                   IncorrectURLException,
                   BadParameterException,
                   IncorrectStateException,
                   DoesNotExistException,
                   TimeoutException,
                   NoSuccessException

Removes the specified entry. The target string may contain wildcards.

Parameters:

target - name to remove.

flags - defining the operation modus.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified name is an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

DoesNotExistException - is thrown if the target does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

remove

void remove(String target)
            throws NotImplementedException,
                   AuthenticationFailedException,
                   AuthorizationFailedException,
                   PermissionDeniedException,
                   IncorrectURLException,
                   BadParameterException,
                   IncorrectStateException,
                   DoesNotExistException,
                   TimeoutException,
                   NoSuccessException

Removes the specified entry. The target string may contain wildcards.

Parameters:

target - name to remove.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified name is an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

DoesNotExistException - is thrown if the target does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

makeDir

void makeDir(URL target,
             int flags)
             throws NotImplementedException,
                    IncorrectURLException,
                    AuthenticationFailedException,
                    AuthorizationFailedException,
                    PermissionDeniedException,
                    BadParameterException,
                    IncorrectStateException,
                    AlreadyExistsException,
                    DoesNotExistException,
                    TimeoutException,
                    NoSuccessException

Creates a new directory.

Parameters:

target - directory to create.

flags - defining the operation modus.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URL is an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - is thrown if the specified URL already exists, and the EXCLUSIVE flag is given.

DoesNotExistException - is thrown if the parent directory does not exist and the CREATEPARENTS flag is not given.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

makeDir

void makeDir(URL target)
             throws NotImplementedException,
                    IncorrectURLException,
                    AuthenticationFailedException,
                    AuthorizationFailedException,
                    PermissionDeniedException,
                    BadParameterException,
                    IncorrectStateException,
                    AlreadyExistsException,
                    DoesNotExistException,
                    TimeoutException,
                    NoSuccessException

Creates a new directory.

Parameters:

target - directory to create.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URL is an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - is thrown if the specified URL already exists, and the EXCLUSIVE flag is given.

DoesNotExistException - is thrown if the parent directory does not exist and the CREATEPARENTS flag is not given.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

openDir

NSDirectory openDir(URL name,
                    int flags)
                    throws NotImplementedException,
                           IncorrectURLException,
                           AuthenticationFailedException,
                           AuthorizationFailedException,
                           PermissionDeniedException,
                           BadParameterException,
                           IncorrectStateException,
                           AlreadyExistsException,
                           DoesNotExistException,
                           TimeoutException,
                           NoSuccessException

Creates a new NamespaceDirectory instance.

Parameters:

name - directory to open.

flags - defining the operation modus.

Returns:

the opened directory instance.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URL does not point to a directory, or is an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - is thrown if the specified URL already exists, and the CREATE and EXCLUSIVE flags are given.

DoesNotExistException - is thrown if the specified URL does not exist, and the CREATE flag is not given.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

openDir

NSDirectory openDir(URL name)
                    throws NotImplementedException,
                           IncorrectURLException,
                           AuthenticationFailedException,
                           AuthorizationFailedException,
                           PermissionDeniedException,
                           BadParameterException,
                           IncorrectStateException,
                           AlreadyExistsException,
                           DoesNotExistException,
                           TimeoutException,
                           NoSuccessException

Creates a new NamespaceDirectory instance.

Parameters:

name - directory to open.

Returns:

the opened directory instance.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URL does not point to a directory, or is an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - not thrown, but specified because a method may be invoked that can throw this exception, but will not in this case.

DoesNotExistException - is thrown if the specified URL does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

open

NSEntry open(URL name,
             int flags)
             throws NotImplementedException,
                    IncorrectURLException,
                    AuthenticationFailedException,
                    AuthorizationFailedException,
                    PermissionDeniedException,
                    BadParameterException,
                    IncorrectStateException,
                    AlreadyExistsException,
                    DoesNotExistException,
                    TimeoutException,
                    NoSuccessException

Creates a new NamespaceEntry instance.

Parameters:

name - entry to open.

flags - defining the operation modus.

Returns:

the opened entry instance.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URL points to a directory, or is an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - is thrown if the specified URL already exists, and the CREATE and EXCLUSIVE flags are given.

DoesNotExistException - is thrown if the specified URL does not exist, and the CREATE flag is not given.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

open

NSEntry open(URL name)
             throws NotImplementedException,
                    IncorrectURLException,
                    AuthenticationFailedException,
                    AuthorizationFailedException,
                    PermissionDeniedException,
                    BadParameterException,
                    IncorrectStateException,
                    AlreadyExistsException,
                    DoesNotExistException,
                    TimeoutException,
                    NoSuccessException

Creates a new NamespaceEntry instance.

Parameters:

name - entry to open.

Returns:

the opened entry instance.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the specified URL points to a directory, or is an invalid entry name.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

AlreadyExistsException - not thrown, but specified because a method may be invoked that can throw this exception, but will not in this case.

DoesNotExistException - is thrown if the specified URL does not exist.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

permissionsAllow

void permissionsAllow(URL target,
                      String id,
                      int permissions,
                      int flags)
                      throws NotImplementedException,
                             IncorrectURLException,
                             AuthenticationFailedException,
                             AuthorizationFailedException,
                             PermissionDeniedException,
                             IncorrectStateException,
                             BadParameterException,
                             TimeoutException,
                             NoSuccessException

Allows the specified permissions for the specified id. An id of "*" enables the permissions for all.

Parameters:

target - the entry affected.

id - the id.

permissions - the permissions to enable.

flags - the only allowed flags are RECURSIVE and DEREFERENCE.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the given id is unknown or not supported, or illegal flags are specified, or RECURSIVE is specified on a non-directory.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

permissionsAllow

void permissionsAllow(URL target,
                      String id,
                      int permissions)
                      throws NotImplementedException,
                             AuthenticationFailedException,
                             AuthorizationFailedException,
                             PermissionDeniedException,
                             IncorrectURLException,
                             IncorrectStateException,
                             BadParameterException,
                             TimeoutException,
                             NoSuccessException

Allows the specified permissions for the specified id. An id of "*" enables the permissions for all.

Parameters:

target - the entry affected.

id - the id.

permissions - the permissions to enable.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the given id is unknown or not supported.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

permissionsAllow

void permissionsAllow(String target,
                      String id,
                      int permissions,
                      int flags)
                      throws NotImplementedException,
                             IncorrectURLException,
                             AuthenticationFailedException,
                             AuthorizationFailedException,
                             PermissionDeniedException,
                             IncorrectStateException,
                             BadParameterException,
                             TimeoutException,
                             NoSuccessException

Allows the specified permissions for the specified id. An id of "*" enables the permissions for all.

Parameters:

target - the entry affected.

id - the id.

permissions - the permissions to enable.

flags - the only allowed flags are RECURSIVE and DEREFERENCE.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the given id is unknown or not supported, or illegal flags are specified, or RECURSIVE is specified on a non-directory.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

permissionsAllow

void permissionsAllow(String target,
                      String id,
                      int permissions)
                      throws NotImplementedException,
                             AuthenticationFailedException,
                             AuthorizationFailedException,
                             PermissionDeniedException,
                             IncorrectURLException,
                             IncorrectStateException,
                             BadParameterException,
                             TimeoutException,
                             NoSuccessException

Allows the specified permissions for the specified id. An id of "*" enables the permissions for all.

Parameters:

target - the entry affected.

id - the id.

permissions - the permissions to enable.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the given id is unknown or not supported.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

permissionsDeny

void permissionsDeny(URL target,
                     String id,
                     int permissions,
                     int flags)
                     throws NotImplementedException,
                            IncorrectURLException,
                            AuthenticationFailedException,
                            AuthorizationFailedException,
                            PermissionDeniedException,
                            BadParameterException,
                            TimeoutException,
                            NoSuccessException,
                            IncorrectStateException

Denies the specified permissions for the specified id. An id of "*" disables the permissions for all.

Parameters:

target - the entry affected.

id - the id.

permissions - the permissions to disable.

flags - the only allowed flags are RECURSIVE and DEREFERENCE.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the given id is unknown or not supported, or illegal flags are specified, or RECURSIVE is specified on a non-directory.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

permissionsDeny

void permissionsDeny(URL target,
                     String id,
                     int permissions)
                     throws NotImplementedException,
                            AuthenticationFailedException,
                            AuthorizationFailedException,
                            PermissionDeniedException,
                            IncorrectURLException,
                            BadParameterException,
                            TimeoutException,
                            NoSuccessException,
                            IncorrectStateException

Denies the specified permissions for the specified id. An id of "*" disables the permissions for all.

Parameters:

target - the entry affected.

id - the id.

permissions - the permissions to disable.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the given id is unknown or not supported.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

permissionsDeny

void permissionsDeny(String target,
                     String id,
                     int permissions,
                     int flags)
                     throws NotImplementedException,
                            IncorrectURLException,
                            AuthenticationFailedException,
                            AuthorizationFailedException,
                            PermissionDeniedException,
                            BadParameterException,
                            TimeoutException,
                            NoSuccessException,
                            IncorrectStateException

Denies the specified permissions for the specified id. An id of "*" disables the permissions for all.

Parameters:

target - the entry affected.

id - the id.

permissions - the permissions to disable.

flags - the only allowed flags are RECURSIVE and DEREFERENCE.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the given id is unknown or not supported, or illegal flags are specified, or RECURSIVE is specified on a non-directory.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

permissionsDeny

void permissionsDeny(String target,
                     String id,
                     int permissions)
                     throws NotImplementedException,
                            AuthenticationFailedException,
                            IncorrectStateException,
                            AuthorizationFailedException,
                            PermissionDeniedException,
                            IncorrectURLException,
                            BadParameterException,
                            TimeoutException,
                            NoSuccessException

Denies the specified permissions for the specified id. An id of "*" disables the permissions for all.

Parameters:

target - the entry affected.

id - the id.

permissions - the permissions to disable.

Throws:

NotImplementedException - is thrown if the implementation does not provide an implementation of this method.

PermissionDeniedException - is thrown when the method failed because the identity used did not have sufficient permissions to perform the operation successfully.

AuthorizationFailedException - is thrown when none of the available contexts of the used session could be used for successful authorization. This error indicates that the resource could not be accessed at all, and not that an operation was not available due to restricted permissions.

AuthenticationFailedException - is thrown when operation failed because none of the available session contexts could successfully be used for authentication.

TimeoutException - is thrown when a remote operation did not complete successfully because the network communication or the remote service timed out.

BadParameterException - is thrown when the given id is unknown or not supported.

IncorrectStateException - is thrown when the NSDirectory is already closed.

IncorrectURLException - is thrown if an implementation cannot handle the specified protocol, or that access to the specified entity via the given protocol is impossible.

NoSuccessException - is thrown when the operation was not successfully performed, and none of the other exceptions apply.

changeDir

Task<NSDirectory,Void> changeDir(TaskMode mode,
                                 URL dir)
                                 throws NotImplementedException

Creates a task that changes the working directory.

Parameters:

mode - the task mode.

dir - the directory to change to.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

list

Task<NSDirectory,List<URL>> list(TaskMode mode,
                                 String pattern,
                                 int flags)
                                 throws NotImplementedException

Creates a task that lists entries in the directory that match the specified pattern. If the pattern is an empty string, all entries are listed. The only allowed flag is DEREFERENCE.

Parameters:

mode - the task mode.

pattern - name or pattern to list.

flags - defining the operation modus.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

list

Task<NSDirectory,List<URL>> list(TaskMode mode,
                                 String pattern)
                                 throws NotImplementedException

Creates a task that lists entries in the directory that match the specified pattern. If the pattern is an empty string, all entries are listed. The only allowed flag is DEREFERENCE.

Parameters:

mode - the task mode.

pattern - name or pattern to list.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

list

Task<NSDirectory,List<URL>> list(TaskMode mode,
                                 int flags)
                                 throws NotImplementedException

Creates a task that lists entries in the directory. The only allowed flag is DEREFERENCE.

Parameters:

mode - the task mode.

flags - defining the operation modus.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

list

Task<NSDirectory,List<URL>> list(TaskMode mode)
                                 throws NotImplementedException

Creates a task that lists entries in the directory.

Parameters:

mode - the task mode.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

find

Task<NSDirectory,List<URL>> find(TaskMode mode,
                                 String pattern,
                                 int flags)
                                 throws NotImplementedException

Creates a task that finds entries in the directory and below that match the specified pattern. If the pattern is an empty string, all entries are listed.

Parameters:

mode - the task mode.

pattern - name or pattern to find.

flags - defining the operation modus.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

find

Task<NSDirectory,List<URL>> find(TaskMode mode,
                                 String pattern)
                                 throws NotImplementedException

Creates a task that finds entries in the directory and below that match the specified pattern. If the pattern is an empty string, all entries are listed.

Parameters:

mode - the task mode.

pattern - name or pattern to find.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

exists

Task<NSDirectory,Boolean> exists(TaskMode mode,
                                 URL name)
                                 throws NotImplementedException

Creates a task that queries for the existence of an entry.

Parameters:

mode - the task mode.

name - to be tested for existence.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

isDir

Task<NSDirectory,Boolean> isDir(TaskMode mode,
                                URL name)
                                throws NotImplementedException

Creates a task that tests the name for being a directory.

Parameters:

mode - the task mode.

name - to be tested.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

isEntry

Task<NSDirectory,Boolean> isEntry(TaskMode mode,
                                  URL name)
                                  throws NotImplementedException

Creates a task that tests the name for being a namespace entry.

Parameters:

mode - the task mode.

name - to be tested.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

isLink

Task<NSDirectory,Boolean> isLink(TaskMode mode,
                                 URL name)
                                 throws NotImplementedException

Creates a task that tests the name for being a link.

Parameters:

mode - the task mode.

name - to be tested.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

getMTime

Task<NSDirectory,Long> getMTime(TaskMode mode,
                                URL name)
                                throws NotImplementedException

Creates a task that determines the last modification time of the specified name.

Parameters:

mode - the task mode.

name - of which the last modification time must be determined.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

readLink

Task<NSDirectory,URL> readLink(TaskMode mode,
                               URL name)
                               throws NotImplementedException

Creates a task that returns the URL representing the link target.

Parameters:

mode - the task mode.

name - the name of the link.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

getNumEntries

Task<NSDirectory,Integer> getNumEntries(TaskMode mode)
                                        throws NotImplementedException

Creates a task that obtains the number of entries in this directory.

Parameters:

mode - the task mode.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

getEntry

Task<NSDirectory,URL> getEntry(TaskMode mode,
                               int entry)
                               throws NotImplementedException

Creates a task that gives the name of an entry in the directory based upon the enumeration defined by getNumEntries().

Parameters:

mode - the task mode.

entry - index of the entry to get.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

copy

Task<NSDirectory,Void> copy(TaskMode mode,
                            URL source,
                            URL target,
                            int flags)
                            throws NotImplementedException

Creates a task that copies source the entry to another part of the namespace.

Parameters:

mode - the task mode.

source - name to copy.

target - name to copy to.

flags - defining the operation modus.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

copy

Task<NSDirectory,Void> copy(TaskMode mode,
                            URL source,
                            URL target)
                            throws NotImplementedException

Creates a task that copies source the entry to another part of the namespace.

Parameters:

mode - the task mode.

source - name to copy.

target - name to copy to.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

copy

Task<NSDirectory,Void> copy(TaskMode mode,
                            String source,
                            URL target,
                            int flags)
                            throws NotImplementedException

Creates a task that copies the source entry to another part of the namespace. The source may contain wildcards.

Parameters:

mode - the task mode.

source - name to copy.

target - name to copy to.

flags - defining the operation modus.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

copy

Task<NSDirectory,Void> copy(TaskMode mode,
                            String source,
                            URL target)
                            throws NotImplementedException

Creates a task that copies the source entry to another part of the namespace. The source may contain wildcards.

Parameters:

mode - the task mode.

source - name to copy.

target - name to copy to.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

link

Task<NSDirectory,Void> link(TaskMode mode,
                            URL source,
                            URL target,
                            int flags)
                            throws NotImplementedException

Creates a task that creates a symbolic link from the specified target to the specified source.

Parameters:

mode - the task mode.

source - name to link to.

target - name of the link.

flags - defining the operation modus.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

link

Task<NSDirectory,Void> link(TaskMode mode,
                            URL source,
                            URL target)
                            throws NotImplementedException

Creates a task that creates a symbolic link from the specified target to the specified source.

Parameters:

mode - the task mode.

source - name to link to.

target - name of the link.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

link

Task<NSDirectory,Void> link(TaskMode mode,
                            String source,
                            URL target,
                            int flags)
                            throws NotImplementedException

Creates a task that creates a symbolic link from the specified target to the specified source. The source may contain wildcards.

Parameters:

mode - the task mode.

source - name to link to.

target - name of the link.

flags - defining the operation modus.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

link

Task<NSDirectory,Void> link(TaskMode mode,
                            String source,
                            URL target)
                            throws NotImplementedException

Creates a task that creates a symbolic link from the specified target to the specified source. The source may contain wildcards.

Parameters:

mode - the task mode.

source - name to link to.

target - name of the link.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

move

Task<NSDirectory,Void> move(TaskMode mode,
                            URL source,
                            URL target,
                            int flags)
                            throws NotImplementedException

Creates a task that renames the specified source to the specified target, or move the specified source to the specified target if the target is a directory.

Parameters:

mode - the task mode.

source - name to move.

target - name to move to.

flags - defining the operation modus.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

move

Task<NSDirectory,Void> move(TaskMode mode,
                            URL source,
                            URL target)
                            throws NotImplementedException

Creates a task that renames the specified source to the specified target, or move the specified source to the specified target if the target is a directory.

Parameters:

mode - the task mode.

source - name to move.

target - name to move to.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

move

Task<NSDirectory,Void> move(TaskMode mode,
                            String source,
                            URL target,
                            int flags)
                            throws NotImplementedException

Creates a task that renames the specified source to the specified target, or move the specified source to the specified target if the target is a directory. The source may contain wildcards.

Parameters:

mode - the task mode.

source - name to move.

target - name to move to.

flags - defining the operation modus.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

move

Task<NSDirectory,Void> move(TaskMode mode,
                            String source,
                            URL target)
                            throws NotImplementedException

Creates a task that renames the specified source to the specified target, or move the specified source to the specified target if the target is a directory. The source may contain wildcards.

Parameters:

mode - the task mode.

source - name to move.

target - name to move to.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

remove

Task<NSDirectory,Void> remove(TaskMode mode,
                              URL target,
                              int flags)
                              throws NotImplementedException

Creates a task that removes the specified entry.

Parameters:

mode - the task mode.

target - name to remove.

flags - defining the operation modus.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

remove

Task<NSDirectory,Void> remove(TaskMode mode,
                              URL target)
                              throws NotImplementedException

Creates a task that removes the specified entry.

Parameters:

mode - the task mode.

target - name to remove.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

remove

Task<NSDirectory,Void> remove(TaskMode mode,
                              String target,
                              int flags)
                              throws NotImplementedException

Creates a task that removes the specified entry. The target may contain wildcards.

Parameters:

mode - the task mode.

target - name to remove.

flags - defining the operation modus.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

remove

Task<NSDirectory,Void> remove(TaskMode mode,
                              String target)
                              throws NotImplementedException

Creates a task that removes the specified entry. The target may contain wildcards.

Parameters:

mode - the task mode.

target - name to remove.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

makeDir

Task<NSDirectory,Void> makeDir(TaskMode mode,
                               URL target,
                               int flags)
                               throws NotImplementedException

Creates a task that creates a new directory.

Parameters:

mode - the task mode.

target - directory to create.

flags - defining the operation modus.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

makeDir

Task<NSDirectory,Void> makeDir(TaskMode mode,
                               URL target)
                               throws NotImplementedException

Creates a task that creates a new directory.

Parameters:

mode - the task mode.

target - directory to create.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

openDir

Task<NSDirectory,NSDirectory> openDir(TaskMode mode,
                                      URL name,
                                      int flags)
                                      throws NotImplementedException

Creates a task that creates a new NamespaceDirectory instance.

Parameters:

mode - the task mode.

name - directory to open.

flags - defining the operation modus.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

openDir

Task<NSDirectory,NSDirectory> openDir(TaskMode mode,
                                      URL name)
                                      throws NotImplementedException

Creates a task that creates a new NamespaceDirectory instance.

Parameters:

mode - the task mode.

name - directory to open.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

open

Task<NSDirectory,NSEntry> open(TaskMode mode,
                               URL name,
                               int flags)
                               throws NotImplementedException

Creates a task that creates a new NamespaceEntry instance.

Parameters:

mode - the task mode.

name - entry to open.

flags - defining the operation modus.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

open

Task<NSDirectory,NSEntry> open(TaskMode mode,
                               URL name)
                               throws NotImplementedException

Creates a task that creates a new NamespaceEntry instance.

Parameters:

mode - the task mode.

name - entry to open.

Returns:

the task.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

permissionsAllow

Task<NSDirectory,Void> permissionsAllow(TaskMode mode,
                                        URL target,
                                        String id,
                                        int permissions,
                                        int flags)
                                        throws NotImplementedException

Creates a task that enables the specified permissions for the specified id. An id of "*" enables the permissions for all.

Parameters:

mode - determines the initial state of the task.

target - the entry affected.

id - the id.

permissions - the permissions to enable.

flags - the only allowed flags are RECURSIVE and DEREFERENCE.

Returns:

the task object.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

permissionsAllow

Task<NSDirectory,Void> permissionsAllow(TaskMode mode,
                                        URL target,
                                        String id,
                                        int permissions)
                                        throws NotImplementedException

Creates a task that enables the specified permissions for the specified id. An id of "*" enables the permissions for all.

Parameters:

mode - determines the initial state of the task.

target - the entry affected.

id - the id.

permissions - the permissions to enable.

Returns:

the task object.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

permissionsAllow

Task<NSDirectory,Void> permissionsAllow(TaskMode mode,
                                        String target,
                                        String id,
                                        int permissions,
                                        int flags)
                                        throws NotImplementedException

Creates a task that enables the specified permissions for the specified id. The target may contain wildcards. An id of "*" enables the permissions for all.

Parameters:

mode - determines the initial state of the task.

target - the entry affected.

id - the id.

permissions - the permissions to enable.

flags - the only allowed flags are RECURSIVE and DEREFERENCE.

Returns:

the task object.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

permissionsAllow

Task<NSDirectory,Void> permissionsAllow(TaskMode mode,
                                        String target,
                                        String id,
                                        int permissions)
                                        throws NotImplementedException

Creates a task that enables the specified permissions for the specified id. The target may contain wildcards. An id of "*" enables the permissions for all.

Parameters:

mode - determines the initial state of the task.

target - the entry affected.

id - the id.

permissions - the permissions to enable.

Returns:

the task object.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

permissionsDeny

Task<NSDirectory,Void> permissionsDeny(TaskMode mode,
                                       URL target,
                                       String id,
                                       int permissions,
                                       int flags)
                                       throws NotImplementedException

Creates a task that disables the specified permissions for the specified id. An id of "*" disables the permissions for all.

Parameters:

mode - determines the initial state of the task.

target - the entry affected.

id - the id.

permissions - the permissions to disable.

flags - the only allowed flags are RECURSIVE and DEREFERENCE.

Returns:

the task object.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

permissionsDeny

Task<NSDirectory,Void> permissionsDeny(TaskMode mode,
                                       URL target,
                                       String id,
                                       int permissions)
                                       throws NotImplementedException

Creates a task that disables the specified permissions for the specified id. An id of "*" disables the permissions for all.

Parameters:

mode - determines the initial state of the task.

target - the entry affected.

id - the id.

permissions - the permissions to disable.

Returns:

the task object.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

permissionsDeny

Task<NSDirectory,Void> permissionsDeny(TaskMode mode,
                                       String target,
                                       String id,
                                       int permissions,
                                       int flags)
                                       throws NotImplementedException

Creates a task that disables the specified permissions for the specified id. The target may contain wildcards. An id of "*" disables the permissions for all.

Parameters:

mode - determines the initial state of the task.

target - the entry affected.

id - the id.

permissions - the permissions to disable.

flags - the only allowed flags are RECURSIVE and DEREFERENCE.

Returns:

the task object.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.

permissionsDeny

Task<NSDirectory,Void> permissionsDeny(TaskMode mode,
                                       String target,
                                       String id,
                                       int permissions)
                                       throws NotImplementedException

Creates a task that disables the specified permissions for the specified id. The target may contain wildcards. An id of "*" disables the permissions for all.

Parameters:

mode - determines the initial state of the task.

target - the entry affected.

id - the id.

permissions - the permissions to disable.

Returns:

the task object.

Throws:

NotImplementedException - is thrown when the task version of this method is not implemented.