<BODY BGCOLOR="white" onload="asd();">

SOSLabel (Apache Ant API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.tools.ant.taskdefs.optional.sos
Class SOSLabel


java.lang.Object

  |

  +--org.apache.tools.ant.ProjectComponent

        |

        +--org.apache.tools.ant.Task

              |

              +--org.apache.tools.ant.taskdefs.optional.sos.SOS

                    |

                    +--org.apache.tools.ant.taskdefs.optional.sos.SOSLabel

public class SOSLabel
extends SOS

Labels Visual SourceSafe files via a SourceOffSite server.

The following attributes are interpreted:

Attribute Values Required

soscmddir Directory which contains soscmd(.exe)
soscmd(.exe) must be in the path if this is not specified No

vssserverpath path to the srcsafe.ini - eg. \\server\vss\srcsafe.ini Yes

sosserverpath address and port of the SOS server - eg. 192.168.0.1:8888 Yes

projectpath SourceSafe project path without the "$" Yes

username SourceSafe username Yes

password SourceSafe password No

label The label to apply to a project Yes

comment A comment to be applied to all files being labeled No

verbose true or false - Status messages are displayed No

Author:: Jesse Stockall

Field Summary

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

SOSLabel()


Method Summary

protected Commandline buildCmdLine()
          Build the command line
AddLabel required parameters: -server -name -password -database -project -label
AddLabel optional parameters: -verbose -comment

void execute()
          Executes the task.

Methods inherited from class org.apache.tools.ant.taskdefs.optional.sos.SOS

getComment, getFilename, getLabel, getLocalPath, getNoCache, getNoCompress, getPassword, getProjectPath, getRecursive, getSosCommand, getSosHome, getSosServerPath, getUsername, getVerbose, getVersion, getVssServerPath, run, setComment, setFile, setLabel, setLocalPath, setNoCache, setNoCompress, setPassword, setProjectPath, setRecursive, setSosCmd, setSosHome, setSosServerPath, setUsername, setVerbose, setVersion, setVssServerPath

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

SOSLabel


public SOSLabel()

Method Detail

execute


public void execute()
             throws BuildException

Executes the task.
Builds a command line to execute soscmd and then calls Exec's run method to execute the command line.

Overrides:: execute in class Task

Throws:: BuildException - Description of Exception

buildCmdLine


protected Commandline buildCmdLine()

Build the command line
AddLabel required parameters: -server -name -password -database -project -label
AddLabel optional parameters: -verbose -comment

Returns:: Commandline the generated command to be executed