Class MSVSS

  • All Implemented Interfaces:
    java.lang.Cloneable, MSVSSConstants
    Direct Known Subclasses:
    MSVSSADD, MSVSSCHECKIN, MSVSSCHECKOUT, MSVSSCP, MSVSSCREATE, MSVSSGET, MSVSSHISTORY, MSVSSLABEL

    public abstract class MSVSS
    extends Task
    implements MSVSSConstants
    A base class for creating tasks for executing commands on Visual SourceSafe.

    The class extends the 'exec' task as it operates by executing the ss.exe program supplied with SourceSafe. By default the task expects ss.exe to be in the path, you can override this be specifying the ssdir attribute.

    This class provides set and get methods for 'login' and 'vsspath' attributes. It also contains constants for the flags that can be passed to SS.

    • Constructor Detail

      • MSVSS

        public MSVSS()
    • Method Detail

      • setSsdir

        public final void setSsdir​(java.lang.String dir)
        Directory where ss.exe resides. By default the task expects it to be in the PATH.
        Parameters:
        dir - The directory containing ss.exe.
      • setLogin

        public final void setLogin​(java.lang.String vssLogin)
        Login to use when accessing VSS, formatted as "username,password".

        You can omit the password if your database is not password protected. If you have a password and omit it, Ant will hang.

        Parameters:
        vssLogin - The login string to use.
      • setVsspath

        public final void setVsspath​(java.lang.String vssPath)
        SourceSafe path which specifies the project/file(s) you wish to perform the action on.

        A prefix of 'vss://' will be removed if specified.

        Parameters:
        vssPath - The VSS project path.
      • setServerpath

        public final void setServerpath​(java.lang.String serverPath)
        Directory where srssafe.ini resides.
        Parameters:
        serverPath - The path to the VSS server.
      • setFailOnError

        public final void setFailOnError​(boolean failOnError)
        Indicates if the build should fail if the Sourcesafe command does. Defaults to true.
        Parameters:
        failOnError - True if task should fail on any error.
      • execute

        public void execute()
                     throws BuildException
        Executes the task.

        Builds a command line to execute ss.exe and then calls Exec's run method to execute the command line.

        Overrides:
        execute in class Task
        Throws:
        BuildException - if the command cannot execute.
      • setInternalComment

        protected void setInternalComment​(java.lang.String comment)
        Set the internal comment attribute.
        Parameters:
        comment - the value to use.
      • setInternalAutoResponse

        protected void setInternalAutoResponse​(java.lang.String autoResponse)
        Set the auto response attribute.
        Parameters:
        autoResponse - the value to use.
      • setInternalDate

        protected void setInternalDate​(java.lang.String date)
        Set the date attribute.
        Parameters:
        date - the value to use.
      • setInternalDateFormat

        protected void setInternalDateFormat​(java.text.DateFormat dateFormat)
        Set the date format attribute.
        Parameters:
        dateFormat - the value to use.
      • setInternalFailOnError

        protected void setInternalFailOnError​(boolean failOnError)
        Set the failOnError attribute.
        Parameters:
        failOnError - the value to use.
      • setInternalFromDate

        protected void setInternalFromDate​(java.lang.String fromDate)
        Set the from date attribute.
        Parameters:
        fromDate - the value to use.
      • setInternalFromLabel

        protected void setInternalFromLabel​(java.lang.String fromLabel)
        Set the from label attribute.
        Parameters:
        fromLabel - the value to use.
      • setInternalLabel

        protected void setInternalLabel​(java.lang.String label)
        Set the label attribute.
        Parameters:
        label - the value to use.
      • setInternalLocalPath

        protected void setInternalLocalPath​(java.lang.String localPath)
        Set the local path comment attribute.
        Parameters:
        localPath - the value to use.
      • setInternalNumDays

        protected void setInternalNumDays​(int numDays)
        Set the num days attribute.
        Parameters:
        numDays - the value to use.
      • setInternalOutputFilename

        protected void setInternalOutputFilename​(java.lang.String outputFileName)
        Set the outputFileName comment attribute.
        Parameters:
        outputFileName - the value to use.
      • setInternalQuiet

        protected void setInternalQuiet​(boolean quiet)
        Set the quiet attribute.
        Parameters:
        quiet - the value to use.
      • setInternalRecursive

        protected void setInternalRecursive​(boolean recursive)
        Set the recursive attribute.
        Parameters:
        recursive - the value to use.
      • setInternalStyle

        protected void setInternalStyle​(java.lang.String style)
        Set the style attribute.
        Parameters:
        style - the value to use.
      • setInternalToDate

        protected void setInternalToDate​(java.lang.String toDate)
        Set the to date attribute.
        Parameters:
        toDate - the value to use.
      • setInternalToLabel

        protected void setInternalToLabel​(java.lang.String toLabel)
        Set the to label attribute.
        Parameters:
        toLabel - the value to use.
      • setInternalUser

        protected void setInternalUser​(java.lang.String user)
        Set the user attribute.
        Parameters:
        user - the value to use.
      • setInternalVersion

        protected void setInternalVersion​(java.lang.String version)
        Set the version attribute.
        Parameters:
        version - the value to use.
      • setInternalWritable

        protected void setInternalWritable​(boolean writable)
        Set the writable attribute.
        Parameters:
        writable - the value to use.
      • setInternalFileTimeStamp

        protected void setInternalFileTimeStamp​(MSVSS.CurrentModUpdated timestamp)
        Set the timestamp attribute.
        Parameters:
        timestamp - the value to use.
      • setInternalWritableFiles

        protected void setInternalWritableFiles​(MSVSS.WritableFiles writableFiles)
        Set the writableFiles attribute.
        Parameters:
        writableFiles - the value to use.
      • setInternalGetLocalCopy

        protected void setInternalGetLocalCopy​(boolean getLocalCopy)
        Set the getLocalCopy attribute.
        Parameters:
        getLocalCopy - the value to use.
      • getSSCommand

        protected java.lang.String getSSCommand()
        Gets the sscommand string. "ss" or "c:\path\to\ss"
        Returns:
        The path to ss.exe or just ss if sscommand is not set.
      • getVsspath

        protected java.lang.String getVsspath()
        Gets the vssserverpath string.
        Returns:
        null if vssserverpath is not set.
      • getQuiet

        protected java.lang.String getQuiet()
        Gets the quiet string. -O-
        Returns:
        An empty string if quiet is not set or is false.
      • getRecursive

        protected java.lang.String getRecursive()
        Gets the recursive string. "-R"
        Returns:
        An empty string if recursive is not set or is false.
      • getWritable

        protected java.lang.String getWritable()
        Gets the writable string. "-W"
        Returns:
        An empty string if writable is not set or is false.
      • getLabel

        protected java.lang.String getLabel()
        Gets the label string. "-Lbuild1" Max label length is 32 chars
        Returns:
        An empty string if label is not set.
      • getStyle

        protected java.lang.String getStyle()
        Gets the style string. "-Lbuild1"
        Returns:
        An empty string if label is not set.
      • getVersionDateLabel

        protected java.lang.String getVersionDateLabel()
        Gets the version string. Returns the first specified of version "-V1.0", date "-Vd01.01.01", label "-Vlbuild1".
        Returns:
        An empty string if a version, date and label are not set.
      • getVersion

        protected java.lang.String getVersion()
        Gets the version string.
        Returns:
        An empty string if a version is not set.
      • getLocalpath

        protected java.lang.String getLocalpath()
        Gets the localpath string. "-GLc:\source"

        The localpath is created if it didn't exist.

        Returns:
        An empty string if localpath is not set.
      • getComment

        protected java.lang.String getComment()
        Gets the comment string. "-Ccomment text"
        Returns:
        A comment of "-" if comment is not set.
      • getAutoresponse

        protected java.lang.String getAutoresponse()
        Gets the auto response string. This can be Y "-I-Y" or N "-I-N".
        Returns:
        The default value "-I-" if autoresponse is not set.
      • getLogin

        protected java.lang.String getLogin()
        Gets the login string. This can be user and password, "-Yuser,password" or just user "-Yuser".
        Returns:
        An empty string if login is not set.
      • getOutput

        protected java.lang.String getOutput()
        Gets the output file string. "-Ooutput.file"
        Returns:
        An empty string if user is not set.
      • getUser

        protected java.lang.String getUser()
        Gets the user string. "-Uusername"
        Returns:
        An empty string if user is not set.
      • getVersionLabel

        protected java.lang.String getVersionLabel()
        Gets the version string. This can be to-from "-VLbuild2~Lbuild1", from "~Lbuild1" or to "-VLbuild2".
        Returns:
        An empty string if neither tolabel or fromlabel are set.
      • getVersionDate

        protected java.lang.String getVersionDate()
                                           throws BuildException
        Gets the Version date string.
        Returns:
        An empty string if neither Todate or from date are set.
        Throws:
        BuildException - if there is an error.
      • getGetLocalCopy

        protected java.lang.String getGetLocalCopy()
        Builds and returns the -G- flag if required.
        Returns:
        An empty string if get local copy is true.
      • getFileTimeStamp

        public java.lang.String getFileTimeStamp()
        Gets the value set for the FileTimeStamp. if it equals "current" then we return -GTC if it equals "modified" then we return -GTM if it equals "updated" then we return -GTU otherwise we return -GTC
        Returns:
        The default file time flag, if not set.
      • getWritableFiles

        public java.lang.String getWritableFiles()
        Gets the value to determine the behaviour when encountering writable files.
        Returns:
        An empty String, if not set.