org.alfresco.jlan.client

Class SearchContext

java.lang.Object

org.alfresco.jlan.client.SearchContext

public abstract class SearchContext
extends Object

SMB search context class

Holds the details of an in progress folder search on a remote file server.

For large folder listings the search will be split up over a number of SMB/CIFS requests. The SearchContext derived class is used to hold the search state between requests to the remote file server.

Author:

gkspencer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SearchContext(DiskSession sess) Class constructor

Method Summary

Modifier and Type	Method and Description
protected int	getInformationLevel() Return the required information level
protected int	getSearchAttributes() Return the search attributes
protected String	getSearchPath() Return the search path
protected DiskSession	getSession() Return the associated disk session
abstract FileInfo	nextFileInfo() Return the next file in this search as an SMB file information object.
abstract String	nextFileName() Return the next file name in this search.
protected void	setInformationLevel(int level) Set the information level
protected void	setSearchAttributes(int attr) Set the search attributes
protected void	setSearchParameters(String path, int attr, int level) Set the search parameters
protected void	setSearchPath(String path) Set the search path
abstract void	StartSearch(String fname, int attr, int level) Start a new search using the specified file name string and search attributes, return the specified file information level

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchContext

protected SearchContext(DiskSession sess)

Class constructor

Parameters:

sess - Disk session that the search is associated with

Method Detail

nextFileInfo

public abstract FileInfo nextFileInfo()
                               throws IOException,
                                      SMBException

Return the next file in this search as an SMB file information object.

Returns:

FileInfo object, or null if there are no more files.

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

nextFileName

public abstract String nextFileName()
                             throws IOException,
                                    SMBException

Return the next file name in this search.

Returns:

Next file name string, or null if there are no more files.

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

StartSearch

public abstract void StartSearch(String fname,
                                 int attr,
                                 int level)
                          throws IOException,
                                 SMBException

Start a new search using the specified file name string and search attributes, return the specified file information level

Parameters:

fname - File name string, may contain wilcards.

attr - File attributes bit mask. @see org.alfresco.jlan.server.filesys.FileAttribute

level - File information level to return. @see org.alfresco.jlan.smb.FileInfoLevel

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

getSession

protected final DiskSession getSession()

Return the associated disk session

Returns:

DiskSession

getSearchPath

protected final String getSearchPath()

Return the search path

Returns:

String

getSearchAttributes

protected final int getSearchAttributes()

Return the search attributes

Returns:

int

getInformationLevel

protected final int getInformationLevel()

Return the required information level

Returns:

int

setSearchPath

protected final void setSearchPath(String path)

Set the search path

Parameters:

path - String

setSearchAttributes

protected final void setSearchAttributes(int attr)

Set the search attributes

Parameters:

attr - int

setInformationLevel

protected final void setInformationLevel(int level)

Set the information level

Parameters:

level - int

setSearchParameters

protected final void setSearchParameters(String path,
                                         int attr,
                                         int level)

Set the search parameters

Parameters:

path - String

attr - int

level - int