/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.tools.ant.taskdefs.optional.sos;
import org.apache.tools.ant.types.Commandline;
/**
* Retrieves a read-only copy of the specified project or file
* from Visual SourceSafe via a SourceOffSite server.
*
* @ant.task name="sosget" category="scm"
*/
public class SOSGet extends SOS {
/**
* The Filename to act upon.
* If no file is specified then the tasks
* act upon the project.
*
* @param filename The new file value
*/
public final void setFile(String filename) {
super.setInternalFilename(filename);
}
/**
* Flag to recursively apply the action. Defaults to false
*
* @param recursive True for recursive operation.
*/
public void setRecursive(boolean recursive) {
super.setInternalRecursive(recursive);
}
/**
* Set the version number to get -
* only works with SOSGet on a file.
*
* @param version The new version value
*/
public void setVersion(String version) {
super.setInternalVersion(version);
}
/**
* The labeled version to operate on in SourceSafe.
*
* @param label The new label value
*/
public void setLabel(String label) {
super.setInternalLabel(label);
}
/**
* Build the command line <br>
*
* GetFile required parameters: -server -name -password -database -project -file<br>
* GetFile optional parameters: -workdir -revision -verbose -nocache -nocompression -soshome<br>
*
* GetProject required parameters: -server -name -password -database -project<br>
* GetProject optional parameters: -label -workdir -recursive -verbose -nocache
* -nocompression -soshome<br>
*
* @return Commandline the generated command to be executed
*/
@Override
protected Commandline buildCmdLine() {
commandLine = new Commandline();
// If we find a "file" attribute then act on a file otherwise act on a project
if (getFilename() != null) {
// add -command GetFile to the commandline
commandLine.createArgument().setValue(SOSCmd.FLAG_COMMAND);
commandLine.createArgument().setValue(SOSCmd.COMMAND_GET_FILE);
// add -file xxxxx to the commandline
commandLine.createArgument().setValue(SOSCmd.FLAG_FILE);
commandLine.createArgument().setValue(getFilename());
// look for a version attribute
if (getVersion() != null) {
//add -revision xxxxx to the commandline
commandLine.createArgument().setValue(SOSCmd.FLAG_VERSION);
commandLine.createArgument().setValue(getVersion());
}
} else {
// add -command GetProject to the commandline
commandLine.createArgument().setValue(SOSCmd.FLAG_COMMAND);
commandLine.createArgument().setValue(SOSCmd.COMMAND_GET_PROJECT);
// look for a recursive option
commandLine.createArgument().setValue(getRecursive());
// look for a label option
if (getLabel() != null) {
commandLine.createArgument().setValue(SOSCmd.FLAG_LABEL);
commandLine.createArgument().setValue(getLabel());
}
}
getRequiredAttributes();
getOptionalAttributes();
return commandLine;
}
}