Package com.hierynomus.smbj.share

Class File

java.lang.Object

com.hierynomus.smbj.share.Open<DiskShare>

com.hierynomus.smbj.share.DiskEntry

com.hierynomus.smbj.share.File

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class File
extends DiskEntry

Nested Class Summary

Nested classes/interfaces inherited from class com.hierynomus.smbj.share.Open

Open.LockBuilder

Field Summary

Fields inherited from class com.hierynomus.smbj.share.DiskEntry

logger

Fields inherited from class com.hierynomus.smbj.share.Open

fileId, name, share

Method Summary

Modifier and Type	Method	Description
java.io.InputStream	getInputStream()
java.io.InputStream	getInputStream(ProgressListener listener)
java.io.OutputStream	getOutputStream()
java.io.OutputStream	getOutputStream(boolean append)
java.io.OutputStream	getOutputStream(ProgressListener listener)
java.io.OutputStream	getOutputStream(ProgressListener listener, boolean append)
int	read(byte[] buffer, long fileOffset)	Read data from this file starting at position fileOffset into the given buffer.
int	read(byte[] buffer, long fileOffset, int offset, int length)	Read data from this file starting at position fileOffset into the given buffer.
void	read(java.io.OutputStream destStream)
void	read(java.io.OutputStream destStream, ProgressListener progressListener)
long	read(java.nio.ByteBuffer buffer, long fileOffset)	Read data from this file starting at position fileOffset into the given ByteBuffer.
void	remoteCopyTo(long offset, File destination, long destinationOffset, long length)	Copies the byte range [offset, length] of this file to the range [destinationOffset, length] of the given destination file.
void	remoteCopyTo(File destination)	Performs a remote file copy of this file to the given file.
void	setLength(long endOfFile)	The function for truncate or set file length for a file
java.lang.String	toString()
long	write(byte[] buffer, long fileOffset)	Write the data in buffer to this file at position fileOffset.
long	write(byte[] buffer, long fileOffset, int offset, int length)	Write the data in buffer to this file at position fileOffset.
long	write(ByteChunkProvider provider)	Write all available data from the byte chunk provider to this file.
long	write(ByteChunkProvider provider, ProgressListener progressListener)	Write all available data from the byte chunk provider to this file.
long	write(java.nio.ByteBuffer buffer, long fileOffset)	Write the data in a ByteBuffer to this file at position fileOffset.
java.util.concurrent.Future<java.lang.Long>	writeAsync(byte[] buffer, long fileOffset, int offset, int length)	Write the data Async in buffer to this file at position fileOffset.
java.util.concurrent.Future<java.lang.Long>	writeAsync(ByteChunkProvider provider)	Async Write all available data from the byte chunk provider to this file.

Methods inherited from class com.hierynomus.smbj.share.DiskEntry

closeNoWait, createHardlink, createHardlink, deleteOnClose, equals, flush, getDiskShare, getFileInformation, getFileInformation, getFileName, getPath, getSecurityInformation, getUncPath, hashCode, ioctl, ioctl, ioctl, rename, rename, rename, setFileInformation, setSecurityInformation, setSecurityInformation

Methods inherited from class com.hierynomus.smbj.share.Open

close, closeSilently, getFileId, requestLock

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

write

public long write(byte[] buffer,
                  long fileOffset)

Write the data in buffer to this file at position fileOffset.

Parameters:

buffer - the data to write

fileOffset - The offset, in bytes, into the file to which the data should be written

Returns:

the actual number of bytes that was written to the file

write

public long write(byte[] buffer,
                  long fileOffset,
                  int offset,
                  int length)

Write the data in buffer to this file at position fileOffset.

Parameters:

buffer - the data to write

fileOffset - The offset, in bytes, into the file to which the data should be written

offset - the start offset in the data

length - the number of bytes that are written

Returns:

the actual number of bytes that was written to the file

write

public long write(ByteChunkProvider provider)

Write all available data from the byte chunk provider to this file. The offset in the file to which data is written is determined by ByteChunkProvider.getOffset().

Parameters:

provider - the byte chunk provider

Returns:

the actual number of bytes that was written to the file

write

public long write(ByteChunkProvider provider,
                  ProgressListener progressListener)

Write all available data from the byte chunk provider to this file. The offset in the file to which data is written is determined by ByteChunkProvider.getOffset().

Parameters:

provider - the byte chunk provider

progressListener - an optional callback that will be invoked when data has been written to the file

Returns:

the actual number of bytes that was written to the file

writeAsync

public java.util.concurrent.Future<java.lang.Long> writeAsync(byte[] buffer,
                                                              long fileOffset,
                                                              int offset,
                                                              int length)

Write the data Async in buffer to this file at position fileOffset.

Parameters:

buffer - the data to write

fileOffset - The offset, in bytes, into the file to which the data should be written

offset - the start offset in the data

length - the number of bytes that are written

Returns:

A Future containing the total number of bytes written to the remote.

writeAsync

public java.util.concurrent.Future<java.lang.Long> writeAsync(ByteChunkProvider provider)

Async Write all available data from the byte chunk provider to this file. The offset in the file to which data is written is determined by ByteChunkProvider.getOffset().

Parameters:

provider - the byte chunk provider

Returns:

A future containing the total number of bytes written to the remote.

getOutputStream

public java.io.OutputStream getOutputStream()

getOutputStream

public java.io.OutputStream getOutputStream(boolean append)

getOutputStream

public java.io.OutputStream getOutputStream(ProgressListener listener)

getOutputStream

public java.io.OutputStream getOutputStream(ProgressListener listener,
                                            boolean append)

read

public int read(byte[] buffer,
                long fileOffset)

Read data from this file starting at position fileOffset into the given buffer.

Parameters:

buffer - the buffer to write into

fileOffset - The offset, in bytes, into the file from which the data should be read

Returns:

the actual number of bytes that were read; or -1 if the end of the file was reached

read

public int read(byte[] buffer,
                long fileOffset,
                int offset,
                int length)

Read data from this file starting at position fileOffset into the given buffer.

Parameters:

buffer - the buffer to write into

fileOffset - The offset, in bytes, into the file from which the data should be read

offset - the start offset in the buffer at which to write data

length - the maximum number of bytes to read

Returns:

the actual number of bytes that were read; or -1 if the end of the file was reached

read

public void read(java.io.OutputStream destStream)
          throws java.io.IOException

Throws:

java.io.IOException

read

public void read(java.io.OutputStream destStream,
                 ProgressListener progressListener)
          throws java.io.IOException

Throws:

java.io.IOException

write

public long write(java.nio.ByteBuffer buffer,
                  long fileOffset)

Write the data in a ByteBuffer to this file at position fileOffset.

Parameters:

buffer - the data to write

fileOffset - The offset, in bytes, into the file to which the data should be written

Returns:

the actual number of bytes that was written to the file

read

public long read(java.nio.ByteBuffer buffer,
                 long fileOffset)

Read data from this file starting at position fileOffset into the given ByteBuffer.

Parameters:

buffer - the ByteBuffer to write into

fileOffset - The offset, in bytes, into the file from which the data should be read

Returns:

the actual number of bytes that were read; or -1 if the end of the file was reached

remoteCopyTo

public void remoteCopyTo(File destination)
                  throws Buffer.BufferException,
                         TransportException

Performs a remote file copy of this file to the given file.

This method is equivalent to calling remoteCopyTo(0, destination, 0, sourceFileSize).

Parameters:

destination - the destination file

Throws:

Buffer.BufferException

TransportException

remoteCopyTo

public void remoteCopyTo(long offset,
                         File destination,
                         long destinationOffset,
                         long length)
                  throws Buffer.BufferException,
                         TransportException

Copies the byte range [offset, length] of this file to the range [destinationOffset, length] of the given destination file.

Parameters:

destination - the destination file

Throws:

Buffer.BufferException

TransportException

setLength

public void setLength(long endOfFile)
               throws SMBApiException

The function for truncate or set file length for a file

Parameters:

endOfFile - 64-bit signed integer in bytes, MUST be greater than or equal to 0

Throws:

SMBApiException

getInputStream

public java.io.InputStream getInputStream()

getInputStream

public java.io.InputStream getInputStream(ProgressListener listener)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object