org.alfresco.jlan.client

Class CIFSDiskSession

java.lang.Object

org.alfresco.jlan.client.Session

org.alfresco.jlan.client.DiskSession

org.alfresco.jlan.client.CIFSDiskSession

public final class CIFSDiskSession
extends DiskSession

SMB CIFS disk session class

The CIFSDiskSession class extends the DiskSession class and provides CIFS protocol specific implementations for the DiskSession methods.

An CIFSDiskSession object will be created by the SessionFactory static class when the negotiated SMB dialect indicates that the remote server supports an SMB dialect greater than Core or CorePlus.

The SessionFactory.OpenDisk() method is used to create a session to a remote disk share. A PCShare object specifies the remote server and share to connect to, along with any required access control.

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	CIFSDiskSession(PCShare shr, int dialect) Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAsynchronousRequest(AsynchRequest req) Add an asynchronous request to the list of pending requests
void	checkForAsynchReceive(int waitTime) Process incoming data checking for asynchronous response packets from the server
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 file server.
protected void	fileClosed(CIFSFile cifsFile) File closed, remove from the oplocked file list
DiskInfo	getDiskInformation() Get disk information for this remote disk.
FileInfo	getFileInformation(String fname, int level) Get file information for the specified file.
TransactBuffer	getFileInformationRaw(String fname, int level) Get file information for the specified file.
SymLink	getSymLinkDetails(String linkPath) Return the details for a symlink file/folder
VolumeInfo	getVolumeInformation() Get the disk volume information
boolean	isDirectory(String dir) Check if the specified file name is a directory.
void	NTCancel(AsynchRequest areq) Cancel an outstanding request.
CIFSFile	NTCreate(String name, int access, int attrib, int sharing, int exists, long initSize, int createOpt) Perform an NTCreateAndX SMB to create/open a file or directory
protected CIFSFile	NTCreateInternal(String name, int createFlags, int access, int attrib, int sharing, int exists, long initSize, int createOpt, boolean throwErr) Perform an NTCreateAndX SMB to create/open a file or directory
CIFSFile	NTCreateWithOplock(String name, int oplockFlags, OplockInterface oplockIface, int access, int attrib, int sharing, int exists, long initSize, int createOpt) Perform an NTCreateAndX SMB to create/open a file with an oplock
DeviceAttributesInfo	NTGetDeviceAttributes() Get the device attributes information
DeviceInfo	NTGetDeviceInfo() Get the device information
FileInfo	NTGetFileInformation(int fid, int level) Get file information for the specified open file/directory, returning the requested information level
TransactBuffer	NTGetFileInformationRaw(int fid, int level) Get file information for the specified open file/directory, returning the requested information level
DataBuffer	NTIOCtl(int ctrlCode, int fid, boolean fsctl, byte[] data, int dlen, int filter) NT I/O control
AsynchRequest	NTNotifyChange(AsynchRequest areq) Add a change notification filter for the specified directory
AsynchRequest	NTNotifyChange(int fid, int filter, boolean watchTree, DirectoryWatcher handler, boolean autoResub) Add a change notification filter for the specified directory
SecurityDescriptor	NTQuerySecurityDescriptor(int fid, int flags) Perform an NT query security descriptor transaction for the specified file or directory
void	NTSetDeleteOnClose(int fid, boolean delFlag) Set the delete on close flag for an open file
void	NTSetEndOfFile(int fid, long pos) Set the end of file position for the open file
void	NTSetFileAllocation(int fid, long alloc) Set the file allocation size for the open file
void	NTSetFileInformation(FileInfo finfo, int level) Set file information that allows setting different information levels
void	NTSetSecurityDescriptor(int fid, SecurityDescriptor secdesc, int flags) Set the security descriptor for the specified file/directory
SMBFile	OpenFile(String fname, int flags) Open a file on the remote file server.
protected void	processAsynchResponse(SMBPacket pkt) Process an asynchronous response packet
void	refreshFileInformation(SMBFile smbFile) Refresh the file information for an open file
protected AsynchRequest	removeAsynchronousRequest(AsynchRequest req) Remove an asynchronous request from the pending list
protected AsynchRequest	removeAsynchronousRequest(int id) Remove an asynchronous request from the pending list
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, 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

CIFSDiskSession

protected CIFSDiskSession(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 file server.

Specified by:

DeleteFile in class DiskSession

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.

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

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,
                                         FileNotFoundException,
                                         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

Returns:

FileInfo 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

See Also:

FileInfoLevel

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

Throws:

IOException - If an I/O error occurs.

SMBException - If an SMB level error occurs

See Also:

FileAttribute

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

Returns:

SMBSearchContext for this search, else null

Throws:

IOException - If an I/O error occurs

SMBException - If an SMB level error occurs

NTCreate

public final CIFSFile NTCreate(String name,
                int access,
                int attrib,
                int sharing,
                int exists,
                long initSize,
                int createOpt)
                        throws IOException,
                               SMBException

Perform an NTCreateAndX SMB to create/open a file or directory

Parameters:

name - File/directory name

access - Desired access mode.

attrib - Required file attributes.

sharing - Shared access mode

exists - Action to take if file/directory exists.

initSize - Initial file allocation size, in bytes

createOpt - Create file options

Returns:

CIFSFile

Throws:

IOException

SMBException - If an SMB level error occurs

See Also:

AccessMode, FileAttribute, FileAction

NTCreateWithOplock

public final CIFSFile NTCreateWithOplock(String name,
                          int oplockFlags,
                          OplockInterface oplockIface,
                          int access,
                          int attrib,
                          int sharing,
                          int exists,
                          long initSize,
                          int createOpt)
                                  throws IOException,
                                         SMBException

Perform an NTCreateAndX SMB to create/open a file with an oplock

Parameters:

name - File/directory name

oplockFlags - int

access - Desired access mode.

attrib - Required file attributes.

sharing - Shared access mode

exists - Action to take if file/directory exists.

initSize - Initial file allocation size, in bytes

createOpt - Create file options

Returns:

CIFSFile

Throws:

IOException

SMBException - If an SMB level error occurs

See Also:

AccessMode, FileAttribute, FileAction

NTQuerySecurityDescriptor

public final SecurityDescriptor NTQuerySecurityDescriptor(int fid,
                                           int flags)
                                                   throws IOException,
                                                          SMBException

Perform an NT query security descriptor transaction for the specified file or directory

Parameters:

fid - File identifier, via SMBFile.getFileId() of an open file.

flags - Security descriptor elements to return (Owner, Group, SACL, DACL).

Returns:

SecurityDescriptor

Throws:

IOException

SMBException - If an SMB level error occurs

See Also:

SecurityDescriptor

NTSetSecurityDescriptor

public final void NTSetSecurityDescriptor(int fid,
                           SecurityDescriptor secdesc,
                           int flags)
                                   throws IOException,
                                          SMBException,
                                          SaveException

Set the security descriptor for the specified file/directory

Parameters:

fid - File identifier, via SMBFile.getFileId() of an open file.

secdesc - Security descriptor

flags - Fields to set (Owner, Group, SACL, DACL).

Throws:

IOException - If a network error occurs

SMBException - If an SMB level error occurs

SaveException - If the security descriptor cannot be stored

See Also:

SecurityDescriptor

NTNotifyChange

public final AsynchRequest NTNotifyChange(int fid,
                           int filter,
                           boolean watchTree,
                           DirectoryWatcher handler,
                           boolean autoResub)
                                   throws IOException,
                                          SMBException

Add a change notification filter for the specified directory

Parameters:

fid - File id, from SMBFile.getFileId() of an open directory. The directory should be opened using the NTCreate() method.

filter - Directory watch filter flags. @see org.alfresco.jlan.client.nt.NotifyChange.

watchTree - true to watch sub-directories, false to watch the specified directory only

handler - DirectoryWatcher implementation. @see org.alfresco.jlan.client.smb.DirectoryWatcher

autoResub - true to automatically resubmit the notification filter after an event is received

Returns:

AsynchRequest

Throws:

IOException

SMBException - If an SMB level error occurs

NTNotifyChange

public final AsynchRequest NTNotifyChange(AsynchRequest areq)
                                   throws IOException,
                                          SMBException

Add a change notification filter for the specified directory

Parameters:

areq - AsynchRequest

Returns:

AsynchRequest

Throws:

IOException

SMBException - If an SMB level error occurs

NTCancel

public final void NTCancel(AsynchRequest areq)
                    throws IOException,
                           SMBException

Cancel an outstanding request. Used to cancel change notifications.

Parameters:

req - AsynchRequest

Throws:

IOException

SMBException - If an SMB level error occurs

NTIOCtl

public final DataBuffer NTIOCtl(int ctrlCode,
                 int fid,
                 boolean fsctl,
                 byte[] data,
                 int dlen,
                 int filter)
                         throws IOException,
                                SMBException

NT I/O control

Parameters:

ctrlCode - int

fid - int

fsctl - boolean

data - byte[]

dlen - int

filter - int

Returns:

DataBuffer

Throws:

IOException

SMBException - If an SMB level error occurs

NTGetFileInformation

public final FileInfo NTGetFileInformation(int fid,
                            int level)
                                    throws IOException,
                                           SMBException

Get file information for the specified open file/directory, returning the requested information level

Parameters:

fid - File id for the file or directory, from SMBFile.getFileId().

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

Returns:

FileInfo

Throws:

IOException

SMBException - If an SMB level error occurs

NTGetFileInformationRaw

public final TransactBuffer NTGetFileInformationRaw(int fid,
                                     int level)
                                             throws IOException,
                                                    SMBException

Get file information for the specified open file/directory, returning the requested information level

Parameters:

fid - File id for the file or directory, from SMBFile.getFileId().

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

Returns:

TransactBuffer

Throws:

IOException

SMBException - If an SMB level error occurs

NTSetFileInformation

public final void NTSetFileInformation(FileInfo finfo,
                        int level)
                                throws IOException,
                                       SMBException

Set file information that allows setting different information levels

Parameters:

finfo - FileInfo

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

Throws:

IOException

SMBException - If an SMB level error occurs

NTSetDeleteOnClose

public final void NTSetDeleteOnClose(int fid,
                      boolean delFlag)
                              throws IOException,
                                     SMBException

Set the delete on close flag for an open file

Parameters:

fid - File id for the file or directory, from SMBFile.getFileId().

delFlag - true to delete the file on close, or false to clear a previous delete on close request

Throws:

IOException

SMBException - If an SMB level error occurs

NTSetEndOfFile

public final void NTSetEndOfFile(int fid,
                  long pos)
                          throws IOException,
                                 SMBException

Set the end of file position for the open file

Parameters:

fid - File id for the file or directory, from SMBFile.getFileId().

pos - New end of file position

Throws:

IOException

SMBException - If an SMB level error occurs

NTSetFileAllocation

public final void NTSetFileAllocation(int fid,
                       long alloc)
                               throws IOException,
                                      SMBException

Set the file allocation size for the open file

Parameters:

fid - File id for the file or directory, from SMBFile.getFileId().

alloc - New file allocation size

Throws:

IOException

SMBException - If an SMB level error occurs

NTGetDeviceInfo

public final DeviceInfo NTGetDeviceInfo()
                                 throws IOException,
                                        SMBException

Get the device information

Returns:

DeviceInfo @see org.alfresco.jlan.client.info.DeviceInfo

Throws:

IOException

SMBException

NTGetDeviceAttributes

public final DeviceAttributesInfo NTGetDeviceAttributes()
                                                 throws IOException,
                                                        SMBException

Get the device attributes information

Returns:

DeviceAttributesInfo

Throws:

IOException

SMBException

getFileInformationRaw

public final TransactBuffer getFileInformationRaw(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. @see org.alfresco.jlan.smb.FileInfoLevel

Returns:

TransactBuffer

Throws:

IOException - If an I/O error occurs.

FileNotFoundException - If the remote file does not exist.

SMBException - If an SMB level error occurs

getSymLinkDetails

public final SymLink getSymLinkDetails(String linkPath)
                                throws Exception

Return the details for a symlink file/folder

Parameters:

linkPath - String

Returns:

SymLink

Throws:

Exception

checkForAsynchReceive

public final void checkForAsynchReceive(int waitTime)
                                 throws IOException,
                                        SMBException

Process incoming data checking for asynchronous response packets from the server

Parameters:

waitTime - Receive timeout in milliseconds, zero for no timeout or -1 to not wait for data

Throws:

IOException

SMBException

refreshFileInformation

public void refreshFileInformation(SMBFile smbFile)
                            throws IOException,
                                   SMBException

Refresh the file information for an open file

Parameters:

smbFile - SMBFile

Throws:

IOException

SMBException

processAsynchResponse

protected void processAsynchResponse(SMBPacket pkt)

Process an asynchronous response packet

Overrides:

processAsynchResponse in class Session

Parameters:

pkt - SMBPacket

addAsynchronousRequest

protected final void addAsynchronousRequest(AsynchRequest req)

Add an asynchronous request to the list of pending requests

Parameters:

req - AsynchRequest

removeAsynchronousRequest

protected final AsynchRequest removeAsynchronousRequest(int id)

Remove an asynchronous request from the pending list

Parameters:

id - int

Returns:

AsynchRequest

removeAsynchronousRequest

protected final AsynchRequest removeAsynchronousRequest(AsynchRequest req)

Remove an asynchronous request from the pending list

Parameters:

req - AsynchRequest

Returns:

AsynchRequest

NTCreateInternal

protected final CIFSFile NTCreateInternal(String name,
                        int createFlags,
                        int access,
                        int attrib,
                        int sharing,
                        int exists,
                        long initSize,
                        int createOpt,
                        boolean throwErr)
                                   throws IOException,
                                          SMBException

Perform an NTCreateAndX SMB to create/open a file or directory

Parameters:

name - File/directory name

createFlags - int

access - Desired access mode.

attrib - Required file attributes.

sharing - Shared access mode

exists - Action to take if file/directory exists.

initSize - Initial file allocation size, in bytes

createOpt - Create file options

throwErr - Throw errors from the CIFS packet exchange

Returns:

CIFSFile

Throws:

IOException

SMBException - If an SMB level error occurs

See Also:

AccessMode, FileAttribute, FileAction

fileClosed

protected final void fileClosed(CIFSFile cifsFile)

File closed, remove from the oplocked file list

Parameters:

cifsFile - CIFSFile