Class Share

java.lang.Object

com.hierynomus.smbj.share.Share

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

DiskShare, PipeShare, PrinterShare

public class Share
extends Object
implements AutoCloseable

Field Summary

Fields

Modifier and Type	Field	Description
private final SMB2Dialect	dialect
private final AtomicBoolean	disconnected
private static final EmptyByteChunkProvider	EMPTY
private final int	readBufferSize
private final long	readTimeout
private static final SMB2FileId	ROOT_ID
protected Session	session
private final long	sessionId
protected final SmbPath	smbPath
private static final StatusHandler	SUCCESS_OR_CLOSED
private static final StatusHandler	SUCCESS_OR_EOF
private static final StatusHandler	SUCCESS_OR_NO_MORE_FILES_OR_NO_SUCH_FILE
private static final StatusHandler	SUCCESS_OR_SYMLINK
private final int	transactBufferSize
private final long	transactTimeout
protected final TreeConnect	treeConnect
private final long	treeId
private final int	writeBufferSize
private final long	writeTimeout

Constructor Summary

Constructors

Constructor	Description
Share(SmbPath smbPath, TreeConnect treeConnect)

Method Summary

Modifier and Type	Method	Description
(package private) Future<SMB2ChangeNotifyResponse>	changeNotifyAsync(SMB2FileId fileId, Set<SMB2CompletionFilter> completionFilter, Set<SMB2ChangeNotifyFlags> flags)
void	close()
(package private) void	closeFileId(SMB2FileId fileId)
(package private) Future<SMB2Close>	closeFileIdNoWait(SMB2FileId fileId)
(package private) SMB2CreateResponse	createFile(SmbPath path, SMB2ImpersonationLevel impersonationLevel, Set<AccessMask> accessMask, Set<FileAttributes> fileAttributes, Set<SMB2ShareAccess> shareAccess, SMB2CreateDisposition createDisposition, Set<SMB2CreateOptions> createOptions)
boolean	equals(Object obj)
(package private) void	flush(SMB2FileId fileId)
protected StatusHandler	getCreateStatusHandler()
(package private) SMB2Dialect	getDialect()
(package private) int	getReadBufferSize()
(package private) long	getReadTimeout()
SmbPath	getSmbPath()
TreeConnect	getTreeConnect()
(package private) int	getWriteBufferSize()
int	hashCode()
byte[]	ioctl(long ctlCode, boolean isFsCtl, byte[] inData)	Sends a control code directly to a specified device driver, causing the corresponding device to perform the corresponding operation.
byte[]	ioctl(long ctlCode, boolean isFsCtl, byte[] inData, int inOffset, int inLength)	Sends a control code directly to a specified device driver, causing the corresponding device to perform the corresponding operation.
int	ioctl(long ctlCode, boolean isFsCtl, byte[] inData, int inOffset, int inLength, byte[] outData, int outOffset, int outLength)	Sends a control code directly to a specified device driver, causing the corresponding device to perform the corresponding operation.
(package private) byte[]	ioctl(SMB2FileId fileId, long ctlCode, boolean isFsCtl, byte[] inData, int inOffset, int inLength)
(package private) int	ioctl(SMB2FileId fileId, long ctlCode, boolean isFsCtl, byte[] inData, int inOffset, int inLength, byte[] outData, int outOffset, int outLength)
(package private) byte[]	ioctl(SMB2FileId fileId, long ctlCode, boolean isFsCtl, byte[] inData, int inOffset, int inLength, int maxOutputResponse)
(package private) SMB2IoctlResponse	ioctl(SMB2FileId fileId, long ctlCode, boolean isFsCtl, ByteChunkProvider inputData, int maxOutputResponse)
Future<SMB2IoctlResponse>	ioctlAsync(long ctlCode, boolean isFsCtl, ByteChunkProvider inputData)
(package private) Future<SMB2IoctlResponse>	ioctlAsync(SMB2FileId fileId, long ctlCode, boolean isFsCtl, ByteChunkProvider inputData, int maxOutputResponse)
boolean	isConnected()
(package private) SMB2FileId	openFileId(SmbPath path, SMB2ImpersonationLevel impersonationLevel, Set<AccessMask> accessMask, Set<FileAttributes> fileAttributes, Set<SMB2ShareAccess> shareAccess, SMB2CreateDisposition createDisposition, Set<SMB2CreateOptions> createOptions)
(package private) SMB2QueryDirectoryResponse	queryDirectory(SMB2FileId fileId, Set<SMB2QueryDirectoryRequest.SMB2QueryDirectoryFlags> flags, FileInformationClass informationClass, String searchPattern)
SMB2QueryInfoResponse	queryInfo(SMB2FileId fileId, SMB2QueryInfoRequest.SMB2QueryInfoType infoType, Set<SecurityInformation> securityInfo, FileInformationClass fileInformationClass, FileSystemInformationClass fileSystemInformationClass)
(package private) SMB2ReadResponse	read(SMB2FileId fileId, long offset, int length)
(package private) Future<SMB2ReadResponse>	readAsync(SMB2FileId fileId, long offset, int length)
(package private) <T extends SMB2Packet> T	receive(Future<T> fut, long timeout)
(package private) <T extends SMB2Packet> T	receive(Future<T> fut, String name, Object target, StatusHandler statusHandler, long timeout)
private <T extends SMB2Packet> Future<T>	send(SMB2Packet request)
(package private) SMB2LockResponse	sendLockRequest(SMB2FileId fileId, short lockSequenceNumber, int lockSequenceIndex, List<SMB2LockElement> lockElements)
private <T extends SMB2Packet> T	sendReceive(SMB2Packet request, String name, Object target, StatusHandler statusHandler, long timeout)
(package private) void	setInfo(SMB2FileId fileId, SMB2SetInfoRequest.SMB2InfoType infoType, Set<SecurityInformation> securityInfo, FileInformationClass fileInformationClass, byte[] buffer)
(package private) SMB2WriteResponse	write(SMB2FileId fileId, ByteChunkProvider provider)
(package private) Future<SMB2WriteResponse>	writeAsync(SMB2FileId fileId, ByteChunkProvider provider)

Methods inherited from class Object

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

Field Details

ROOT_ID

private static final SMB2FileId ROOT_ID

SUCCESS_OR_SYMLINK

private static final StatusHandler SUCCESS_OR_SYMLINK

SUCCESS_OR_NO_MORE_FILES_OR_NO_SUCH_FILE

private static final StatusHandler SUCCESS_OR_NO_MORE_FILES_OR_NO_SUCH_FILE

SUCCESS_OR_EOF

private static final StatusHandler SUCCESS_OR_EOF

SUCCESS_OR_CLOSED

private static final StatusHandler SUCCESS_OR_CLOSED

smbPath

protected final SmbPath smbPath

treeConnect

protected final TreeConnect treeConnect

treeId

private final long treeId

session

protected Session session

dialect

private final SMB2Dialect dialect

readBufferSize

private final int readBufferSize

readTimeout

private final long readTimeout

writeBufferSize

private final int writeBufferSize

writeTimeout

private final long writeTimeout

transactBufferSize

private final int transactBufferSize

transactTimeout

private final long transactTimeout

sessionId

private final long sessionId

disconnected

private final AtomicBoolean disconnected

EMPTY

private static final EmptyByteChunkProvider EMPTY

Constructor Details

Share

Share(SmbPath smbPath,
 TreeConnect treeConnect)

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException

isConnected

public boolean isConnected()

getSmbPath

public SmbPath getSmbPath()

getTreeConnect

public TreeConnect getTreeConnect()

getReadBufferSize

int getReadBufferSize()

getReadTimeout

long getReadTimeout()

getWriteBufferSize

int getWriteBufferSize()

openFileId

SMB2FileId openFileId(SmbPath path,
 SMB2ImpersonationLevel impersonationLevel,
 Set<AccessMask> accessMask,
 Set<FileAttributes> fileAttributes,
 Set<SMB2ShareAccess> shareAccess,
 SMB2CreateDisposition createDisposition,
 Set<SMB2CreateOptions> createOptions)

createFile

SMB2CreateResponse createFile(SmbPath path,
 SMB2ImpersonationLevel impersonationLevel,
 Set<AccessMask> accessMask,
 Set<FileAttributes> fileAttributes,
 Set<SMB2ShareAccess> shareAccess,
 SMB2CreateDisposition createDisposition,
 Set<SMB2CreateOptions> createOptions)

getCreateStatusHandler

protected StatusHandler getCreateStatusHandler()

flush

void flush(SMB2FileId fileId)
    throws SMBApiException

Throws:

SMBApiException

closeFileId

void closeFileId(SMB2FileId fileId)
          throws SMBApiException

Throws:

SMBApiException

closeFileIdNoWait

Future<SMB2Close> closeFileIdNoWait(SMB2FileId fileId)
                             throws SMBApiException

Throws:

SMBApiException

queryInfo

public SMB2QueryInfoResponse queryInfo(SMB2FileId fileId,
 SMB2QueryInfoRequest.SMB2QueryInfoType infoType,
 Set<SecurityInformation> securityInfo,
 FileInformationClass fileInformationClass,
 FileSystemInformationClass fileSystemInformationClass)

setInfo

void setInfo(SMB2FileId fileId,
 SMB2SetInfoRequest.SMB2InfoType infoType,
 Set<SecurityInformation> securityInfo,
 FileInformationClass fileInformationClass,
 byte[] buffer)

queryDirectory

SMB2QueryDirectoryResponse queryDirectory(SMB2FileId fileId,
 Set<SMB2QueryDirectoryRequest.SMB2QueryDirectoryFlags> flags,
 FileInformationClass informationClass,
 String searchPattern)

write

SMB2WriteResponse write(SMB2FileId fileId,
 ByteChunkProvider provider)

writeAsync

Future<SMB2WriteResponse> writeAsync(SMB2FileId fileId,
 ByteChunkProvider provider)

read

SMB2ReadResponse read(SMB2FileId fileId,
 long offset,
 int length)

readAsync

Future<SMB2ReadResponse> readAsync(SMB2FileId fileId,
 long offset,
 int length)

ioctl

public byte[] ioctl(long ctlCode,
 boolean isFsCtl,
 byte[] inData)

Sends a control code directly to a specified device driver, causing the corresponding device to perform the corresponding operation.

Parameters:

ctlCode - the control code

isFsCtl - true if the control code is an FSCTL; false if it is an IOCTL

inData - the control code dependent input data

Returns:

the response data or null if the control code did not produce a response

ioctl

public byte[] ioctl(long ctlCode,
 boolean isFsCtl,
 byte[] inData,
 int inOffset,
 int inLength)

Sends a control code directly to a specified device driver, causing the corresponding device to perform the corresponding operation.

Parameters:

ctlCode - the control code

isFsCtl - true if the control code is an FSCTL; false if it is an IOCTL

inData - the control code dependent input data

inOffset - the offset in inData where the input data starts

inLength - the number of bytes from inData to send, starting at offset

Returns:

the response data or null if the control code did not produce a response

ioctl

public int ioctl(long ctlCode,
 boolean isFsCtl,
 byte[] inData,
 int inOffset,
 int inLength,
 byte[] outData,
 int outOffset,
 int outLength)

Sends a control code directly to a specified device driver, causing the corresponding device to perform the corresponding operation.

Parameters:

ctlCode - the control code

isFsCtl - true if the control code is an FSCTL; false if it is an IOCTL

inData - the control code dependent input data

inOffset - the offset in inData where the input data starts

inLength - the number of bytes from inData to send, starting at inOffset

outData - the buffer where the response data should be written

outOffset - the offset in outData where the output data should be written

outLength - the maximum amount of data to write in outData, starting at outOffset

Returns:

the number of bytes written to outData

ioctl

byte[] ioctl(SMB2FileId fileId,
 long ctlCode,
 boolean isFsCtl,
 byte[] inData,
 int inOffset,
 int inLength)

ioctl

byte[] ioctl(SMB2FileId fileId,
 long ctlCode,
 boolean isFsCtl,
 byte[] inData,
 int inOffset,
 int inLength,
 int maxOutputResponse)

ioctl

int ioctl(SMB2FileId fileId,
 long ctlCode,
 boolean isFsCtl,
 byte[] inData,
 int inOffset,
 int inLength,
 byte[] outData,
 int outOffset,
 int outLength)

ioctl

SMB2IoctlResponse ioctl(SMB2FileId fileId,
 long ctlCode,
 boolean isFsCtl,
 ByteChunkProvider inputData,
 int maxOutputResponse)

ioctlAsync

public Future<SMB2IoctlResponse> ioctlAsync(long ctlCode,
 boolean isFsCtl,
 ByteChunkProvider inputData)

ioctlAsync

Future<SMB2IoctlResponse> ioctlAsync(SMB2FileId fileId,
 long ctlCode,
 boolean isFsCtl,
 ByteChunkProvider inputData,
 int maxOutputResponse)

sendLockRequest

SMB2LockResponse sendLockRequest(SMB2FileId fileId,
 short lockSequenceNumber,
 int lockSequenceIndex,
 List<SMB2LockElement> lockElements)

changeNotifyAsync

Future<SMB2ChangeNotifyResponse> changeNotifyAsync(SMB2FileId fileId,
 Set<SMB2CompletionFilter> completionFilter,
 Set<SMB2ChangeNotifyFlags> flags)

sendReceive

private <T extends SMB2Packet> T sendReceive(SMB2Packet request,
 String name,
 Object target,
 StatusHandler statusHandler,
 long timeout)

send

private <T extends SMB2Packet> Future<T> send(SMB2Packet request)

receive

<T extends SMB2Packet> T receive(Future<T> fut,
 String name,
 Object target,
 StatusHandler statusHandler,
 long timeout)

receive

<T extends SMB2Packet> T receive(Future<T> fut,
 long timeout)

getDialect

SMB2Dialect getDialect()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object