Package jcifs

Interface SmbResourceLocator

  • All Known Subinterfaces:
    SmbResourceLocatorInternal
    public interface SmbResourceLocator
    Location information for a SMB resource
    Author:
    mbechler

    • Method Detail

      • getName

        String getName()
        Returns the last component of the target URL. This will effectively be the name of the file or directory represented by this 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.

      • getDfsReferral

        DfsReferralData getDfsReferral()
        Returns:
        dfs referral data

      • getParent

        String getParent()
        Everything but the last component of the URL representing this SMB resource is effectively it's parent. The root URL 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 incidentally is also smb://.

      • getPath

        String getPath()
        Returns the full uncanonicalized URL of this SMB resource. An 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.

      • getCanonicalURL

        String getCanonicalURL()
        Returns the full URL of this SMB resource with '.' and '..' components factored out. An 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.

      • getUNCPath

        String getUNCPath()
        Returns:
        The canonicalized UNC path of this SMB resource (relative to it's share)

      • getURLPath

        String getURLPath()
        Returns:
        The canonicalized URL path (relative to the server/domain)

      • getShare

        String getShare()
        Retrieves the share associated with this SMB resource. In the case of 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

      • getServerWithDfs

        String getServerWithDfs()
        Retrieve the hostname of the server for this SMB resource. If the resources has been resolved by DFS this will return the target name.
        Returns:
        The server name

      • getServer

        String getServer()
        Retrieve the hostname of the server for this SMB resource. If this 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.

      • getDfsPath

        String getDfsPath()
        If the path of this SmbFile falls within a DFS volume, this method will return the referral path to which it maps. Otherwise null is returned.
        Returns:
        URL to the DFS volume

      • getPort

        int getPort()
        Returns:
        the transport port, if specified

      • getURL

        URL getURL()
        Returns:
        the original URL

      • isIPC

        boolean isIPC()
        Returns:
        whether this is a IPC connection

      • getType

        int getType()
     throws CIFSException
        Returns type of of object this SmbFile represents.
        Returns:
        TYPE_FILESYSTEM, TYPE_WORKGROUP, TYPE_SERVER, TYPE_NAMED_PIPE, or TYPE_SHARE in which case it may be either TYPE_SHARE, TYPE_PRINTER or TYPE_COMM.
        Throws:
        CIFSException

      • isRoot

        boolean isRoot()
        Returns:
        whether this is a root resource