Package org.alfresco.filesys.util

Class CifsMounter

  • public class CifsMounter
extends java.lang.Object
    CIFS Mounter Class

    Mount/map a network drive taking care of platform differences.

    Author:
    gkspencer

    • Constructor Summary

      Constructors 
      Constructor Description
      CifsMounter()
      Default constructor
      CifsMounter​(java.lang.String srvName, java.lang.String shareName, java.lang.String userName, java.lang.String password)
      Class constructor

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getPassword()
      Return the password
      int getProtocolPort()
      Return the protocol port
      java.lang.String getServerAddress()
      Return hte server address
      java.lang.String getServerName()
      Return the server name
      java.lang.String getShareName()
      Return the share name
      java.lang.String getUserName()
      Return the user name
      int isProtocolType()
      Return the protocol type
      void mountFilesystem​(java.lang.String driveLetter, java.lang.String mountPoint)
      Mount a remote CIFS shared filesystem
      void setPassword​(java.lang.String password)
      Set the password
      void setProtocolPort​(int port)
      Set the port to use for the connection
      void setProtocolType​(int proto)
      Set the protocol type to use
      void setServerAddress​(java.lang.String srvAddr)
      Set the server address
      void setServerName​(java.lang.String name)
      Set the server name
      void setShareName​(java.lang.String name)
      Set the share name
      void setUserName​(java.lang.String user)
      Set the user name
      java.lang.String toString()
      Return the CIFS mounter as a string
      void unmountFilesystem​(java.lang.String driveLetter, java.lang.String mountPoint)
      Unmount a remote CIFS shared filesystem

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • CifsMounter

        public CifsMounter()
        Default constructor

      • CifsMounter

        public CifsMounter​(java.lang.String srvName,
                   java.lang.String shareName,
                   java.lang.String userName,
                   java.lang.String password)
        Class constructor
        Parameters:
        srvName - String
        shareName - String
        userName - String
        password - String

    • Method Detail

      • mountFilesystem

        public void mountFilesystem​(java.lang.String driveLetter,
                            java.lang.String mountPoint)
                     throws CifsMountException
        Mount a remote CIFS shared filesystem
        Parameters:
        driveLetter - String
        mountPoint - String
        Throws:
        CifsMountException

      • unmountFilesystem

        public void unmountFilesystem​(java.lang.String driveLetter,
                              java.lang.String mountPoint)
                       throws CifsMountException
        Unmount a remote CIFS shared filesystem
        Parameters:
        driveLetter - String
        mountPoint - String
        Throws:
        CifsMountException

      • getServerName

        public final java.lang.String getServerName()
        Return the server name
        Returns:
        String

      • getServerAddress

        public final java.lang.String getServerAddress()
        Return hte server address
        Returns:
        String

      • getShareName

        public final java.lang.String getShareName()
        Return the share name
        Returns:
        String

      • getUserName

        public final java.lang.String getUserName()
        Return the user name
        Returns:
        String

      • getPassword

        public final java.lang.String getPassword()
        Return the password
        Returns:
        String

      • isProtocolType

        public final int isProtocolType()
        Return the protocol type
        Returns:
        int

      • getProtocolPort

        public final int getProtocolPort()
        Return the protocol port
        Returns:
        int

      • setServerName

        public final void setServerName​(java.lang.String name)
        Set the server name
        Parameters:
        name - String

      • setServerAddress

        public final void setServerAddress​(java.lang.String srvAddr)
        Set the server address
        Parameters:
        srvAddr - String

      • setShareName

        public final void setShareName​(java.lang.String name)
        Set the share name
        Parameters:
        name - String

      • setUserName

        public final void setUserName​(java.lang.String user)
        Set the user name
        Parameters:
        user - String

      • setPassword

        public final void setPassword​(java.lang.String password)
        Set the password
        Parameters:
        password - String

      • setProtocolType

        public final void setProtocolType​(int proto)
        Set the protocol type to use
        Parameters:
        proto - int

      • setProtocolPort

        public final void setProtocolPort​(int port)
        Set the port to use for the connection
        Parameters:
        port - int

      • toString

        public java.lang.String toString()
        Return the CIFS mounter as a string
        Overrides:
        toString in class java.lang.Object
        Returns:
        String