Module jcifs

Package org.codelibs.jcifs.smb.impl

Class SmbRandomAccessFile

java.lang.Object

org.codelibs.jcifs.smb.impl.SmbRandomAccessFile

All Implemented Interfaces:

DataInput, DataOutput, AutoCloseable, SmbRandomAccess

public class SmbRandomAccessFile
extends Object
implements SmbRandomAccess

Random access file implementation for SMB resources. Provides random read/write access to SMB files with support for seeking and positioning.

Constructor Summary

Constructors

Constructor	Description
SmbRandomAccessFile(String url, String mode, int sharing, CIFSContext tc)	Instantiate a random access file from URL
SmbRandomAccessFile(SmbFile file, String mode)	Instantiate a random access file from a SmbFile

Method Summary

Modifier and Type	Method	Description
void	close()	Close the file
long	getFilePointer()	Current position in file
long	length()	Get the current file length
void	open()	Ensures that the file descriptor is openend
int	read()	Read a single byte from the current position
int	read(byte[] b)	Read into buffer from current position
int	read(byte[] b, int off, int len)	Read into buffer from current position
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)	Seek to new position
void	setLength(long newLength)	Expand/truncate file length
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 sharing,
 CIFSContext tc)
                    throws SmbException,
MalformedURLException

Instantiate a random access file from URL

Parameters:

url - the SMB URL of the file to access

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

sharing - the sharing flags for file access

tc - the CIFS context to use for the connection

Throws:

SmbException - if an SMB error occurs

MalformedURLException - if the URL is malformed

SmbRandomAccessFile

public SmbRandomAccessFile(SmbFile file,
 String mode)
                    throws SmbException

Instantiate a random access file from a SmbFile

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

Method Details

open

public void open()
          throws CIFSException

Ensures that the file descriptor is openend

Throws:

CIFSException - if an error occurs opening the file

close

public void close()
           throws SmbException

Description copied from interface: SmbRandomAccess

Close the file

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SmbRandomAccess

Throws:

SmbException - if an I/O error occurs during close

read

public int read()
         throws SmbException

Description copied from interface: SmbRandomAccess

Read a single byte from the current position

Specified by:

read in interface SmbRandomAccess

Returns:

read byte, -1 if EOF

Throws:

SmbException - if an I/O error occurs during read

read

public int read(byte[] b)
         throws SmbException

Description copied from interface: SmbRandomAccess

Read into buffer from current position

Specified by:

read in interface SmbRandomAccess

Parameters:

b - buffer

Returns:

number of bytes read

Throws:

SmbException - if an I/O error occurs during read

read

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

Description copied from interface: SmbRandomAccess

Read into buffer from current position

Specified by:

read in interface SmbRandomAccess

Parameters:

b - buffer

off - offset into buffer

len - read up to len bytes

Returns:

number of bytes read

Throws:

SmbException - if an I/O error occurs during read

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()

Description copied from interface: SmbRandomAccess

Current position in file

Specified by:

getFilePointer in interface SmbRandomAccess

Returns:

current position

seek

public void seek(long pos)

Description copied from interface: SmbRandomAccess

Seek to new position

Specified by:

seek in interface SmbRandomAccess

Parameters:

pos - the new position to seek to

length

public long length()
            throws SmbException

Description copied from interface: SmbRandomAccess

Get the current file length

Specified by:

length in interface SmbRandomAccess

Returns:

file length

Throws:

SmbException - if an I/O error occurs

setLength

public void setLength(long newLength)
               throws SmbException

Description copied from interface: SmbRandomAccess

Expand/truncate file length

Specified by:

setLength in interface SmbRandomAccess

Parameters:

newLength - new file length

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