com.cleo.lexicom.external

Interface IDirectoryController

All Superinterfaces:

java.rmi.Remote

public interface IDirectoryController
extends java.rmi.Remote

Establishes an interface for exploring and manipulating an FTP or SSH FTP client's directory structure. Refer to IActionController.getDirectoryController()

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALPHABETICAL_ASCENDING Alphabetical ascending list sort
static int	ALPHABETICAL_DESCENDING Alphabetical descending list sort
static int	DATE_ASCENDING Date ascending list sort
static int	DATE_DESCENDING Date descending list sort
static int	NONE No list sort
static int	SIZE_ASCENDING Size ascending list sort
static int	SIZE_DESCENDING Size descending list sort

Method Summary

Modifier and Type	Method and Description
boolean	chdir(java.lang.String path) Change the current working directory
java.lang.String	current() Get the current working directory
boolean	delete(java.lang.String path) Delete a file
DirectoryEntry[]	list(java.lang.String path, boolean recurse, IDirectoryFilter filter, int sort) Get a directory listing
boolean	mkdir(java.lang.String path) Make a new directory
boolean	rename(java.lang.String from, java.lang.String to) Rename a directory (or file)
boolean	rmdir(java.lang.String path) Remove a directory
void	setContinueListingOnNonFatalErrors(boolean continueListingOnNonFatalErrorsFlag) Set flag to continue or stop if non-fatal errors are encountered when listing files and directories
DirectoryEntry[]	sort(DirectoryEntry[] list, int sort) Sort a directory listing

Field Detail

NONE

static final int NONE

No list sort

See Also:

Constant Field Values

ALPHABETICAL_ASCENDING

static final int ALPHABETICAL_ASCENDING

Alphabetical ascending list sort

See Also:

Constant Field Values

ALPHABETICAL_DESCENDING

static final int ALPHABETICAL_DESCENDING

Alphabetical descending list sort

See Also:

Constant Field Values

DATE_ASCENDING

static final int DATE_ASCENDING

Date ascending list sort

See Also:

Constant Field Values

DATE_DESCENDING

static final int DATE_DESCENDING

Date descending list sort

See Also:

Constant Field Values

SIZE_ASCENDING

static final int SIZE_ASCENDING

Size ascending list sort

See Also:

Constant Field Values

SIZE_DESCENDING

static final int SIZE_DESCENDING

Size descending list sort

See Also:

Constant Field Values

Method Detail

current

java.lang.String current()
                  throws java.lang.Exception

Get the current working directory

Returns:

the current working directory (returns null if session error)

Throws:

java.lang.Exception

list

DirectoryEntry[] list(java.lang.String path,
                      boolean recurse,
                      IDirectoryFilter filter,
                      int sort)
               throws java.lang.Exception

Get a directory listing

Parameters:

path - the directory path (or null for the current working directory)

recurse - true if nested directories should also be listed

filter - directory entry filter (can be null)

sort - either NONE, ALPHABETICAL_ASCENDING, ALPHABETICAL_DESCENDING, DATE_ASCENDING, DATE_DESCENDING, SIZE_ASCENDING, or SIZE_DESCENDING

Returns:

the directory's entries (returns null if session error)

Throws:

java.lang.Exception

setContinueListingOnNonFatalErrors

void setContinueListingOnNonFatalErrors(boolean continueListingOnNonFatalErrorsFlag)
                                 throws java.lang.Exception

Set flag to continue or stop if non-fatal errors are encountered when listing files and directories

Parameters:

continueListingOnNonFatalErrorsFlag - true if should continue listing when non-fatal errros are encountered

Throws:

java.lang.Exception

sort

DirectoryEntry[] sort(DirectoryEntry[] list,
                      int sort)
               throws java.lang.Exception

Sort a directory listing

Parameters:

list - the directory listing

sort - either ALPHABETICAL_ASCENDING, ALPHABETICAL_DESCENDING, DATE_ASCENDING, DATE_DESCENDING, SIZE_ASCENDING, or SIZE_DESCENDING

Returns:

the sorted directory entries

Throws:

java.lang.Exception

chdir

boolean chdir(java.lang.String path)
       throws java.lang.Exception

Change the current working directory

Parameters:

path - a relative or absolute directory path

Returns:

true if successful

Throws:

java.lang.Exception

mkdir

boolean mkdir(java.lang.String path)
       throws java.lang.Exception

Make a new directory

Parameters:

path - a relative or absolute directory path

Returns:

true if successful

Throws:

java.lang.Exception

rmdir

boolean rmdir(java.lang.String path)
       throws java.lang.Exception

Remove a directory

Parameters:

path - a relative or absolute directory path

Returns:

true if successful

Throws:

java.lang.Exception

delete

boolean delete(java.lang.String path)
        throws java.lang.Exception

Delete a file

Parameters:

path - a relative or absolute file path

Returns:

true if successful

Throws:

java.lang.Exception

rename

boolean rename(java.lang.String from,
               java.lang.String to)
        throws java.lang.Exception

Rename a directory (or file)

Parameters:

from - a relative or absolute directory (or file) path

to - a relative or absolute directory (or file) path

Returns:

true if successful

Throws:

java.lang.Exception