org.alfresco.jlan.client

Class CoreFile

java.lang.Object

org.alfresco.jlan.client.SMBFile

org.alfresco.jlan.client.CoreFile

public class CoreFile
extends SMBFile

SMB core file class

Author:

gkspencer

Field Summary

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

Closed, EndOfFile, m_FID, m_rxlen, m_rxoffset, m_rxpkt, m_rxpos, m_sess, m_txlen, m_txoffset, m_txpkt, m_txpos

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CoreFile(Session sess, FileInfo finfo, int fid) Class constructor

Method Summary

Modifier and Type	Method and Description
void	Close(SMBDate wrDateTime) Close the remote file.
void	Flush() Flush data to the remote file.
void	Lock(long offset, long len) Lock a range of bytes within the file
int	Read(byte[] buf, int siz, int offset) Read a block of data from the file.
long	Seek(long pos, int typ) Seek to the specified point in the file.
void	Unlock(long offset, long len) Unlock a range of bytes within the file
int	Write(byte[] buf, int siz, int offset) Write a block of data to the file.

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

asInputStream, asOutputStream, atEndOfFile, Available, clearEndOfFile, Close, finalize, getAttributes, getFileId, getFileName, getFilePath, getFileSize, getReadPosition, getSession, getWritePosition, hasStateFlag, isClosed, isDirectory, isHidden, isReadOnly, isSystem, Read, refreshFileInformation, setFileInformation, setStateFlag, toString, Write, Write

Methods inherited from class java.lang.Object

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

Constructor Detail

CoreFile

protected CoreFile(Session sess,
                   FileInfo finfo,
                   int fid)

Class constructor

Parameters:

sess - Session that this file is associated with

finfo - File information for the new file

fid - File identifier for this file

Method Detail

Close

public void Close(SMBDate wrDateTime)
           throws IOException,
                  SMBException

Close the remote file.

Specified by:

Close in class SMBFile

Parameters:

wrDateTime - Set the last write date/time, or null to let the server set the date/time

Throws:

IOException - If an I/O error occurs

SMBException - If an SMB level error occurs

Flush

public void Flush()
           throws IOException,
                  SMBException

Flush data to the remote file.

Specified by:

Flush in class SMBFile

Throws:

IOException - If an I/O error occurs

SMBException - If an SMB level error occurs

Read

public int Read(byte[] buf,
                int siz,
                int offset)
         throws IOException,
                SMBException

Read a block of data from the file.

Specified by:

Read in class SMBFile

Parameters:

buf - Byte buffer to receive the data.

siz - Maximum length of data to receive.

offset - Offset within buffer to place received data.

Returns:

Actual length of data received.

Throws:

IOException - If an I/O error occurs

SMBException - If an SMB level error occurs

Write

public int Write(byte[] buf,
                 int siz,
                 int offset)
          throws IOException,
                 SMBException

Write a block of data to the file.

Specified by:

Write in class SMBFile

Parameters:

buf - Byte buffer containing data to be written.

siz - Length of data to be written.

offset - Offset within buffer to start writing data from.

Returns:

Actual length of data written.

Throws:

IOException - If an I/O error occurs

SMBException - If an SMB level error occurs

Seek

public long Seek(long pos,
                 int typ)
          throws IOException,
                 SMBException

Seek to the specified point in the file. The seek may be relative to the start of file, current file position or end of file.

Specified by:

Seek in class SMBFile

Parameters:

pos - Relative offset

typ - Seek type (@see org.alfresco.jlan.smb.SeekType)

Returns:

New file offset from start of file

Throws:

IOException

SMBException - If an SMB level error occurs

Lock

public void Lock(long offset,
                 long len)
          throws IOException,
                 SMBException

Lock a range of bytes within the file

Specified by:

Lock in class SMBFile

Parameters:

offset - Offset within the file to start lock

len - Number of bytes to lock

Throws:

IOException

SMBException - If an SMB level error occurs

Unlock

public void Unlock(long offset,
                   long len)
            throws IOException,
                   SMBException

Unlock a range of bytes within the file

Specified by:

Unlock in class SMBFile

Parameters:

offset - Offset within the file to unlock

len - Number of bytes to unlock

Throws:

IOException

SMBException - If an SMB level error occurs