org.alfresco.jlan.client

Class SMBInputStream

java.lang.Object

java.io.InputStream

org.alfresco.jlan.client.SMBInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class SMBInputStream
extends java.io.InputStream

SMB input stream class.

The SMBInputStream class provides a standard InputStream interface to a remote file.

The class may be used with other I/O stream classes such as InputStreamReader, DataInputStream etc.

Note: It is not necessary to use a BufferedInputStream or BufferedReader class with the SMBInputStream as the underlying network connection will usually buffer 4Kb of data, up to a maximum of 64Kb.

Example use of the SMBInputStream class

PCShare shr = new PCShare ( "\\\\TEST\\C\\");
DiskSession sess = SessionFactory.OpenDisk ( shr);
SMBInputStream in = sess.OpenInputStream ( "DATAFILE.IN", AccessMode.ReadOnly);
LineNumberReader lnRdr = new LineNumberReader ( new InputStreamReader ( in));
String inRec = null;
while (( inRec = lnRdr.readLine ()) != null)
System.out.println ( lnRdr.getLineNumber () + ": " + inRec);
in.close ();

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SMBInputStream(SMBFile sfile) Construct an SMB input stream attached to the specified SMB file.

Method Summary

Methods

Modifier and Type	Method and Description
int	available() Return the number of bytes that can be read from this input stream without blocking.
void	close() Close the input stream and release any system resources associated with the stream.
SMBFile	File() Return a reference to the associated SMBFile object.
void	mark(int readLimit) Mark the current file position
boolean	markSupported() Determine if mark is supported
int	read() Read a byte of data from the input stream.
int	read(byte[] buf, int off, int len) Read a block of bytes from the input stream.
void	reset() Reset the file pointer to the previous marked position
int	skip(int n) Skip over a number of bytes in the input stream.

Methods inherited from class java.io.InputStream

read, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

SMBInputStream

protected SMBInputStream(SMBFile sfile)

Construct an SMB input stream attached to the specified SMB file.

Parameters:

sfile - SMBFile that this input stream is associated with.

Method Detail

available

public int available()
              throws java.io.IOException

Return the number of bytes that can be read from this input stream without blocking.

Overrides:

available in class java.io.InputStream

Returns:

Number of bytes that can be read without the input stream blocking.

Throws:

java.io.IOException - If an I/O error occurs.

close

public void close()
           throws java.io.IOException

Close the input stream and release any system resources associated with the stream.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException - If an I/O error occurs.

File

public final SMBFile File()

Return a reference to the associated SMBFile object.

Returns:

SMBFile associated with this input stream.

read

public int read()
         throws java.io.IOException

Read a byte of data from the input stream.

Specified by:

read in class java.io.InputStream

Returns:

The next byte of data, or -1 if the end of file has been reached.

Throws:

java.io.IOException - If an I/O error occurs.

read

public int read(byte[] buf,
       int off,
       int len)
         throws java.io.IOException

Read a block of bytes from the input stream.

Overrides:

read in class java.io.InputStream

Parameters:

buf - The buffer to read the data into.

off - The start offset to place the received data.

len - The maximum number of bytes to read.

Returns:

The number of bytes read into the buffer, or -1 if the end of file has been reached.

Throws:

java.io.IOException - If an I/O error occurs.

skip

public int skip(int n)
         throws java.io.IOException

Skip over a number of bytes in the input stream.

Parameters:

n - Number of bytes to skip.

Returns:

The actual number of bytes skipped.

Throws:

java.io.IOException - If an I/O error occurs.

mark

public void mark(int readLimit)

Mark the current file position

Overrides:

mark in class java.io.InputStream

Parameters:

readLimit - int

markSupported

public boolean markSupported()

Determine if mark is supported

Overrides:

markSupported in class java.io.InputStream

Returns:

boolean

reset

public void reset()
           throws java.io.IOException

Reset the file pointer to the previous marked position

Overrides:

reset in class java.io.InputStream

Throws:

java.io.IOException