Module jcifs

Package org.codelibs.jcifs.smb1

Class SmbRandomAccessFile

java.lang.Object

org.codelibs.jcifs.smb1.SmbRandomAccessFile

All Implemented Interfaces:

DataInput, DataOutput

public class SmbRandomAccessFile
extends Object
implements DataOutput, DataInput

This class provides random access to files stored on an SMB/CIFS network resource. It implements the DataInput and DataOutput interfaces for reading and writing primitive Java data types to the file.

Constructor Summary

Constructors

Constructor	Description
SmbRandomAccessFile(String url, String mode, int shareAccess)	Constructs an SmbRandomAccessFile with the specified URL, mode, and share access flags.
SmbRandomAccessFile(SmbFile file, String mode)	Constructs an SmbRandomAccessFile from an existing SmbFile with the specified access mode.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the file and releases any system resources associated with it.
long	getFilePointer()	Returns the current position of the file pointer.
long	length()	Returns the length of the file.
int	read()	Reads a single byte from the file at the current file pointer position.
int	read(byte[] b)	Reads bytes from the file into the specified byte array.
int	read(byte[] b, int off, int len)	Reads up to len bytes from the file into the specified byte array.
final boolean	readBoolean()
final byte	readByte()
final char	readChar()
final double	readDouble()
final float	readFloat()
final void	readFully(byte[] b)
final void	readFully(byte[] b, int off, int len)
final int	readInt()
final String	readLine()
final long	readLong()
final short	readShort()
final int	readUnsignedByte()
final int	readUnsignedShort()
final String	readUTF()
void	seek(long pos)	Sets the file pointer to the specified position.
void	setLength(long newLength)	Sets the length of the file.
int	skipBytes(int n)
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)
final void	writeBoolean(boolean v)
final void	writeByte(int v)
final void	writeBytes(String s)
final void	writeChar(int v)
final void	writeChars(String s)
final void	writeDouble(double v)
final void	writeFloat(float v)
final void	writeInt(int v)
final void	writeLong(long v)
final void	writeShort(int v)
final void	writeUTF(String str)

Methods inherited from class java.lang.Object

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

Constructor Details

SmbRandomAccessFile

public SmbRandomAccessFile(String url,
 String mode,
 int shareAccess)
                    throws SmbException,
MalformedURLException,
UnknownHostException

Constructs an SmbRandomAccessFile with the specified URL, mode, and share access flags.

Parameters:

url - the SMB URL of the file to access

mode - the access mode ("r" for read-only, "rw" for read-write)

shareAccess - the share access flags for file sharing

Throws:

SmbException - if an SMB error occurs

MalformedURLException - if the URL is malformed

UnknownHostException - if the host cannot be resolved

SmbRandomAccessFile

public SmbRandomAccessFile(SmbFile file,
 String mode)
                    throws SmbException,
MalformedURLException,
UnknownHostException

Constructs an SmbRandomAccessFile from an existing SmbFile with the specified access mode.

Parameters:

file - the SmbFile to access

mode - the access mode ("r" for read-only, "rw" for read-write)

Throws:

SmbException - if an SMB error occurs

MalformedURLException - if the URL is malformed

UnknownHostException - if the host cannot be resolved

Method Details

read

public int read()
         throws SmbException

Reads a single byte from the file at the current file pointer position.

Returns:

the byte read as an integer (0-255), or -1 if end of file is reached

Throws:

SmbException - if an I/O error occurs

read

public int read(byte[] b)
         throws SmbException

Reads bytes from the file into the specified byte array.

Parameters:

b - the byte array to read data into

Returns:

the number of bytes read, or -1 if end of file is reached

Throws:

SmbException - if an I/O error occurs

read

public int read(byte[] b,
 int off,
 int len)
         throws SmbException

Reads up to len bytes from the file into the specified byte array.

Parameters:

b - the byte array to read data into

off - the offset in the array at which to start storing bytes

len - the maximum number of bytes to read

Returns:

the number of bytes read, or -1 if end of file is reached

Throws:

SmbException - if an I/O error occurs

readFully

public final void readFully(byte[] b)
                     throws SmbException

Specified by:

readFully in interface DataInput

Throws:

SmbException

readFully

public final void readFully(byte[] b,
 int off,
 int len)
                     throws SmbException

Specified by:

readFully in interface DataInput

Throws:

SmbException

skipBytes

public int skipBytes(int n)
              throws SmbException

Specified by:

skipBytes in interface DataInput

Throws:

SmbException

write

public void write(int b)
           throws SmbException

Specified by:

write in interface DataOutput

Throws:

SmbException

write

public void write(byte[] b)
           throws SmbException

Specified by:

write in interface DataOutput

Throws:

SmbException

write

public void write(byte[] b,
 int off,
 int len)
           throws SmbException

Specified by:

write in interface DataOutput

Throws:

SmbException

getFilePointer

public long getFilePointer()
                    throws SmbException

Returns the current position of the file pointer.

Returns:

the current file pointer position

Throws:

SmbException - if an I/O error occurs

seek

public void seek(long pos)
          throws SmbException

Sets the file pointer to the specified position.

Parameters:

pos - the new file pointer position

Throws:

SmbException - if an I/O error occurs

length

public long length()
            throws SmbException

Returns the length of the file.

Returns:

the file length in bytes

Throws:

SmbException - if an I/O error occurs

setLength

public void setLength(long newLength)
               throws SmbException

Sets the length of the file. The file will be truncated or extended as necessary.

Parameters:

newLength - the new file length in bytes

Throws:

SmbException - if an I/O error occurs

close

public void close()
           throws SmbException

Closes the file and releases any system resources associated with it.

Throws:

SmbException - if an I/O error occurs

readBoolean

public final boolean readBoolean()
                          throws SmbException

Specified by:

readBoolean in interface DataInput

Throws:

SmbException

readByte

public final byte readByte()
                    throws SmbException

Specified by:

readByte in interface DataInput

Throws:

SmbException

readUnsignedByte

public final int readUnsignedByte()
                           throws SmbException

Specified by:

readUnsignedByte in interface DataInput

Throws:

SmbException

readShort

public final short readShort()
                      throws SmbException

Specified by:

readShort in interface DataInput

Throws:

SmbException

readUnsignedShort

public final int readUnsignedShort()
                            throws SmbException

Specified by:

readUnsignedShort in interface DataInput

Throws:

SmbException

readChar

public final char readChar()
                    throws SmbException

Specified by:

readChar in interface DataInput

Throws:

SmbException

readInt

public final int readInt()
                  throws SmbException

Specified by:

readInt in interface DataInput

Throws:

SmbException

readLong

public final long readLong()
                    throws SmbException

Specified by:

readLong in interface DataInput

Throws:

SmbException

readFloat

public final float readFloat()
                      throws SmbException

Specified by:

readFloat in interface DataInput

Throws:

SmbException

readDouble

public final double readDouble()
                        throws SmbException

Specified by:

readDouble in interface DataInput

Throws:

SmbException

readLine

public final String readLine()
                      throws SmbException

Specified by:

readLine in interface DataInput

Throws:

SmbException

readUTF

public final String readUTF()
                     throws SmbException

Specified by:

readUTF in interface DataInput

Throws:

SmbException

writeBoolean

public final void writeBoolean(boolean v)
                        throws SmbException

Specified by:

writeBoolean in interface DataOutput

Throws:

SmbException

writeByte

public final void writeByte(int v)
                     throws SmbException

Specified by:

writeByte in interface DataOutput

Throws:

SmbException

writeShort

public final void writeShort(int v)
                      throws SmbException

Specified by:

writeShort in interface DataOutput

Throws:

SmbException

writeChar

public final void writeChar(int v)
                     throws SmbException

Specified by:

writeChar in interface DataOutput

Throws:

SmbException

writeInt

public final void writeInt(int v)
                    throws SmbException

Specified by:

writeInt in interface DataOutput

Throws:

SmbException

writeLong

public final void writeLong(long v)
                     throws SmbException

Specified by:

writeLong in interface DataOutput

Throws:

SmbException

writeFloat

public final void writeFloat(float v)
                      throws SmbException

Specified by:

writeFloat in interface DataOutput

Throws:

SmbException

writeDouble

public final void writeDouble(double v)
                       throws SmbException

Specified by:

writeDouble in interface DataOutput

Throws:

SmbException

writeBytes

public final void writeBytes(String s)
                      throws SmbException

Specified by:

writeBytes in interface DataOutput

Throws:

SmbException

writeChars

public final void writeChars(String s)
                      throws SmbException

Specified by:

writeChars in interface DataOutput

Throws:

SmbException

writeUTF

public final void writeUTF(String str)
                    throws SmbException

Specified by:

writeUTF in interface DataOutput

Throws:

SmbException