Class SmbFile
- Direct Known Subclasses:
SmbNamedPipe
SmbFile
may also refer to servers and workgroups. If the resource is a file or
directory the methods of SmbFile
follow the behavior of
the well known File
class. One fundamental difference
is the usage of a URL scheme [1] to specify the target file or
directory. SmbFile URLs have the following syntax:
This example:smb://[[[domain;]username[:password]@]server[:port]/[[share/[dir/]file]]][?param=value[param2=value2[...]]]
would reference the filesmb://storage15/public/foo.txt
foo.txt
in the share
public
on the server storage15
. In addition
to referencing files and directories, jCIFS can also address servers,
and workgroups.
Important: all SMB URLs that represent workgroups, servers, shares, or directories require a trailing slash '/'.
When using the java.net.URL class with 'smb://' URLs it is necessary to first call the static jcifs.Config.registerSmbURLHandler(); method. This is required to register the SMB protocol handler.
The userinfo component of the SMB URL (domain;user:pass) must be URL encoded if it contains reserved characters. According to RFC 2396 these characters are non US-ASCII characters and most meta characters however jCIFS will work correctly with anything but '@' which is used to delimit the userinfo component from the server and '%' which is the URL escape character itself.
The server component may a traditional NetBIOS name, a DNS name, or IP address. These name resolution mechanisms and their resolution order can be changed (See Setting Name Resolution Properties). The servername and path components are not case sensitive but the domain, username, and password components are. It is also likely that properties must be specified for jcifs to function (See Setting JCIFS Properties). Here are some examples of SMB URLs with brief descriptions of what they do:
[1] This URL scheme is based largely on the SMB Filesharing URL Scheme IETF draft.
SMB URL Examples | |
URL | Description |
smb://users-nyc;miallen:mypass@angus/tmp/ |
This URL references a share called tmp on the server
angus as user miallen who's password is
mypass .
|
smb://Administrator:P%40ss@msmith1/c/WINDOWS/Desktop/foo.txt |
A relativly sophisticated example that references a file
msmith1 's desktop as user Administrator . Notice the '@' is URL encoded with the '%40' hexcode escape.
|
smb://angus/ |
This references only a server. The behavior of some methods is different
in this context(e.g. you cannot delete a server) however
as you might expect the list method will list the available
shares on this server.
|
smb://myworkgroup/ |
This syntactically is identical to the above example. However if
myworkgroup happends to be a workgroup(which is indeed
suggested by the name) the list method will return
a list of servers that have registered themselves as members of
myworkgroup .
|
smb:// |
Just as smb://server/ lists shares and
smb://workgroup/ lists servers, the smb://
URL lists all available workgroups on a netbios LAN. Again,
in this context many methods are not valid and return default
values(e.g. isHidden will always return false).
|
smb://angus.foo.net/d/jcifs/pipes.doc | The server name may also be a DNS name as it is in this example. See Setting Name Resolution Properties for details. |
smb://192.168.1.15/ADMIN$/ | The server name may also be an IP address. See Setting Name Resolution Properties for details. |
smb://domain;username:password@server/share/path/to/file.txt | A prototypical example that uses all the fields. |
smb://myworkgroup/angus/ <-- ILLEGAL | Despite the hierarchial relationship between workgroups, servers, and filesystems this example is not valid. |
smb://server/share/path/to/dir <-- ILLEGAL | URLs that represent workgroups, servers, shares, or directories require a trailing slash '/'. |
smb://MYGROUP/?SERVER=192.168.10.15 |
SMB URLs support some query string parameters. In this example
the SERVER parameter is used to override the
server name service lookup to contact the server 192.168.10.15
(presumably known to be a master
browser) for the server list in workgroup MYGROUP .
|
A second constructor argument may be specified to augment the URL
for better programmatic control when processing many files under
a common base. This is slightly different from the corresponding
java.io.File
usage; a '/' at the beginning of the second
parameter will still use the server component of the first parameter. The
examples below illustrate the resulting URLs when this second contructor
argument is used.
Examples Of SMB URLs When Augmented With A Second Constructor Parameter | ||
First Parameter | Second Parameter | Result |
smb://host/share/a/b/
|
c/d/
|
smb://host/share/a/b/c/d/
|
smb://host/share/foo/bar/
|
/share2/zig/zag
|
smb://host/share2/zig/zag
|
smb://host/share/foo/bar/
|
../zip/
|
smb://host/share/foo/zip/
|
smb://host/share/zig/zag
|
smb://foo/bar/
|
smb://foo/bar/
|
smb://host/share/foo/
|
../.././.././../foo/
|
smb://host/foo/
|
smb://host/share/zig/zag
|
/
|
smb://host/
|
smb://server/
|
../
|
smb://server/
|
smb://
|
myworkgroup/
|
smb://myworkgroup/
|
smb://myworkgroup/
|
angus/
|
smb://myworkgroup/angus/ <-- ILLEGAL |
Instances of the SmbFile
class are immutable; that is,
once created, the abstract pathname represented by an SmbFile object
will never change.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
A file with this bit on as returned by getAttributes() or set with setAttributes() is an archived filestatic final int
A file with this bit on as returned by getAttributes() is a directorystatic final int
A file with this bit on as returned by getAttributes() or set with setAttributes() will be hiddenstatic final int
A file with this bit on as returned by getAttributes() or set with setAttributes() will be read-onlystatic final int
A file with this bit on as returned by getAttributes() or set with setAttributes() will be a system filestatic final int
A file with this bit on as returned by getAttributes() is a volumestatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final LinkedList
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
protected static jcifs.smb.Dfs
static final int
static final int
static final int
static final int
static final int
When specified as the shareAccess constructor parameter, other SMB clients (including other threads making calls into jCIFS) will not be permitted to access the target file and will receive "The file is being accessed by another process" message.static final int
static final int
static final int
static final int
When specified as the shareAccess constructor parameter, other SMB clients will be permitted to delete the target file while this file is open.static final int
When specified as the shareAccess constructor parameter, other SMB clients will be permitted to read from the target file while this file is open.static final int
When specified as the shareAccess constructor parameter, other SMB clients will be permitted to write to the target file while this file is open.static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final boolean
static final int
static final int
static final int
static final int
static final int
static final InetAddress
static final int
static final int
static final int
static final long
static final String
static final String
static final String
static final jcifs.smb.SmbTransport
static final String
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final boolean
static final int
static final int
static final int
static final int
static final boolean
static final int
static final int
Returned bygetType()
if the resource this SmbFile represents is a communications device.static final int
Returned bygetType()
if the resource this SmbFile represents is a regular file or directory.static final int
Returned bygetType()
if the resource this SmbFile represents is a named pipe.static final int
Returned bygetType()
if the resource this SmbFile represents is a printer.static final int
Returned bygetType()
if the resource this SmbFile represents is a server.static final int
Returned bygetType()
if the resource this SmbFile represents is a share.static final int
Returned bygetType()
if the resource this SmbFile represents is a workgroup.static final TimeZone
static final String
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final int
static final int
static final int
Fields inherited from class java.net.URLConnection
allowUserInteraction, connected, doInput, doOutput, ifModifiedSince, url, useCaches
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an SmbFile representing a resource on an SMB network such as a file or directory.Constructs an SmbFile representing a resource on an SMB network such as a file or directory.SmbFile
(String context, String name, NtlmPasswordAuthentication auth) Constructs an SmbFile representing a resource on an SMB network such as a file or directory.SmbFile
(String context, String name, NtlmPasswordAuthentication auth, int shareAccess) Constructs an SmbFile representing a resource on an SMB network such as a file or directory.SmbFile
(String url, NtlmPasswordAuthentication auth) Constructs an SmbFile representing a resource on an SMB network such as a file or directory.SmbFile
(String url, NtlmPasswordAuthentication auth, int shareAccess) Constructs an SmbFile representing a file on an SMB network.Constructs an SmbFile representing a resource on an SMB network such as a file or directory from a URL object.SmbFile
(URL url, NtlmPasswordAuthentication auth) Constructs an SmbFile representing a resource on an SMB network such as a file or directory from a URL object and an NtlmPasswordAuthentication object.Constructs an SmbFile representing a resource on an SMB network such as a file or directory.Constructs an SmbFile representing a resource on an SMB network such as a file or directory. -
Method Summary
Modifier and TypeMethodDescriptionboolean
canRead()
Tests to see if the file thisSmbFile
represents can be read.boolean
canWrite()
Tests to see if the file thisSmbFile
represents exists and is not marked read-only.void
connect()
It is not necessary to call this method directly.void
This method will copy the file or directory represented by this SmbFile and it's sub-contents to the location specified by the dest parameter.void
Create a new file but fail if it already exists.long
Retrieve the time thisSmbFile
was created.void
delete()
This method will delete the file or directory specified by thisSmbFile
.boolean
Tests to see if twoSmbFile
objects are equal.boolean
exists()
Tests to see if the SMB resource exists.int
Return the attributes of this file.Returns the full URL of this SMB resource with '.' and '..' components factored out.int
This URLConnection method just returns the result of length().long
getDate()
This URLConnection method just returns the result of lastModified.If the path of thisSmbFile
falls within a DFS volume, this method will return the referral path to which it maps.long
This method returns the free disk space in bytes of the drive this share represents or the drive on which the directory or file resides.This URLConnection method just returns a new SmbFileInputStream created with this file.long
This URLConnection method just returns the result of lastModified.getName()
Returns the last component of the target URL.This URLConnection method just returns a new SmbFileOutputStream created with this file.Everything but the last component of the URL representing this SMB resource is effectivly it's parent.getPath()
Returns the full uncanonicalized URL of this SMB resource.Returns the NtlmPasswordAuthentication object used as credentials with this file or pipe.ACE[]
Return an array of Access Control Entry (ACE) objects representing the security descriptor associated with this file or directory.ACE[]
getSecurity
(boolean resolveSids) Return an array of Access Control Entry (ACE) objects representing the security descriptor associated with this file or directory.Retrieve the hostname of the server for this SMB resource.getShare()
Retrieves the share associated with this SMB resource.ACE[]
getShareSecurity
(boolean resolveSids) Return an array of Access Control Entry (ACE) objects representing the share permissions on the share exporting this file or directory.int
getType()
Returns type of of object this SmbFile represents.Retuns the Windows UNC style path with backslashs intead of forward slashes.int
hashCode()
Computes a hashCode for this file based on the URL string and IP address if the server.boolean
Tests to see if the file thisSmbFile
represents is a directory.boolean
isFile()
Tests to see if the file thisSmbFile
represents is not a directory.boolean
isHidden()
Tests to see if the file this SmbFile represents is marked as hidden.long
Retrieve the last time the file represented by thisSmbFile
was modified.long
length()
Returns the length of this SmbFile in bytes.String[]
list()
List the contents of this SMB resource.String[]
list
(SmbFilenameFilter filter) List the contents of this SMB resource.SmbFile[]
List the contents of this SMB resource as an array ofSmbFile
objects.SmbFile[]
The CIFS protocol provides for DOS "wildcards" to be used as a performance enhancement.SmbFile[]
listFiles
(SmbFileFilter filter) List the contents of this SMB resource.SmbFile[]
listFiles
(SmbFilenameFilter filter) List the contents of this SMB resource.void
mkdir()
Creates a directory with the path specified by thisSmbFile
.void
mkdirs()
Creates a directory with the path specified by this SmbFile and any parent directories that do not exist.protected boolean
pathNamesPossiblyEqual
(String path1, String path2) void
Changes the name of the file thisSmbFile
represents to the name designated by theSmbFile
argument.void
setAttributes
(int attrs) Set the attributes of this file.void
setCreateTime
(long time) Set the create time of the file.void
setLastModified
(long time) Set the last modified time of the file.void
Make this file read-only.void
Turn off the read-only attribute of this file.toString()
Returns the string representation of this SmbFile object.toURL()
Deprecated.Use getURL() insteadMethods inherited from class java.net.URLConnection
addRequestProperty, getAllowUserInteraction, getConnectTimeout, getContent, getContent, getContentEncoding, getContentLengthLong, getContentType, getDefaultAllowUserInteraction, getDefaultRequestProperty, getDefaultUseCaches, getDefaultUseCaches, getDoInput, getDoOutput, getExpiration, getFileNameMap, getHeaderField, getHeaderField, getHeaderFieldDate, getHeaderFieldInt, getHeaderFieldKey, getHeaderFieldLong, getHeaderFields, getIfModifiedSince, getPermission, getReadTimeout, getRequestProperties, getRequestProperty, getURL, getUseCaches, guessContentTypeFromName, guessContentTypeFromStream, setAllowUserInteraction, setConnectTimeout, setContentHandlerFactory, setDefaultAllowUserInteraction, setDefaultRequestProperty, setDefaultUseCaches, setDefaultUseCaches, setDoInput, setDoOutput, setFileNameMap, setIfModifiedSince, setReadTimeout, setRequestProperty, setUseCaches
-
Field Details
-
FILE_NO_SHARE
public static final int FILE_NO_SHAREWhen specified as the shareAccess constructor parameter, other SMB clients (including other threads making calls into jCIFS) will not be permitted to access the target file and will receive "The file is being accessed by another process" message.- See Also:
-
FILE_SHARE_READ
public static final int FILE_SHARE_READWhen specified as the shareAccess constructor parameter, other SMB clients will be permitted to read from the target file while this file is open. This constant may be logically OR'd with other share access flags.- See Also:
-
FILE_SHARE_WRITE
public static final int FILE_SHARE_WRITEWhen specified as the shareAccess constructor parameter, other SMB clients will be permitted to write to the target file while this file is open. This constant may be logically OR'd with other share access flags.- See Also:
-
FILE_SHARE_DELETE
public static final int FILE_SHARE_DELETEWhen specified as the shareAccess constructor parameter, other SMB clients will be permitted to delete the target file while this file is open. This constant may be logically OR'd with other share access flags.- See Also:
-
ATTR_READONLY
public static final int ATTR_READONLYA file with this bit on as returned by getAttributes() or set with setAttributes() will be read-only- See Also:
-
ATTR_HIDDEN
public static final int ATTR_HIDDENA file with this bit on as returned by getAttributes() or set with setAttributes() will be hidden- See Also:
-
ATTR_SYSTEM
public static final int ATTR_SYSTEMA file with this bit on as returned by getAttributes() or set with setAttributes() will be a system file- See Also:
-
ATTR_VOLUME
public static final int ATTR_VOLUMEA file with this bit on as returned by getAttributes() is a volume- See Also:
-
ATTR_DIRECTORY
public static final int ATTR_DIRECTORYA file with this bit on as returned by getAttributes() is a directory- See Also:
-
ATTR_ARCHIVE
public static final int ATTR_ARCHIVEA file with this bit on as returned by getAttributes() or set with setAttributes() is an archived file- See Also:
-
TYPE_FILESYSTEM
public static final int TYPE_FILESYSTEMReturned bygetType()
if the resource this SmbFile represents is a regular file or directory.- See Also:
-
TYPE_WORKGROUP
public static final int TYPE_WORKGROUPReturned bygetType()
if the resource this SmbFile represents is a workgroup.- See Also:
-
TYPE_SERVER
public static final int TYPE_SERVERReturned bygetType()
if the resource this SmbFile represents is a server.- See Also:
-
TYPE_SHARE
public static final int TYPE_SHAREReturned bygetType()
if the resource this SmbFile represents is a share.- See Also:
-
TYPE_NAMED_PIPE
public static final int TYPE_NAMED_PIPEReturned bygetType()
if the resource this SmbFile represents is a named pipe.- See Also:
-
TYPE_PRINTER
public static final int TYPE_PRINTERReturned bygetType()
if the resource this SmbFile represents is a printer.- See Also:
-
TYPE_COMM
public static final int TYPE_COMMReturned bygetType()
if the resource this SmbFile represents is a communications device.- See Also:
-
dfs
protected static jcifs.smb.Dfs dfs -
DEFAULT_PORT
static final int DEFAULT_PORT- See Also:
-
DEFAULT_MAX_MPX_COUNT
static final int DEFAULT_MAX_MPX_COUNT- See Also:
-
DEFAULT_RESPONSE_TIMEOUT
static final int DEFAULT_RESPONSE_TIMEOUT- See Also:
-
DEFAULT_SO_TIMEOUT
static final int DEFAULT_SO_TIMEOUT- See Also:
-
DEFAULT_RCV_BUF_SIZE
static final int DEFAULT_RCV_BUF_SIZE- See Also:
-
DEFAULT_SND_BUF_SIZE
static final int DEFAULT_SND_BUF_SIZE- See Also:
-
DEFAULT_SSN_LIMIT
static final int DEFAULT_SSN_LIMIT- See Also:
-
DEFAULT_CONN_TIMEOUT
static final int DEFAULT_CONN_TIMEOUT- See Also:
-
LADDR
-
LPORT
static final int LPORT -
MAX_MPX_COUNT
static final int MAX_MPX_COUNT -
SND_BUF_SIZE
static final int SND_BUF_SIZE -
RCV_BUF_SIZE
static final int RCV_BUF_SIZE -
USE_UNICODE
static final boolean USE_UNICODE -
FORCE_UNICODE
static final boolean FORCE_UNICODE -
USE_NTSTATUS
static final boolean USE_NTSTATUS -
SIGNPREF
static final boolean SIGNPREF -
USE_NTSMBS
static final boolean USE_NTSMBS -
USE_EXTSEC
static final boolean USE_EXTSEC -
NETBIOS_HOSTNAME
-
LM_COMPATIBILITY
static final int LM_COMPATIBILITY -
FLAGS_NONE
static final int FLAGS_NONE- See Also:
-
FLAGS_LOCK_AND_READ_WRITE_AND_UNLOCK
static final int FLAGS_LOCK_AND_READ_WRITE_AND_UNLOCK- See Also:
-
FLAGS_RECEIVE_BUFFER_POSTED
static final int FLAGS_RECEIVE_BUFFER_POSTED- See Also:
-
FLAGS_PATH_NAMES_CASELESS
static final int FLAGS_PATH_NAMES_CASELESS- See Also:
-
FLAGS_PATH_NAMES_CANONICALIZED
static final int FLAGS_PATH_NAMES_CANONICALIZED- See Also:
-
FLAGS_OPLOCK_REQUESTED_OR_GRANTED
static final int FLAGS_OPLOCK_REQUESTED_OR_GRANTED- See Also:
-
FLAGS_NOTIFY_OF_MODIFY_ACTION
static final int FLAGS_NOTIFY_OF_MODIFY_ACTION- See Also:
-
FLAGS_RESPONSE
static final int FLAGS_RESPONSE- See Also:
-
FLAGS2_NONE
static final int FLAGS2_NONE- See Also:
-
FLAGS2_LONG_FILENAMES
static final int FLAGS2_LONG_FILENAMES- See Also:
-
FLAGS2_EXTENDED_ATTRIBUTES
static final int FLAGS2_EXTENDED_ATTRIBUTES- See Also:
-
FLAGS2_SECURITY_SIGNATURES
static final int FLAGS2_SECURITY_SIGNATURES- See Also:
-
FLAGS2_EXTENDED_SECURITY_NEGOTIATION
static final int FLAGS2_EXTENDED_SECURITY_NEGOTIATION- See Also:
-
FLAGS2_RESOLVE_PATHS_IN_DFS
static final int FLAGS2_RESOLVE_PATHS_IN_DFS- See Also:
-
FLAGS2_PERMIT_READ_IF_EXECUTE_PERM
static final int FLAGS2_PERMIT_READ_IF_EXECUTE_PERM- See Also:
-
FLAGS2_STATUS32
static final int FLAGS2_STATUS32- See Also:
-
FLAGS2_UNICODE
static final int FLAGS2_UNICODE- See Also:
-
CAP_NONE
static final int CAP_NONE- See Also:
-
CAP_RAW_MODE
static final int CAP_RAW_MODE- See Also:
-
CAP_MPX_MODE
static final int CAP_MPX_MODE- See Also:
-
CAP_UNICODE
static final int CAP_UNICODE- See Also:
-
CAP_LARGE_FILES
static final int CAP_LARGE_FILES- See Also:
-
CAP_NT_SMBS
static final int CAP_NT_SMBS- See Also:
-
CAP_RPC_REMOTE_APIS
static final int CAP_RPC_REMOTE_APIS- See Also:
-
CAP_STATUS32
static final int CAP_STATUS32- See Also:
-
CAP_LEVEL_II_OPLOCKS
static final int CAP_LEVEL_II_OPLOCKS- See Also:
-
CAP_LOCK_AND_READ
static final int CAP_LOCK_AND_READ- See Also:
-
CAP_NT_FIND
static final int CAP_NT_FIND- See Also:
-
CAP_DFS
static final int CAP_DFS- See Also:
-
CAP_EXTENDED_SECURITY
static final int CAP_EXTENDED_SECURITY- See Also:
-
FILE_READ_DATA
static final int FILE_READ_DATA- See Also:
-
FILE_WRITE_DATA
static final int FILE_WRITE_DATA- See Also:
-
FILE_APPEND_DATA
static final int FILE_APPEND_DATA- See Also:
-
FILE_READ_EA
static final int FILE_READ_EA- See Also:
-
FILE_WRITE_EA
static final int FILE_WRITE_EA- See Also:
-
FILE_EXECUTE
static final int FILE_EXECUTE- See Also:
-
FILE_DELETE
static final int FILE_DELETE- See Also:
-
FILE_READ_ATTRIBUTES
static final int FILE_READ_ATTRIBUTES- See Also:
-
FILE_WRITE_ATTRIBUTES
static final int FILE_WRITE_ATTRIBUTES- See Also:
-
DELETE
static final int DELETE- See Also:
-
READ_CONTROL
static final int READ_CONTROL- See Also:
-
WRITE_DAC
static final int WRITE_DAC- See Also:
-
WRITE_OWNER
static final int WRITE_OWNER- See Also:
-
SYNCHRONIZE
static final int SYNCHRONIZE- See Also:
-
GENERIC_ALL
static final int GENERIC_ALL- See Also:
-
GENERIC_EXECUTE
static final int GENERIC_EXECUTE- See Also:
-
GENERIC_WRITE
static final int GENERIC_WRITE- See Also:
-
GENERIC_READ
static final int GENERIC_READ- See Also:
-
FLAGS_TARGET_MUST_BE_FILE
static final int FLAGS_TARGET_MUST_BE_FILE- See Also:
-
FLAGS_TARGET_MUST_BE_DIRECTORY
static final int FLAGS_TARGET_MUST_BE_DIRECTORY- See Also:
-
FLAGS_COPY_TARGET_MODE_ASCII
static final int FLAGS_COPY_TARGET_MODE_ASCII- See Also:
-
FLAGS_COPY_SOURCE_MODE_ASCII
static final int FLAGS_COPY_SOURCE_MODE_ASCII- See Also:
-
FLAGS_VERIFY_ALL_WRITES
static final int FLAGS_VERIFY_ALL_WRITES- See Also:
-
FLAGS_TREE_COPY
static final int FLAGS_TREE_COPY- See Also:
-
OPEN_FUNCTION_FAIL_IF_EXISTS
static final int OPEN_FUNCTION_FAIL_IF_EXISTS- See Also:
-
OPEN_FUNCTION_OVERWRITE_IF_EXISTS
static final int OPEN_FUNCTION_OVERWRITE_IF_EXISTS- See Also:
-
PID
static final int PID -
SECURITY_SHARE
static final int SECURITY_SHARE- See Also:
-
SECURITY_USER
static final int SECURITY_USER- See Also:
-
CMD_OFFSET
static final int CMD_OFFSET- See Also:
-
ERROR_CODE_OFFSET
static final int ERROR_CODE_OFFSET- See Also:
-
FLAGS_OFFSET
static final int FLAGS_OFFSET- See Also:
-
SIGNATURE_OFFSET
static final int SIGNATURE_OFFSET- See Also:
-
TID_OFFSET
static final int TID_OFFSET- See Also:
-
HEADER_LENGTH
static final int HEADER_LENGTH- See Also:
-
MILLISECONDS_BETWEEN_1970_AND_1601
static final long MILLISECONDS_BETWEEN_1970_AND_1601- See Also:
-
TZ
-
USE_BATCHING
static final boolean USE_BATCHING -
OEM_ENCODING
-
UNI_ENCODING
- See Also:
-
DEFAULT_FLAGS2
static final int DEFAULT_FLAGS2 -
DEFAULT_CAPABILITIES
static final int DEFAULT_CAPABILITIES -
FLAGS2
static final int FLAGS2 -
CAPABILITIES
static final int CAPABILITIES -
TCP_NODELAY
static final boolean TCP_NODELAY -
RESPONSE_TIMEOUT
static final int RESPONSE_TIMEOUT -
CONNECTIONS
-
SSN_LIMIT
static final int SSN_LIMIT -
SO_TIMEOUT
static final int SO_TIMEOUT -
CONN_TIMEOUT
static final int CONN_TIMEOUT -
NATIVE_OS
-
NATIVE_LANMAN
-
VC_NUMBER
static final int VC_NUMBER- See Also:
-
NULL_TRANSPORT
static final jcifs.smb.SmbTransport NULL_TRANSPORT
-
-
Constructor Details
-
SmbFile
Constructs an SmbFile representing a resource on an SMB network such as a file or directory. See the description and examples of smb URLs above.- Parameters:
url
- A URL string- Throws:
MalformedURLException
- If theparent
andchild
parameters do not follow the prescribed syntax
-
SmbFile
Constructs an SmbFile representing a resource on an SMB network such as a file or directory. The second parameter is a relative path from theparent SmbFile
. See the description above for examples of using the secondname
parameter.- Parameters:
context
- A baseSmbFile
name
- A path string relative to theparent
paremeter- Throws:
MalformedURLException
- If theparent
andchild
parameters do not follow the prescribed syntaxUnknownHostException
- If the server or workgroup of the context file cannot be determined
-
SmbFile
Constructs an SmbFile representing a resource on an SMB network such as a file or directory. The second parameter is a relative path from theparent
. See the description above for examples of using the secondchile
parameter.- Parameters:
context
- A URL stringname
- A path string relative to thecontext
paremeter- Throws:
MalformedURLException
- If thecontext
andname
parameters do not follow the prescribed syntax
-
SmbFile
Constructs an SmbFile representing a resource on an SMB network such as a file or directory.- Parameters:
url
- A URL stringauth
- The credentials the client should use for authentication- Throws:
MalformedURLException
- If theurl
parameter does not follow the prescribed syntax
-
SmbFile
public SmbFile(String url, NtlmPasswordAuthentication auth, int shareAccess) throws MalformedURLException Constructs an SmbFile representing a file on an SMB network. The shareAccess parameter controls what permissions other clients have when trying to access the same file while this instance is still open. This value is either FILE_NO_SHARE or any combination of FILE_SHARE_READ, FILE_SHARE_WRITE, and FILE_SHARE_DELETE logically OR'd together.- Parameters:
url
- A URL stringauth
- The credentials the client should use for authenticationshareAccess
- Specifies what access other clients have while this file is open.- Throws:
MalformedURLException
- If theurl
parameter does not follow the prescribed syntax
-
SmbFile
public SmbFile(String context, String name, NtlmPasswordAuthentication auth) throws MalformedURLException Constructs an SmbFile representing a resource on an SMB network such as a file or directory. The second parameter is a relative path from thecontext
. See the description above for examples of using the secondname
parameter.- Parameters:
context
- A URL stringname
- A path string relative to thecontext
paremeterauth
- The credentials the client should use for authentication- Throws:
MalformedURLException
- If thecontext
andname
parameters do not follow the prescribed syntax
-
SmbFile
public SmbFile(String context, String name, NtlmPasswordAuthentication auth, int shareAccess) throws MalformedURLException Constructs an SmbFile representing a resource on an SMB network such as a file or directory. The second parameter is a relative path from thecontext
. See the description above for examples of using the secondname
parameter. The shareAccess parameter controls what permissions other clients have when trying to access the same file while this instance is still open. This value is either FILE_NO_SHARE or any combination of FILE_SHARE_READ, FILE_SHARE_WRITE, and FILE_SHARE_DELETE logically OR'd together.- Parameters:
context
- A URL stringname
- A path string relative to thecontext
paremeterauth
- The credentials the client should use for authenticationshareAccess
- Specifies what access other clients have while this file is open.- Throws:
MalformedURLException
- If thecontext
andname
parameters do not follow the prescribed syntax
-
SmbFile
public SmbFile(SmbFile context, String name, int shareAccess) throws MalformedURLException, UnknownHostException Constructs an SmbFile representing a resource on an SMB network such as a file or directory. The second parameter is a relative path from thecontext
. See the description above for examples of using the secondname
parameter. The shareAccess parameter controls what permissions other clients have when trying to access the same file while this instance is still open. This value is either FILE_NO_SHARE or any combination of FILE_SHARE_READ, FILE_SHARE_WRITE, and FILE_SHARE_DELETE logically OR'd together.- Parameters:
context
- A baseSmbFile
name
- A path string relative to thecontext
file pathshareAccess
- Specifies what access other clients have while this file is open.- Throws:
MalformedURLException
- If thecontext
andname
parameters do not follow the prescribed syntaxUnknownHostException
-
SmbFile
Constructs an SmbFile representing a resource on an SMB network such as a file or directory from a URL object.- Parameters:
url
- The URL of the target resource
-
SmbFile
Constructs an SmbFile representing a resource on an SMB network such as a file or directory from a URL object and an NtlmPasswordAuthentication object.- Parameters:
url
- The URL of the target resourceauth
- The credentials the client should use for authentication
-
-
Method Details
-
connect
It is not necessary to call this method directly. This is the URLConnection implementation of connect().- Specified by:
connect
in classURLConnection
- Throws:
IOException
-
getPrincipal
Returns the NtlmPasswordAuthentication object used as credentials with this file or pipe. This can be used to retrieve the username for example: String username = f.getPrincipal().getName(); The Principal object returned will never be null however the username can be null indication anonymous credentials were used (e.g. some IPC$ services). -
getName
Returns the last component of the target URL. This will effectively be the name of the file or directory represented by thisSmbFile
or in the case of URLs that only specify a server or workgroup, the server or workgroup will be returned. The name of the root URLsmb://
is alsosmb://
. If this SmbFile refers to a workgroup, server, share, or directory, the name will include a trailing slash '/' so that composing new SmbFiles will maintain the trailing slash requirement.- Returns:
- The last component of the URL associated with this SMB
resource or
smb://
if the resource issmb://
itself.
-
getParent
Everything but the last component of the URL representing this SMB resource is effectivly it's parent. The root URLsmb://
does not have a parent. In this casesmb://
is returned.- Returns:
- The parent directory of this SMB resource or
smb://
if the resource refers to the root of the URL hierarchy which incedentally is alsosmb://
.
-
getPath
Returns the full uncanonicalized URL of this SMB resource. AnSmbFile
constructed with the result of this method will result in anSmbFile
that is equal to the original.- Returns:
- The uncanonicalized full URL of this SMB resource.
-
getUncPath
Retuns the Windows UNC style path with backslashs intead of forward slashes.- Returns:
- The UNC path.
-
getCanonicalPath
Returns the full URL of this SMB resource with '.' and '..' components factored out. AnSmbFile
constructed with the result of this method will result in anSmbFile
that is equal to the original.- Returns:
- The canonicalized URL of this SMB resource.
-
getServer
Retrieve the hostname of the server for this SMB resource. If thisSmbFile
references a workgroup, the name of the workgroup is returned. If thisSmbFile
refers to the root of this SMB network hierarchy,null
is returned.- Returns:
- The server or workgroup name or
null
if thisSmbFile
refers to the rootsmb://
resource.
-
getType
Returns type of of object this SmbFile represents.- Returns:
- TYPE_FILESYSTEM, TYPE_WORKGROUP, TYPE_SERVER, TYPE_SHARE, TYPE_PRINTER, TYPE_NAMED_PIPE, or TYPE_COMM.
- Throws:
SmbException
-
exists
Tests to see if the SMB resource exists. If the resource refers only to a server, this method determines if the server exists on the network and is advertising SMB services. If this resource refers to a workgroup, this method determines if the workgroup name is valid on the local SMB network. If thisSmbFile
refers to the rootsmb://
resourcetrue
is always returned. If thisSmbFile
is a traditional file or directory, it will be queried for on the specified server as expected.- Returns:
true
if the resource exists or is alive orfalse
otherwise- Throws:
SmbException
-
canRead
Tests to see if the file thisSmbFile
represents can be read. Because any file, directory, or other resource can be read if it exists, this method simply calls theexists
method.- Returns:
true
if the file is read-only- Throws:
SmbException
-
canWrite
Tests to see if the file thisSmbFile
represents exists and is not marked read-only. By default, resources are considered to be read-only and therefore forsmb://
,smb://workgroup/
, andsmb://server/
resources will be read-only.- Returns:
true
if the resource exists is not marked read-only- Throws:
SmbException
-
isDirectory
Tests to see if the file thisSmbFile
represents is a directory.- Returns:
true
if thisSmbFile
is a directory- Throws:
SmbException
-
isFile
Tests to see if the file thisSmbFile
represents is not a directory.- Returns:
true
if thisSmbFile
is not a directory- Throws:
SmbException
-
isHidden
Tests to see if the file this SmbFile represents is marked as hidden. This method will also return true for shares with names that end with '$' such asIPC$
orC$
.- Returns:
true
if theSmbFile
is marked as being hidden- Throws:
SmbException
-
getDfsPath
If the path of thisSmbFile
falls within a DFS volume, this method will return the referral path to which it maps. Otherwisenull
is returned.- Throws:
SmbException
-
createTime
Retrieve the time thisSmbFile
was created. The value returned is suitable for constructing aDate
object (i.e. seconds since Epoch 1970). Times should be the same as those reported using the properties dialog of the Windows Explorer program. For Win95/98/Me this is actually the last write time. It is currently not possible to retrieve the create time from files on these systems.- Returns:
- The number of milliseconds since the 00:00:00 GMT, January 1,
1970 as a
long
value - Throws:
SmbException
-
lastModified
Retrieve the last time the file represented by thisSmbFile
was modified. The value returned is suitable for constructing aDate
object (i.e. seconds since Epoch 1970). Times should be the same as those reported using the properties dialog of the Windows Explorer program.- Returns:
- The number of milliseconds since the 00:00:00 GMT, January 1,
1970 as a
long
value - Throws:
SmbException
-
list
List the contents of this SMB resource. The list returned by this method will be;- files and directories contained within this resource if the resource is a normal disk file directory,
- all available NetBIOS workgroups or domains if this resource is
the top level URL
smb://
, - all servers registered as members of a NetBIOS workgroup if this
resource refers to a workgroup in a
smb://workgroup/
URL, - all browseable shares of a server including printers, IPC
services, or disk volumes if this resource is a server URL in the form
smb://server/
, - or
null
if the resource cannot be resolved.
- Returns:
- A
String[]
array of files and directories, workgroups, servers, or shares depending on the context of the resource URL - Throws:
SmbException
-
list
List the contents of this SMB resource. The list returned will be identical to the list returned by the parameterlesslist()
method minus filenames filtered by the specified filter.- Parameters:
filter
- a filename filter to exclude filenames from the results- Throws:
SmbException
- # @return An array of filenames
-
listFiles
List the contents of this SMB resource as an array ofSmbFile
objects. This method is much more efficient than the regularlist
method when querying attributes of each file in the result set.The list of
SmbFile
s returned by this method will be;- files and directories contained within this resource if the resource is a normal disk file directory,
- all available NetBIOS workgroups or domains if this resource is
the top level URL
smb://
, - all servers registered as members of a NetBIOS workgroup if this
resource refers to a workgroup in a
smb://workgroup/
URL, - all browseable shares of a server including printers, IPC
services, or disk volumes if this resource is a server URL in the form
smb://server/
, - or
null
if the resource cannot be resolved.
- Returns:
- An array of
SmbFile
objects representing file and directories, workgroups, servers, or shares depending on the context of the resource URL - Throws:
SmbException
-
listFiles
The CIFS protocol provides for DOS "wildcards" to be used as a performance enhancement. The client does not have to filter the names and the server does not have to return all directory entries.The wildcard expression may consist of two special meta characters in addition to the normal filename characters. The '*' character matches any number of characters in part of a name. If the expression begins with one or more '?'s then exactly that many characters will be matched whereas if it ends with '?'s it will match that many characters or less.
Wildcard expressions will not filter workgroup names or server names.
winnt> ls c?o* clock.avi -rw-- 82944 Mon Oct 14 1996 1:38 AM Cookies drw-- 0 Fri Nov 13 1998 9:42 PM 2 items in 5ms
- Parameters:
wildcard
- a wildcard expression- Returns:
- An array of
SmbFile
objects representing file and directories, workgroups, servers, or shares depending on the context of the resource URL - Throws:
SmbException
-
listFiles
List the contents of this SMB resource. The list returned will be identical to the list returned by the parameterlesslistFiles()
method minus files filtered by the specified filename filter.- Parameters:
filter
- a filter to exclude files from the results- Returns:
- An array of SmbFile objects
- Throws:
SmbException
-
listFiles
List the contents of this SMB resource. The list returned will be identical to the list returned by the parameterlesslistFiles()
method minus filenames filtered by the specified filter.- Parameters:
filter
- a file filter to exclude files from the results- Returns:
- An array of SmbFile objects
- Throws:
SmbException
-
renameTo
Changes the name of the file thisSmbFile
represents to the name designated by theSmbFile
argument. Remember:SmbFile
s are immutible and therefore the path associated with thisSmbFile
object will not change). To access the renamed file it is necessary to construct a new SmbFile.- Parameters:
dest
- AnSmbFile
that represents the new pathname- Throws:
NullPointerException
- If thedest
argument isnull
SmbException
-
copyTo
This method will copy the file or directory represented by this SmbFile and it's sub-contents to the location specified by the dest parameter. This file and the destination file do not need to be on the same host. This operation does not copy extended file attibutes such as ACLs but it does copy regular attributes as well as create and last write times. This method is almost twice as efficient as manually copying as it employs an additional write thread to read and write data concurrently. It is not possible (nor meaningful) to copy entire workgroups or servers.- Parameters:
dest
- the destination file or directory- Throws:
SmbException
-
delete
This method will delete the file or directory specified by thisSmbFile
. If the target is a directory, the contents of the directory will be deleted as well. If a file within the directory or it's sub-directories is marked read-only, the read-only status will be removed and the file will be deleted.- Throws:
SmbException
-
length
Returns the length of this SmbFile in bytes. If this object is a TYPE_SHARE the total capacity of the disk shared in bytes is returned. If this object is a directory or a type other than TYPE_SHARE, 0L is returned.- Returns:
- The length of the file in bytes or 0 if this
SmbFile
is not a file. - Throws:
SmbException
-
getDiskFreeSpace
This method returns the free disk space in bytes of the drive this share represents or the drive on which the directory or file resides. Objects other than TYPE_SHARE or TYPE_FILESYSTEM will result in 0L being returned.- Returns:
- the free disk space in bytes of the drive on which this file or directory resides
- Throws:
SmbException
-
mkdir
Creates a directory with the path specified by thisSmbFile
. For this method to be successful, the target must not already exist. This method will fail when used withsmb://
,smb://workgroup/
,smb://server/
, orsmb://server/share/
URLs because workgroups, servers, and shares cannot be dynamically created (although in the future it may be possible to create shares).- Throws:
SmbException
-
mkdirs
Creates a directory with the path specified by this SmbFile and any parent directories that do not exist. This method will fail when used withsmb://
,smb://workgroup/
,smb://server/
, orsmb://server/share/
URLs because workgroups, servers, and shares cannot be dynamically created (although in the future it may be possible to create shares).- Throws:
SmbException
-
createNewFile
Create a new file but fail if it already exists. The check for existance of the file and it's creation are an atomic operation with respect to other filesystem activities.- Throws:
SmbException
-
setCreateTime
Set the create time of the file. The time is specified as milliseconds from Jan 1, 1970 which is the same as that which is returned by the createTime() method. This method does not apply to workgroups, servers, or shares.- Parameters:
time
- the create time as milliseconds since Jan 1, 1970- Throws:
SmbException
-
setLastModified
Set the last modified time of the file. The time is specified as milliseconds from Jan 1, 1970 which is the same as that which is returned by the lastModified(), getLastModified(), and getDate() methods. This method does not apply to workgroups, servers, or shares.- Parameters:
time
- the last modified time as milliseconds since Jan 1, 1970- Throws:
SmbException
-
getAttributes
Return the attributes of this file. Attributes are represented as a bitset that must be masked with ATTR_* constants to determine if they are set or unset. The value returned is suitable for use with the setAttributes() method.- Returns:
- the ATTR_* attributes associated with this file
- Throws:
SmbException
-
setAttributes
Set the attributes of this file. Attributes are composed into a bitset by bitwise ORing the ATTR_* constants. Setting the value returned by getAttributes will result in both files having the same attributes.- Throws:
SmbException
-
setReadOnly
Make this file read-only. This is shorthand for setAttributes( getAttributes() | ATTR_READ_ONLY ).- Throws:
SmbException
-
setReadWrite
Turn off the read-only attribute of this file. This is shorthand for setAttributes( getAttributes() invalid input: '&' ~ATTR_READONLY ).- Throws:
SmbException
-
toURL
Deprecated.Use getURL() insteadReturns aURL
for thisSmbFile
. TheURL
may be used as any otherURL
might to access an SMB resource. Currently only retrieving data and information is supported (i.e. no doOutput).- Returns:
- A new
for thisURL
SmbFile
- Throws:
MalformedURLException
-
hashCode
public int hashCode()Computes a hashCode for this file based on the URL string and IP address if the server. The hashing function uses the hashcode of the server address, the canonical representation of the URL, and does not compare authentication information. In essance, twoSmbFile
objects that refer to the same file should generate the same hashcode provided it is possible to make such a determination.- Overrides:
hashCode
in classObject
- Returns:
- A hashcode for this abstract file
- Throws:
SmbException
-
pathNamesPossiblyEqual
-
equals
Tests to see if twoSmbFile
objects are equal. Two SmbFile objects are equal when they reference the same SMB resource. More specifically, twoSmbFile
objects are equals if their server IP addresses are equal and the canonicalized representation of their URLs, minus authentication parameters, are case insensitivly and lexographically equal. For example, assuming the serverangus
resolves to the192.168.1.15
IP address, the below URLs would result inSmbFile
s that are equal.smb://192.168.1.15/share/DIR/foo.txt smb://angus/share/data/../dir/foo.txt
- Overrides:
equals
in classObject
- Parameters:
obj
- AnotherSmbFile
object to compare for equality- Returns:
true
if the two objects refer to the same SMB resource andfalse
otherwise- Throws:
SmbException
-
toString
Returns the string representation of this SmbFile object. This will be the same as the URL used to construct thisSmbFile
. This method will return the same value asgetPath
.- Overrides:
toString
in classURLConnection
- Returns:
- The original URL representation of this SMB resource
- Throws:
SmbException
-
getContentLength
public int getContentLength()This URLConnection method just returns the result of length().- Overrides:
getContentLength
in classURLConnection
- Returns:
- the length of this file or 0 if it refers to a directory
-
getDate
public long getDate()This URLConnection method just returns the result of lastModified.- Overrides:
getDate
in classURLConnection
- Returns:
- the last modified data as milliseconds since Jan 1, 1970
-
getLastModified
public long getLastModified()This URLConnection method just returns the result of lastModified.- Overrides:
getLastModified
in classURLConnection
- Returns:
- the last modified data as milliseconds since Jan 1, 1970
-
getInputStream
This URLConnection method just returns a new SmbFileInputStream created with this file.- Overrides:
getInputStream
in classURLConnection
- Throws:
IOException
- thrown by SmbFileInputStream constructor
-
getOutputStream
This URLConnection method just returns a new SmbFileOutputStream created with this file.- Overrides:
getOutputStream
in classURLConnection
- Throws:
IOException
- thrown by SmbFileOutputStream constructor
-
getSecurity
Return an array of Access Control Entry (ACE) objects representing the security descriptor associated with this file or directory. If no DACL is present, null is returned. If the DACL is empty, an array with 0 elements is returned.- Parameters:
resolveSids
- Attempt to resolve the SIDs within each ACE form their numeric representation to their corresponding account names.- Throws:
IOException
-
getSecurity
Return an array of Access Control Entry (ACE) objects representing the security descriptor associated with this file or directory.Initially, the SIDs within each ACE will not be resolved however when getType(), getDomainName(), getAccountName(), or toString() is called, the names will attempt to be resolved. If the names cannot be resolved (e.g. due to temporary network failure), the said methods will return default values (usually S-X-Y-Z strings of fragments of).
Alternatively getSecurity(true) may be used to resolve all SIDs together and detect network failures.
- Throws:
IOException
-