org.alfresco.jlan.client

Class DiskSession

java.lang.Object

org.alfresco.jlan.client.Session

org.alfresco.jlan.client.DiskSession

Direct Known Subclasses:

CIFSDiskSession, CoreDiskSession

public abstract class DiskSession
extends Session

The DiskSession class provides disk, directory and file related methods on a remote disk share.

The disk session maintains a current working directory, initially set from the PCShare object that was used to open the disk session. Methods such as CreateDirectory(), DeleteDirectory(), OpenFile() etc. will prepend the working directory string to the specified file or directory string, unless the specified file or directory contains a path. The current working directory can be changed using the setWorkingDirectory() method.

A disk session is created using the SessionFactory.OpenDiskSession() method. The SessionFactory negotiates the appropriate SMB dialect with the remote server and creates the appropriate DiskSession derived object.

Author:

gkspencer

See Also:

SessionFactory

Field Summary

Fields

Modifier and Type	Field and Description
static int	Attributes
static int	DefaultInformationLevel
static int	WriteDate
static int	WriteTime

Fields inherited from class org.alfresco.jlan.client.Session

Closed, DBGDumpPacket, DBGHexDump, DBGPacketType, DBGSigning, DEFAULT_BUFSIZE, m_pkt, m_treeid, NO_TRANSACTION, SecurityModeShare, SecurityModeUser

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DiskSession(PCShare shr, int dialect) Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	CloseSession() Close this connection with the remote server share.
abstract void	CreateDirectory(String dir) Create a new directory on the remote file server.
abstract SMBFile	CreateFile(String fname) Create and open a file on the remote file server.
abstract void	DeleteDirectory(String dir) Delete the specified directory on the remote file server.
void	DeleteFile(String fname) Delete the specified file on the remote file server.
abstract void	DeleteFile(String fname, int attr) Delete the specified file on the remote file server.
boolean	FileExists(String fname) Check if a file exists on the remote file server.
protected void	finalize() Finalize the object
abstract DiskInfo	getDiskInformation() Get disk information for this remote disk.
FileInfo	getFileInformation(String fname) Get file information for the specified file, returning the default information level
abstract FileInfo	getFileInformation(String fname, int level) Get file information for the specified file.
abstract VolumeInfo	getVolumeInformation() Get the disk volume information
String	getWorkingDirectory() Get the current working directory, relative to the share that is being accessed.
boolean	isClosed() Detemine if the disk session has been closed.
abstract boolean	isDirectory(String dir) Check if the specified file name is a directory.
protected boolean	isValidFilePath(String path) Check if a path looks like a valid file path
abstract SMBFile	OpenFile(String fname, int flags) Open a file on the remote file server.
SMBInputStream	OpenInputStream(String fname, int flags) Open a file as an input stream.
SMBOutputStream	OpenOutputStream(String fname, int flags) Open a file as an output stream.
boolean	RenameFile(String curnam, String newnam) Rename a file, or set of files, on the remote file server.
abstract boolean	RenameFile(String curnam, String newnam, int attr) Rename a file, or set of files, on the remote file server.
abstract void	setFileAttributes(String fname, int attrib) Set file attributes for the specified file, using the file name
abstract void	setFileInformation(SMBFile file, FileInfo finfo) Set file information for the specified file, using the file id
abstract void	setFileInformation(String fname, FileInfo finfo) Set file information for the specified file.
void	setWorkingDirectory(String wd) Set the current working directory, relative to the share that is being accessed.
SearchContext	StartSearch(String dir, int attr) Start a search of the specified directory returning the default information level
abstract SearchContext	StartSearch(String dir, int attr, int level) Start a search of the specified directory returning information for each file/directory found.

Methods inherited from class org.alfresco.jlan.client.Session

allocatePacket, disableSMBSigning, enableSMBSigning, getCapabilities, getDefaultFlags, getDefaultFlags2, getDeviceType, getDialect, getDialectString, getDomain, getEncryptionKey, getLANManagerType, getMaximumMultiplexedRequests, getMaximumPacketSize, getMaximumVirtualCircuits, getNextMultiplexId, getNextSessionId, getOperatingSystem, getPassword, getPCShare, getProcessId, getSecurityMode, getServer, getSession, getSessionId, getShareName, getSMBSequence, getTreeId, getUserId, getUserName, hasActiveTransaction, hasDataAvailable, hasDebug, hasDebugOption, hasEncryptionKey, hasSMBSigning, isActive, isGuest, isUnicode, pingServer, pingServer, processAsynchResponse, setCapabilities, setDebug, setDefaultFlags, setDefaultFlags2, setDeviceType, setDialect, setDialectString, setDomain, setEncryptionKey, setGuest, setLANManagerType, setMaximumMultiplexedRequests, setMaximumPacketSize, setMaximumVirtualCircuits, setOperatingSystem, setPassword, setProcessId, setSecurityMode, setServer, setSession, setShareName, setSMBSequence, setTransactionMID, setTreeId, setUserId, setUserName, signTxPacket, supportsLargeFiles, supportsLevel2Oplocks, supportsLockAndRead, supportsNTFind, supportsNTSmbs, supportsNTStatusCodes, supportsRawMode, supportsRPCAPIs, supportsUnicode, toString, verifyRxPacket

Methods inherited from class java.lang.Object

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

Field Detail

DefaultInformationLevel

public static final int DefaultInformationLevel

See Also:

Constant Field Values

Attributes

public static final int Attributes

See Also:

Constant Field Values

WriteTime

public static final int WriteTime

See Also:

Constant Field Values

WriteDate

public static final int WriteDate

See Also:

Constant Field Values

Constructor Detail

DiskSession

protected DiskSession(PCShare shr,
           int dialect)

Class constructor

Parameters:

shr - PCShare

dialect - int

Method Detail

CloseSession

public void CloseSession()
                  throws IOException,
                         SMBException

Close this connection with the remote server share.

Overrides:

CloseSession in class Session

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

CreateDirectory

public abstract void CreateDirectory(String dir)
                              throws IOException,
                                     SMBException

Create a new directory on the remote file server.

Parameters:

dir - Directory name string. If the directory name does not have a leading '\' the current working directory for this session will be prepended to the string.

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

CreateFile

public abstract SMBFile CreateFile(String fname)
                            throws IOException,
                                   SMBException

Create and open a file on the remote file server.

Parameters:

fname - Remote file name string.

Returns:

SMBFile for the opened file, else null.

Throws:

IOException - If an I/O error occurs

SMBException - If an SMB error occurs

DeleteDirectory

public abstract void DeleteDirectory(String dir)
                              throws IOException,
                                     SMBException

Delete the specified directory on the remote file server.

Parameters:

dir - Directory name string. If the directory name does not have a leading '\' the current working directory for this session will be preprended to the string.

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

DeleteFile

public void DeleteFile(String fname)
                throws IOException,
                       SMBException

Delete the specified file on the remote file server.

Parameters:

fname - File name of the remote file to delete. If the file name does not have a leading '\' the current working directory for this session will be prepended to the string. The string may contain wildcard characters to delete multiple files. '?' matches a single character and '*' matches none, one or more characters.

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

DeleteFile

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

Delete the specified file on the remote file server.

Parameters:

fname - File name of the remote file to delete. If the file name does not have a leading '\' the current working directory for this session will be prepended to the string. The string may contain wildcard characters to delete multiple files. '?' matches a single character and '*' matches none, one or more characters.

attr - File attributes of the file(s) to delete.

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

FileExists

public boolean FileExists(String fname)

Check if a file exists on the remote file server.

Parameters:

fname - File name to test for on the remote file server. If the file name does not start with a '\' then the working directory is prepended to the file name string.

Returns:

true if the file exists, else false.

finalize

protected void finalize()

Finalize the object

Overrides:

finalize in class Object

getDiskInformation

public abstract DiskInfo getDiskInformation()
                                     throws IOException,
                                            SMBException

Get disk information for this remote disk.

Returns:

Disk information object, or null.

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

getFileInformation

public abstract FileInfo getFileInformation(String fname,
                          int level)
                                     throws IOException,
                                            FileNotFoundException,
                                            SMBException

Get file information for the specified file.

Parameters:

fname - File name of the file to return information for.

level - Information level required

Returns:

SMBFileInfo if the request was successful, else null.

Throws:

IOException - If an I/O error occurs.

FileNotFoundException - If the remote file does not exist.

SMBException - If an SMB level error occurs

getFileInformation

public final FileInfo getFileInformation(String fname)
                                  throws IOException,
                                         FileNotFoundException,
                                         SMBException

Get file information for the specified file, returning the default information level

Parameters:

fname - File name of the file to return information for.

Returns:

SMBFileInfo if the request was successful, else null.

Throws:

IOException - If an I/O error occurs.

FileNotFoundException - If the remote file does not exist.

SMBException - If an SMB level error occurs

getVolumeInformation

public abstract VolumeInfo getVolumeInformation()
                                         throws IOException,
                                                SMBException

Get the disk volume information

Returns:

VolumeInfo, or null

Throws:

FileNotFoundException - If the remote file does not exist.

SMBException - If an SMB level error occurs

IOException

getWorkingDirectory

public final String getWorkingDirectory()

Get the current working directory, relative to the share that is being accessed.

Returns:

Current working directory path string.

isClosed

public final boolean isClosed()

Detemine if the disk session has been closed.

Returns:

true if the disk session has been closed, else false.

isDirectory

public abstract boolean isDirectory(String dir)
                             throws IOException,
                                    SMBException

Check if the specified file name is a directory.

Parameters:

dir - Directory name string. If the directory name does not have a leading '\' the current working directory for this session will be prepended to the string.

Returns:

true if the specified file name is a directory, else false.

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

OpenFile

public abstract SMBFile OpenFile(String fname,
               int flags)
                          throws IOException,
                                 SMBException

Open a file on the remote file server.

Parameters:

fname - Remote file name string.

flags - File open option flags.

Returns:

SMBFile for the opened file, else null.

Throws:

IOException - If an I/O error occurs

SMBException - If an SMB error occurs

OpenInputStream

public SMBInputStream OpenInputStream(String fname,
                             int flags)
                               throws IOException,
                                      SMBException

Open a file as an input stream.

Parameters:

fname - Remote file name string.

flags - File open option flags.

Returns:

SMBInputStream for the opened file, else null.

Throws:

IOException - If an I/O error occurs

SMBException - If an SMB error occurs

OpenOutputStream

public SMBOutputStream OpenOutputStream(String fname,
                               int flags)
                                 throws IOException,
                                        SMBException

Open a file as an output stream.

Parameters:

fname - Remote file name string.

flags - File open option flags.

Returns:

SMBOutputStream for the opened file, else null.

Throws:

IOException - If an I/O error occurs

SMBException - If an SMB error occurs

RenameFile

public boolean RenameFile(String curnam,
                 String newnam)
                   throws IOException,
                          SMBException

Rename a file, or set of files, on the remote file server.

Parameters:

curnam - Current file name string, may contain wildcards.

newnam - New file name.

Returns:

true if the file(s) were renamed, else false

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

RenameFile

public abstract boolean RenameFile(String curnam,
                 String newnam,
                 int attr)
                            throws IOException,
                                   SMBException

Rename a file, or set of files, on the remote file server.

Parameters:

curnam - Current file name string, may contain wildcards.

newnam - New file name.

attr - Search attributes, to determine which file(s) to rename.

Returns:

true if the file(s) were renamed, else false

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

See Also:

FileAttribute

setFileInformation

public abstract void setFileInformation(String fname,
                      FileInfo finfo)
                                 throws IOException,
                                        SMBException

Set file information for the specified file.

Parameters:

fname - File name of the file to set information for.

finfo - File information containing the new values.

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

setFileInformation

public abstract void setFileInformation(SMBFile file,
                      FileInfo finfo)
                                 throws IOException,
                                        SMBException

Set file information for the specified file, using the file id

Parameters:

file - File to set information for

finfo - File information containing new values

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

setFileAttributes

public abstract void setFileAttributes(String fname,
                     int attrib)
                                throws IOException,
                                       SMBException

Set file attributes for the specified file, using the file name

Parameters:

fname - File name of the file to set information for.

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

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

setWorkingDirectory

public final void setWorkingDirectory(String wd)

Set the current working directory, relative to the share that is being accessed.

Parameters:

wd - Working directory path string.

StartSearch

public abstract SearchContext StartSearch(String dir,
                        int attr,
                        int level)
                                   throws IOException,
                                          SMBException

Start a search of the specified directory returning information for each file/directory found.

Parameters:

dir - Directory/file name string, which may contain wildcards. If the directory string does not start with a '\' then the directory name is prepended with the current working directory.

attr - Search attributes, to determine the types of files/directories returned. @see org.alfresco.jlans.server.filesys.FileAttribute

level - Information level to be returned. @see org.alfresco.jlan.smb.FileInfoLevel

Returns:

SearchContext for this search, else null

Throws:

IOException - If an I/O error occurs

SMBException - If an SMB level error occurs

StartSearch

public final SearchContext StartSearch(String dir,
                        int attr)
                                throws IOException,
                                       SMBException

Start a search of the specified directory returning the default information level

Parameters:

dir - Directory/file name string, which may contain wildcards. If the directory string does not start with a '\' then the directory name is prepended with the current working directory.

attr - Search attributes, to determine the types of files/directories returned. @see org.alfresco.jlan.server.filesys.FileAttribute

Returns:

SearchContext for this search, else null

Throws:

IOException - If an I/O error occurs

SMBException - If an SMB level error occurs

isValidFilePath

protected final boolean isValidFilePath(String path)

Check if a path looks like a valid file path

Parameters:

path - String

Returns:

boolean