jcifs.smb
public class SmbFile extends URLConnection implements SmbConstants
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 java.io.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 and renameTo 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: java.io.File
Field Summary | |
---|---|
static int | ATTR_ARCHIVE
A file with this bit on as returned by getAttributes() or set
with setAttributes() is an archived file |
static int | ATTR_DIRECTORY
A file with this bit on as returned by getAttributes() is
a directory |
static int | ATTR_HIDDEN
A file with this bit on as returned by getAttributes() or set
with setAttributes() will be hidden |
static int | ATTR_READONLY
A file with this bit on as returned by getAttributes() or set
with setAttributes() will be read-only |
static int | ATTR_SYSTEM
A file with this bit on as returned by getAttributes() or set
with setAttributes() will be a system file |
static int | ATTR_VOLUME
A file with this bit on as returned by getAttributes() is
a volume |
static int | FILE_NO_SHARE
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 int | FILE_SHARE_DELETE
When specified as the shareAccess constructor parameter,
other SMB clients will be permitted to delete the target file while
this file is open. |
static int | FILE_SHARE_READ
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 int | FILE_SHARE_WRITE
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 int | TYPE_COMM
Returned by getType if the resource this SmbFile
represents is a communications device. |
static int | TYPE_FILESYSTEM
Returned by getType if the resource this SmbFile
represents is a regular file or directory. |
static int | TYPE_NAMED_PIPE
Returned by getType if the resource this SmbFile
represents is a named pipe. |
static int | TYPE_PRINTER
Returned by getType if the resource this SmbFile
represents is a printer. |
static int | TYPE_SERVER
Returned by getType if the resource this SmbFile
represents is a server. |
static int | TYPE_SHARE
Returned by getType if the resource this SmbFile
represents is a share. |
static int | TYPE_WORKGROUP
Returned by getType if the resource this SmbFile
represents is a workgroup. |
Constructor Summary | |
---|---|
SmbFile(String url)
Constructs an SmbFile representing a resource on an SMB network such as
a file or directory. | |
SmbFile(SmbFile context, String name)
Constructs an SmbFile representing a resource on an SMB network such
as a file or directory. | |
SmbFile(String context, String name)
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. | |
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(SmbFile context, String name, int shareAccess)
Constructs an SmbFile representing a resource on an SMB network such
as a file or directory. | |
SmbFile(URL url)
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.
|
Method Summary | |
---|---|
boolean | canRead()
Tests to see if the file this SmbFile represents can be
read. |
boolean | canWrite()
Tests to see if the file this SmbFile represents
exists and is not marked read-only. |
void | connect()
It is not necessary to call this method directly. |
void | copyTo(SmbFile dest)
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 | createNewFile()
Create a new file but fail if it already exists. |
long | createTime()
Retrieve the time this SmbFile was created. |
void | delete()
This method will delete the file or directory specified by this
SmbFile . |
boolean | equals(Object obj)
Tests to see if two SmbFile objects are equal. |
boolean | exists()
Tests to see if the SMB resource exists. |
int | getAttributes()
Return the attributes of this file. |
String | getCanonicalPath()
Returns the full URL of this SMB resource with '.' and '..' components
factored out. |
int | getContentLength()
This URLConnection method just returns the result of length().
|
long | getDate()
This URLConnection method just returns the result of lastModified.
|
String | getDfsPath()
If the path of this SmbFile falls within a DFS volume,
this method will return the referral path to which it maps. |
long | 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. |
InputStream | getInputStream()
This URLConnection method just returns a new SmbFileInputStream created with this file.
|
long | getLastModified()
This URLConnection method just returns the result of lastModified.
|
String | getName()
Returns the last component of the target URL. |
OutputStream | getOutputStream()
This URLConnection method just returns a new SmbFileOutputStream created with this file.
|
String | getParent()
Everything but the last component of the URL representing this SMB
resource is effectivly it's parent. |
String | getPath()
Returns the full uncanonicalized URL of this SMB resource. |
Principal | getPrincipal()
Returns the NtlmPasswordAuthentication object used as
credentials with this file or pipe. |
ACE[] | getSecurity(boolean resolveSids)
Return an array of Access Control Entry (ACE) objects representing
the security descriptor associated with this file or directory. |
ACE[] | getSecurity()
Return an array of Access Control Entry (ACE) objects representing
the security descriptor associated with this file or directory.
|
String | getServer()
Retrieve the hostname of the server for this SMB resource. |
String | 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. |
String | getUncPath()
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 | isDirectory()
Tests to see if the file this SmbFile represents is a directory.
|
boolean | isFile()
Tests to see if the file this SmbFile represents is not a directory.
|
boolean | isHidden()
Tests to see if the file this SmbFile represents is marked as
hidden. |
long | lastModified()
Retrieve the last time the file represented by this
SmbFile 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[] | listFiles()
List the contents of this SMB resource as an array of
SmbFile objects. |
SmbFile[] | listFiles(String wildcard)
The CIFS protocol provides for DOS "wildcards" to be used as
a performance enhancement. |
SmbFile[] | listFiles(SmbFilenameFilter filter)
List the contents of this SMB resource. |
SmbFile[] | listFiles(SmbFileFilter filter)
List the contents of this SMB resource. |
void | mkdir()
Creates a directory with the path specified by this
SmbFile . |
void | mkdirs()
Creates a directory with the path specified by this SmbFile
and any parent directories that do not exist. |
void | renameTo(SmbFile dest)
Changes the name of the file this SmbFile represents to the name
designated by the SmbFile 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 | setReadOnly()
Make this file read-only. |
void | setReadWrite()
Turn off the read-only attribute of this file. |
String | toString()
Returns the string representation of this SmbFile object. |
URL | toURL()
Returns a java.net.URL for this SmbFile . |
Parameters: url A URL string
Throws: MalformedURLException
If the parent
and child
parameters
do not follow the prescribed syntax
parent SmbFile
. See the description above for examples
of using the second name
parameter.
Parameters: context A base SmbFile
name A path string relative to the parent
paremeter
Throws: MalformedURLException
If the parent
and child
parameters
do not follow the prescribed syntax UnknownHostException
If the server or workgroup of the context file cannot be determined
parent
. See the description above for examples of
using the second chile
parameter.
Parameters: context A URL string name A path string relative to the context
paremeter
Throws: MalformedURLException
If the context
and name
parameters
do not follow the prescribed syntax
Parameters: url A URL string auth The credentials the client should use for authentication
Throws: MalformedURLException
If the url
parameter does not follow the prescribed syntax
Parameters: url A URL string auth The credentials the client should use for authentication shareAccess Specifies what access other clients have while this file is open.
Throws: MalformedURLException
If the url
parameter does not follow the prescribed syntax
context
. See the description above for examples of
using the second name
parameter.
Parameters: context A URL string name A path string relative to the context
paremeter auth The credentials the client should use for authentication
Throws: MalformedURLException
If the context
and name
parameters
do not follow the prescribed syntax
context
. See the description above for examples of
using the second name
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 string name A path string relative to the context
paremeter auth The credentials the client should use for authentication shareAccess Specifies what access other clients have while this file is open.
Throws: MalformedURLException
If the context
and name
parameters
do not follow the prescribed syntax
context
. See the description above for examples of
using the second name
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 base SmbFile
name A path string relative to the context
file path shareAccess Specifies what access other clients have while this file is open.
Throws: MalformedURLException
If the context
and name
parameters
do not follow the prescribed syntax
Parameters: url The URL of the target resource
Parameters: url The URL of the target resource auth The credentials the client should use for authentication
SmbFile
represents can be
read. Because any file, directory, or other resource can be read if it
exists, this method simply calls the exists
method.
Returns: true
if the file is read-only
SmbFile
represents
exists and is not marked read-only. By default, resources are
considered to be read-only and therefore for smb://
,
smb://workgroup/
, and smb://server/
resources
will be read-only.
Returns: true
if the resource exists is not marked
read-only
Parameters: dest the destination file or directory
Throws: SmbException
SmbFile
was created. The value
returned is suitable for constructing a java.util.Date 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
SmbFile
. 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
SmbFile
objects are equal. Two
SmbFile objects are equal when they reference the same SMB
resource. More specifically, two SmbFile
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 server angus
resolves to the
192.168.1.15
IP address, the below URLs would result in
SmbFile
s that are equal.
smb://192.168.1.15/share/DIR/foo.txt smb://angus/share/data/../dir/foo.txt
Parameters: obj Another SmbFile
object to compare for equality
Returns: true
if the two objects refer to the same SMB resource
and false
otherwise
Throws: SmbException
SmbFile
refers to the root
smb://
resource true
is always returned. If
this SmbFile
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 or
false
otherwise
Returns: the ATTR_* attributes associated with this file
Throws: SmbException
SmbFile
constructed with the result of
this method will result in an SmbFile
that is equal to
the original.
Returns: The canonicalized URL of this SMB resource.
Returns: the length of this file or 0 if it refers to a directory
Returns: the last modified data as milliseconds since Jan 1, 1970
SmbFile
falls within a DFS volume,
this method will return the referral path to which it maps. Otherwise
null
is returned.Returns: the free disk space in bytes of the drive on which this file or directory resides
Throws: IOException thrown by SmbFileInputStream constructor
Returns: the last modified data as milliseconds since Jan 1, 1970
SmbFile
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 URL smb://
is also smb://
. 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 is smb://
itself.
Throws: IOException thrown by SmbFileOutputStream constructor
smb://
does not have a parent. In this case smb://
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 also smb://
.
SmbFile
constructed with the result of this method will
result in an SmbFile
that is equal to the original.
Returns: The uncanonicalized full URL of this SMB resource.
Parameters: resolveSids Attempt to resolve the SIDs within each ACE form their numeric representation to their corresponding account names.
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.
SmbFile
references a workgroup, the name of the workgroup
is returned. If this SmbFile
refers to the root of this
SMB network hierarchy, null
is returned.
Returns: The server or workgroup name or null
if this
SmbFile
refers to the root smb://
resource.
smb://
, smb://workgroup/
,
and smb://server/
URLs which do not specify a share,
null
will be returned.
Returns: The share component or null
if there is no share
Note that this is different from calling getSecurity on a share. There are actually two different ACLs for shares - the ACL on the share and the ACL on the folder being shared. Go to Computer Management > System Tools > Shared Folders > Shares and look at the Properties for a share. You will see two tabs - one for "Share Permissions" and another for "Security". These correspond to the ACLs returned by getShareSecurity and getSecurity respectively.
Parameters: resolveSids Attempt to resolve the SIDs within each ACE form their numeric representation to their corresponding account names.
Returns: TYPE_FILESYSTEM, TYPE_WORKGROUP, TYPE_SERVER, TYPE_SHARE, TYPE_PRINTER, TYPE_NAMED_PIPE, or TYPE_COMM.
Returns: The UNC path.
SmbFile
objects that refer to
the same file should generate the same hashcode provided it is possible
to make such a determination.
Returns: A hashcode for this abstract file
Throws: SmbException
SmbFile
represents is a directory.
Returns: true
if this SmbFile
is a directory
SmbFile
represents is not a directory.
Returns: true
if this SmbFile
is not a directory
IPC$
or C$
.
Returns: true
if the SmbFile
is marked as being hidden
SmbFile
was modified. The value returned is suitable for
constructing a java.util.Date 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
Returns: The length of the file in bytes or 0 if this
SmbFile
is not a file.
Throws: SmbException
smb://
,
smb://workgroup/
URL,
smb://server/
,
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
list()
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
SmbFile
objects. This method is much more efficient than
the regular list
method when querying attributes of each
file in the result set.
The list of SmbFile
s returned by this method will be;
smb://
,
smb://workgroup/
URL,
smb://server/
,
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
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()
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()
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
SmbFile
. For this method to be successful, the target
must not already exist. This method will fail when
used with smb://
, smb://workgroup/
,
smb://server/
, or smb://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
smb://
, smb://workgroup/
,
smb://server/
, or smb://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
SmbFile
represents to the name
designated by the SmbFile
argument.
Remember: SmbFile
s are immutible and therefore
the path associated with this SmbFile
object will not
change). To access the renamed file it is necessary to construct a
new SmbFile.
Parameters: dest An SmbFile
that represents the new pathname
Returns: true
if the file or directory was successfully renamed
Throws: NullPointerException
If the dest
argument is null
Throws: SmbException
Parameters: time the create time as milliseconds since Jan 1, 1970
Parameters: time the last modified time as milliseconds since Jan 1, 1970
Throws: SmbException
Throws: SmbException
SmbFile
.
This method will return the same value
as getPath
.
Returns: The original URL representation of this SMB resource
Throws: SmbException
Deprecated: Use getURL() instead
Returns a java.net.URL for thisSmbFile
. The
URL
may be used as any other URL
might to
access an SMB resource. Currently only retrieving data and information
is supported (i.e. no doOutput).
Returns: A new java.net.URL
for this SmbFile
Throws: MalformedURLException