org.alfresco.jlan.client

Class CoreDiskSession

java.lang.Object

org.alfresco.jlan.client.Session

org.alfresco.jlan.client.DiskSession

org.alfresco.jlan.client.CoreDiskSession

public class CoreDiskSession
extends DiskSession

SMB core disk session class

Author:

gkspencer

Field Summary

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

Attributes, DefaultInformationLevel, WriteDate, 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	CoreDiskSession(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.
void	CreateDirectory(String dir) Create a new directory on the remote file server.
SMBFile	CreateFile(String fname) Create and open a file on the remote file server.
void	DeleteDirectory(String dir) Delete the specified directory on the remote file server.
void	DeleteFile(String fname, int attr) Delete the specified file on the remote server.
DiskInfo	getDiskInformation() Get disk information for this remote disk.
FileInfo	getFileInformation(String fname, int level) Get file information for the specified file.
VolumeInfo	getVolumeInformation() Get the disk volume information
boolean	isDirectory(String dir) Check if the specified file name is a directory.
SMBFile	OpenFile(String fname, int flags) Open a file on the remote file server.
boolean	RenameFile(String curnam, String newnam, int attr) Rename a file, or set of files, on the remote file server.
void	setFileAttributes(String fname, int attrib) Set file attributes for the specified file, using the file name
void	setFileInformation(SMBFile file, FileInfo finfo) Set file information for the specified file, using the file id
void	setFileInformation(String fname, FileInfo finfo) Set file information for the specified file.
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.DiskSession

DeleteFile, FileExists, finalize, getFileInformation, getWorkingDirectory, isClosed, isValidFilePath, OpenInputStream, OpenOutputStream, RenameFile, setWorkingDirectory, StartSearch

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

Constructor Detail

CoreDiskSession

protected CoreDiskSession(PCShare shr,
               int dialect)

Class constructor

Parameters:

shr - Remote server details.

dialect - SMB dialect that this session is using

Method Detail

CloseSession

public void CloseSession()
                  throws IOException,
                         SMBException

Close this connection with the remote server share.

Overrides:

CloseSession in class DiskSession

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

CreateDirectory

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

Create a new directory on the remote file server.

Specified by:

CreateDirectory in class DiskSession

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 final SMBFile CreateFile(String fname)
                         throws IOException,
                                SMBException

Create and open a file on the remote file server.

Specified by:

CreateFile in class DiskSession

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 final void DeleteDirectory(String dir)
                           throws IOException,
                                  SMBException

Delete the specified directory on the remote file server.

Specified by:

DeleteDirectory in class DiskSession

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 final void DeleteFile(String fname,
              int attr)
                      throws IOException,
                             SMBException

Delete the specified file on the remote server.

Specified by:

DeleteFile in class DiskSession

Parameters:

fname - File to delete on the remote server.

attr - Attributes of the file to be deleted. @see org.alfresco.jlan.server.filesys.FileAttribute

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

getDiskInformation

public final DiskInfo getDiskInformation()
                                  throws IOException,
                                         SMBException

Get disk information for this remote disk.

Specified by:

getDiskInformation in class DiskSession

Returns:

Disk information object, or null.

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

getFileInformation

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

Get file information for the specified file.

Specified by:

getFileInformation in class DiskSession

Parameters:

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

level - Information level required. @see org.alfresco.jlan.smb.FileInfoLevel

Returns:

FileInfo if the request was successful, else null.

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

FileNotFoundException - If the remote file does not exist.

getVolumeInformation

public final VolumeInfo getVolumeInformation()
                                      throws IOException,
                                             SMBException

Get the disk volume information

Specified by:

getVolumeInformation in class DiskSession

Returns:

VolumeInfo, or null

Throws:

IOException - If an I/O error occurs

SMBException - If an SMB level error occurs

FileNotFoundException - If the remote file does not exist.

isDirectory

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

Check if the specified file name is a directory.

Specified by:

isDirectory in class DiskSession

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.

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 final SMBFile OpenFile(String fname,
               int flags)
                       throws IOException,
                              SMBException

Open a file on the remote file server.

Specified by:

OpenFile in class DiskSession

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 level error occurs

RenameFile

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

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

Specified by:

RenameFile in class DiskSession

Parameters:

curnam - Current file name string, may contain wildcards. If the path does not start with a '\' the current working directory string will be preprended.

newnam - New file name.

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

Returns:

true if the file rename request was successful, else false.

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

See Also:

FileAttribute

setFileInformation

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

Set file information for the specified file.

Specified by:

setFileInformation in class DiskSession

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 final void setFileInformation(SMBFile file,
                      FileInfo finfo)
                              throws IOException,
                                     SMBException

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

Specified by:

setFileInformation in class DiskSession

Parameters:

file - 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

setFileAttributes

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

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

Specified by:

setFileAttributes in class DiskSession

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

StartSearch

public final 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.

Specified by:

StartSearch in class DiskSession

Parameters:

dir - Directory to start searching. 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

level - Information level required. @see org.alfresco.jlan.smb.FileInfoLevel

Returns:

SMBSearchContext for this search, else null

Throws:

IOException - If an I/O error occurs

SMBException - If an SMB level error occurs