Class DiskShare

java.lang.Object

com.hierynomus.smbj.share.Share

com.hierynomus.smbj.share.DiskShare

All Implemented Interfaces:

AutoCloseable

public class DiskShare
extends Share

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	DiskShare.SMB2CreateResponseContext	A return object for the createFileAndResolve(SmbPath, SMB2ImpersonationLevel, Set, Set, Set, SMB2CreateDisposition, Set) call.

Field Summary

Fields

Modifier and Type	Field	Description
private static StatusHandler	ALREADY_DELETED_STATUS_HANDLER
private static final StatusHandler	FILE_EXISTS_STATUS_HANDLER
private static final StatusHandler	FOLDER_EXISTS_STATUS_HANDLER
private final PathResolver	resolver

Fields inherited from class Share

session, smbPath, treeConnect

Constructor Summary

Constructors

Constructor	Description
DiskShare(SmbPath smbPath, TreeConnect treeConnect, PathResolver pathResolver)

Method Summary

Modifier and Type	Method	Description
private DiskShare.SMB2CreateResponseContext	createFileAndResolve(SmbPath path, SMB2ImpersonationLevel impersonationLevel, Set<AccessMask> accessMask, Set<FileAttributes> fileAttributes, Set<SMB2ShareAccess> shareAccess, SMB2CreateDisposition createDisposition, Set<SMB2CreateOptions> createOptions)
void	deleteOnClose(SMB2FileId fileId)
private boolean	exists(String path, EnumSet<SMB2CreateOptions> createOptions, StatusHandler statusHandler)
boolean	fileExists(String path)	File in the given path exists or not
boolean	folderExists(String path)	Folder in the given path exists or not.
protected StatusHandler	getCreateStatusHandler()
protected DiskEntry	getDiskEntry(DiskShare.SMB2CreateResponseContext responseContext)
FileAllInformation	getFileInformation(SMB2FileId fileId)	Get information for a given fileId
<F extends FileQueryableInformation> F	getFileInformation(SMB2FileId fileId, Class<F> informationClass)
FileAllInformation	getFileInformation(String path)	Get information about the given path.
<F extends FileQueryableInformation> F	getFileInformation(String path, Class<F> informationClass)	Get information about the given path.
SecurityDescriptor	getSecurityInfo(SMB2FileId fileId, Set<SecurityInformation> securityInfo)	The SecurityDescriptor(MS-DTYP 2.4.6 SECURITY_DESCRIPTOR) for the Given FileId
SecurityDescriptor	getSecurityInfo(String path, Set<SecurityInformation> securityInfo)	The SecurityDescriptor(MS-DTYP 2.4.6 SECURITY_DESCRIPTOR) for the Given Path
ShareInfo	getShareInformation()	Get Share Information for the current Disk Share
VolumeInfo	getVolumeInfo()	Get Volume Information for the current Disk Share
List<FileIdBothDirectoryInformation>	list(String path)	Equivalent to calling invalid reference list(path, FileIdBothDirectoryInformation.class, null, null) .
<I extends FileDirectoryQueryableInformation> List<I>	list(String path, Class<I> informationClass)	Equivalent to calling invalid reference list(path, informationClass, null, null) .
<I extends FileDirectoryQueryableInformation> List<I>	list(String path, Class<I> informationClass, String searchPattern, EnumSet<AccessMask> accessMask)	Opens the given path for read-only access and performs a directory listing.
List<FileIdBothDirectoryInformation>	list(String path, String searchPattern)	Equivalent to calling invalid reference list(path, FileIdBothDirectoryInformation.class, searchPattern, null) .
void	mkdir(String path)	Create a directory in the given path.
DiskEntry	open(String path, Set<AccessMask> accessMask, Set<FileAttributes> attributes, Set<SMB2ShareAccess> shareAccesses, SMB2CreateDisposition createDisposition, Set<SMB2CreateOptions> createOptions)
Directory	openDirectory(String path, Set<AccessMask> accessMask, Set<FileAttributes> attributes, Set<SMB2ShareAccess> shareAccesses, SMB2CreateDisposition createDisposition, Set<SMB2CreateOptions> createOptions)	Get a handle to a directory in the given path
File	openFile(String path, Set<AccessMask> accessMask, Set<FileAttributes> attributes, Set<SMB2ShareAccess> shareAccesses, SMB2CreateDisposition createDisposition, Set<SMB2CreateOptions> createOptions)
private DiskShare	rerouteIfNeeded(SmbPath path, SmbPath target)
private DiskShare.SMB2CreateResponseContext	resolveAndCreateFile(SmbPath path, SMB2ImpersonationLevel impersonationLevel, Set<AccessMask> accessMask, Set<FileAttributes> fileAttributes, Set<SMB2ShareAccess> shareAccess, SMB2CreateDisposition createDisposition, Set<SMB2CreateOptions> createOptions)
void	rm(String path)	Remove the file at the given path
void	rmdir(String path, boolean recursive)	Remove the directory at the given path.
<F extends FileSettableInformation> void	setFileInformation(SMB2FileId fileId, F information)
<F extends FileSettableInformation> void	setFileInformation(String path, F information)	Get information for a given path
void	setSecurityInfo(SMB2FileId fileId, Set<SecurityInformation> securityInfo, SecurityDescriptor securityDescriptor)	The SecurityDescriptor(MS-DTYP 2.4.6 SECURITY_DESCRIPTOR) for the Given FileId
void	setSecurityInfo(String path, Set<SecurityInformation> securityInfo, SecurityDescriptor securityDescriptor)	The SecurityDescriptor(MS-DTYP 2.4.6 SECURITY_DESCRIPTOR) for the Given FileId
String	toString()

Methods inherited from class Share

changeNotifyAsync, close, closeFileId, closeFileIdNoWait, createFile, equals, flush, getDialect, getReadBufferSize, getReadTimeout, getSmbPath, getTreeConnect, getWriteBufferSize, hashCode, ioctl, ioctl, ioctl, ioctl, ioctl, ioctl, ioctl, ioctlAsync, ioctlAsync, isConnected, openFileId, queryDirectory, queryInfo, read, readAsync, receive, receive, sendLockRequest, setInfo, write, writeAsync

Methods inherited from class Object

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

Field Details

resolver

private final PathResolver resolver

FILE_EXISTS_STATUS_HANDLER

private static final StatusHandler FILE_EXISTS_STATUS_HANDLER

FOLDER_EXISTS_STATUS_HANDLER

private static final StatusHandler FOLDER_EXISTS_STATUS_HANDLER

ALREADY_DELETED_STATUS_HANDLER

private static StatusHandler ALREADY_DELETED_STATUS_HANDLER

Constructor Details

DiskShare

public DiskShare(SmbPath smbPath,
 TreeConnect treeConnect,
 PathResolver pathResolver)

Method Details

open

public DiskEntry open(String path,
 Set<AccessMask> accessMask,
 Set<FileAttributes> attributes,
 Set<SMB2ShareAccess> shareAccesses,
 SMB2CreateDisposition createDisposition,
 Set<SMB2CreateOptions> createOptions)

getCreateStatusHandler

protected StatusHandler getCreateStatusHandler()

Overrides:

getCreateStatusHandler in class Share

createFileAndResolve

private DiskShare.SMB2CreateResponseContext createFileAndResolve(SmbPath path,
 SMB2ImpersonationLevel impersonationLevel,
 Set<AccessMask> accessMask,
 Set<FileAttributes> fileAttributes,
 Set<SMB2ShareAccess> shareAccess,
 SMB2CreateDisposition createDisposition,
 Set<SMB2CreateOptions> createOptions)

resolveAndCreateFile

private DiskShare.SMB2CreateResponseContext resolveAndCreateFile(SmbPath path,
 SMB2ImpersonationLevel impersonationLevel,
 Set<AccessMask> accessMask,
 Set<FileAttributes> fileAttributes,
 Set<SMB2ShareAccess> shareAccess,
 SMB2CreateDisposition createDisposition,
 Set<SMB2CreateOptions> createOptions)

rerouteIfNeeded

private DiskShare rerouteIfNeeded(SmbPath path,
 SmbPath target)

getDiskEntry

protected DiskEntry getDiskEntry(DiskShare.SMB2CreateResponseContext responseContext)

openDirectory

public Directory openDirectory(String path,
 Set<AccessMask> accessMask,
 Set<FileAttributes> attributes,
 Set<SMB2ShareAccess> shareAccesses,
 SMB2CreateDisposition createDisposition,
 Set<SMB2CreateOptions> createOptions)

Get a handle to a directory in the given path

openFile

public File openFile(String path,
 Set<AccessMask> accessMask,
 Set<FileAttributes> attributes,
 Set<SMB2ShareAccess> shareAccesses,
 SMB2CreateDisposition createDisposition,
 Set<SMB2CreateOptions> createOptions)

fileExists

public boolean fileExists(String path)
                   throws SMBApiException

File in the given path exists or not

Throws:

SMBApiException

folderExists

public boolean folderExists(String path)
                     throws SMBApiException

Folder in the given path exists or not.

Throws:

SMBApiException

exists

private boolean exists(String path,
 EnumSet<SMB2CreateOptions> createOptions,
 StatusHandler statusHandler)
                throws SMBApiException

Throws:

SMBApiException

list

public List<FileIdBothDirectoryInformation> list(String path)
                                          throws SMBApiException

Equivalent to calling

invalid reference

list(path, FileIdBothDirectoryInformation.class, null, null)

.

Throws:

SMBApiException

See Also:

• invalid reference

  #list(String, Class, String, EnumSet<AccessMask>)

list

public List<FileIdBothDirectoryInformation> list(String path,
 String searchPattern)
                                          throws SMBApiException

Equivalent to calling

invalid reference

list(path, FileIdBothDirectoryInformation.class, searchPattern, null)

.

Throws:

SMBApiException

See Also:

• invalid reference

  #list(String, Class, String, EnumSet<AccessMask>)

list

public <I extends FileDirectoryQueryableInformation>
List<I> list(String path,
 Class<I> informationClass)

Equivalent to calling

invalid reference

list(path, informationClass, null, null)

.

See Also:

• invalid reference

  #list(String, Class, String, EnumSet<AccessMask>)

list

public <I extends FileDirectoryQueryableInformation>
List<I> list(String path,
 Class<I> informationClass,
 String searchPattern,
 EnumSet<AccessMask> accessMask)

Opens the given path for read-only access and performs a directory listing.

See Also:

• Directory.iterator(Class, String)

mkdir

public void mkdir(String path)
           throws SMBApiException

Create a directory in the given path.

Throws:

SMBApiException

getFileInformation

public FileAllInformation getFileInformation(String path)
                                      throws SMBApiException

Get information about the given path.

Throws:

SMBApiException

getFileInformation

public <F extends FileQueryableInformation> F getFileInformation(String path,
 Class<F> informationClass)
                                                          throws SMBApiException

Get information about the given path.

Throws:

SMBApiException

getFileInformation

public FileAllInformation getFileInformation(SMB2FileId fileId)
                                      throws SMBApiException

Get information for a given fileId

Throws:

SMBApiException

getFileInformation

public <F extends FileQueryableInformation> F getFileInformation(SMB2FileId fileId,
 Class<F> informationClass)
                                                          throws SMBApiException

Throws:

SMBApiException

setFileInformation

public <F extends FileSettableInformation> void setFileInformation(SMB2FileId fileId,
 F information)

setFileInformation

public <F extends FileSettableInformation> void setFileInformation(String path,
 F information)
                                                            throws SMBApiException

Get information for a given path

Throws:

SMBApiException

getShareInformation

public ShareInfo getShareInformation()
                              throws SMBApiException

Get Share Information for the current Disk Share

Returns:

the ShareInfo

Throws:

SMBApiException

getVolumeInfo

public VolumeInfo getVolumeInfo()
                         throws SMBApiException

Get Volume Information for the current Disk Share

Returns:

the VolumeInfo

Throws:

SMBApiException

rmdir

public void rmdir(String path,
 boolean recursive)
           throws SMBApiException

Remove the directory at the given path.

Throws:

SMBApiException

rm

public void rm(String path)
        throws SMBApiException

Remove the file at the given path

Throws:

SMBApiException

deleteOnClose

public void deleteOnClose(SMB2FileId fileId)

getSecurityInfo

public SecurityDescriptor getSecurityInfo(String path,
 Set<SecurityInformation> securityInfo)
                                   throws SMBApiException

The SecurityDescriptor(MS-DTYP 2.4.6 SECURITY_DESCRIPTOR) for the Given Path

Throws:

SMBApiException

getSecurityInfo

public SecurityDescriptor getSecurityInfo(SMB2FileId fileId,
 Set<SecurityInformation> securityInfo)
                                   throws SMBApiException

The SecurityDescriptor(MS-DTYP 2.4.6 SECURITY_DESCRIPTOR) for the Given FileId

Throws:

SMBApiException

setSecurityInfo

public void setSecurityInfo(String path,
 Set<SecurityInformation> securityInfo,
 SecurityDescriptor securityDescriptor)
                     throws SMBApiException

The SecurityDescriptor(MS-DTYP 2.4.6 SECURITY_DESCRIPTOR) for the Given FileId

Throws:

SMBApiException

setSecurityInfo

public void setSecurityInfo(SMB2FileId fileId,
 Set<SecurityInformation> securityInfo,
 SecurityDescriptor securityDescriptor)
                     throws SMBApiException

The SecurityDescriptor(MS-DTYP 2.4.6 SECURITY_DESCRIPTOR) for the Given FileId

Throws:

SMBApiException

toString

public String toString()

Overrides:

toString in class Object