+ * The following attributes are interpreted: + *
| Attribute | + *Values | + *Required | + *
|---|---|---|
| login | + *username,password | + *No | + *
| vsspath | + *SourceSafe path | + *Yes | + *
| ssdir | + *directory where ss.exe resides. By default the task
+ * expects it to be in the PATH. |
+ * No | + *
| label | + *A label to apply to the hierarchy | + *Yes | + *
| version | + *An existing file or project version to label | + *No | + *
+ * Builds a command line to execute ss and then calls Exec's run method + * to execute the command line. + */ + public void execute() throws BuildException { + Commandline commandLine = new Commandline(); + int result = 0; + + // first off, make sure that we've got a command and a vssdir and a label ... + if (getVsspath() == null) { + String msg = "vsspath attribute must be set!"; + throw new BuildException(msg, location); + } + if (getLabel() == null) { + String msg = "label attribute must be set!"; + throw new BuildException(msg, location); + } + + // now look for illegal combinations of things ... + + // build the command line from what we got the format is + // ss Label VSS items [-C] [-H] [-I-] [-Llabel] [-N] [-O] [-V] [-Y] [-?] + // as specified in the SS.EXE help + commandLine.setExecutable(getSSCommand()); + commandLine.createArgument().setValue(COMMAND_LABEL); + + // VSS items + commandLine.createArgument().setValue(getVsspath()); + + // -C + // Use the same comment for all labels + // Not required + + // -I- + commandLine.createArgument().setValue("-I-"); // ignore all errors + + // -L + // Specify the new label on the command line (instead of being prompted) + getLabelCommand(commandLine); + + // -V + // Label an existing file or project version + getVersionCommand(commandLine); + + // -Y + getLoginCommand(commandLine); + + result = run(commandLine); + if ( result != 0 ) { + String msg = "Failed executing: " + commandLine.toString(); + throw new BuildException(msg, location); + } + + } + + /** + * Set the label to apply in SourceSafe + *
+ * Note we assume that if the supplied string has the value "null" that something + * went wrong and that the string value got populated from a null object. This + * happens if a ant variable is used e.g. label="${label_server}" when label_server + * has not been defined to ant! + */ + public void setLabel(String label) { + if ( label.equals("") || label.equals("null") ) { + m_Label = null; + } else { + m_Label = label; + } + } + + /** + * Builds the version command. + * @param cmd the commandline the command is to be added to + */ + public void getVersionCommand(Commandline cmd) { + if ( m_Version != null) { + cmd.createArgument().setValue(FLAG_VERSION + m_Version); + } + } + + /** + * Builds the label command. + * @param cmd the commandline the command is to be added to + */ + public void getLabelCommand(Commandline cmd) { + if ( m_Label != null) { + cmd.createArgument().setValue(FLAG_LABEL + m_Label); + } + } + + /** + * Set the stored version string + *
+ * Note we assume that if the supplied string has the value "null" that something + * went wrong and that the string value got populated from a null object. This + * happens if a ant variable is used e.g. version="${ver_server}" when ver_server + * has not been defined to ant! + */ + public void setVersion(String version) { + if (version.equals("") || version.equals("null") ) { + m_Version = null; + } else { + m_Version = version; + } + } + + /** + * Gets the label to be applied. + * @return the label to be applied. + */ + public String getLabel() { + return m_Label; + } + +}