source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOS.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 47.0 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:30 NZST 2007 -->
6<TITLE>
7SOS (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.sos.SOS class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="SOS (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;PREV CLASS&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCheckin.html" title="class in org.apache.tools.ant.taskdefs.optional.sos"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="SOS.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs.optional.sos</FONT>
85<BR>
86Class SOS</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A>
91 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.sos.SOS</B>
92</PRE>
93<DL>
94<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html" title="interface in org.apache.tools.ant.taskdefs.optional.sos">SOSCmd</A></DD>
95</DL>
96<DL>
97<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCheckin.html" title="class in org.apache.tools.ant.taskdefs.optional.sos">SOSCheckin</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.html" title="class in org.apache.tools.ant.taskdefs.optional.sos">SOSCheckout</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSGet.html" title="class in org.apache.tools.ant.taskdefs.optional.sos">SOSGet</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.html" title="class in org.apache.tools.ant.taskdefs.optional.sos">SOSLabel</A></DD>
98</DL>
99<HR>
100<DL>
101<DT>public abstract class <B>SOS</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A><DT>implements <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html" title="interface in org.apache.tools.ant.taskdefs.optional.sos">SOSCmd</A></DL>
102
103<P>
104A base class for creating tasks for executing commands on SourceOffSite.
105
106 These tasks were inspired by the VSS tasks
107<P>
108
109<P>
110<HR>
111
112<P>
113<!-- ======== NESTED CLASS SUMMARY ======== -->
114
115
116<!-- =========== FIELD SUMMARY =========== -->
117
118<A NAME="field_summary"><!-- --></A>
119<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
120<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
121<TD COLSPAN=2><FONT SIZE="+2">
122<B>Field Summary</B></FONT></TD>
123</TR>
124<TR BGCOLOR="white" CLASS="TableRowColor">
125<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
126<CODE>protected &nbsp;<A HREF="../../../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A></CODE></FONT></TD>
127<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#commandLine">commandLine</A></B></CODE>
128
129<BR>
130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Commandline to be executed</TD>
131</TR>
132</TABLE>
133&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
134<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
135<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
136<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
137</TR>
138<TR BGCOLOR="white" CLASS="TableRowColor">
139<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#description">description</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#location">location</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#target">target</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#taskName">taskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#taskType">taskType</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</A></CODE></TD>
140</TR>
141</TABLE>
142&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
143<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
144<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
145<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
146</TR>
147<TR BGCOLOR="white" CLASS="TableRowColor">
148<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
149</TR>
150</TABLE>
151&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.sos.SOSCmd"><!-- --></A>
152<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
153<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
154<TD><B>Fields inherited from interface org.apache.tools.ant.taskdefs.optional.sos.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html" title="interface in org.apache.tools.ant.taskdefs.optional.sos">SOSCmd</A></B></TD>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_CHECKIN_FILE">COMMAND_CHECKIN_FILE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_CHECKIN_PROJECT">COMMAND_CHECKIN_PROJECT</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_CHECKOUT_FILE">COMMAND_CHECKOUT_FILE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_CHECKOUT_PROJECT">COMMAND_CHECKOUT_PROJECT</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_GET_FILE">COMMAND_GET_FILE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_GET_PROJECT">COMMAND_GET_PROJECT</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_HISTORY">COMMAND_HISTORY</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_LABEL">COMMAND_LABEL</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#COMMAND_SOS_EXE">COMMAND_SOS_EXE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_COMMAND">FLAG_COMMAND</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_COMMENT">FLAG_COMMENT</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_FILE">FLAG_FILE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_LABEL">FLAG_LABEL</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_NO_CACHE">FLAG_NO_CACHE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_NO_COMPRESSION">FLAG_NO_COMPRESSION</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_PASSWORD">FLAG_PASSWORD</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_PROJECT">FLAG_PROJECT</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_RECURSION">FLAG_RECURSION</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_SOS_HOME">FLAG_SOS_HOME</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_SOS_SERVER">FLAG_SOS_SERVER</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_USERNAME">FLAG_USERNAME</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_VERBOSE">FLAG_VERBOSE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_VERSION">FLAG_VERSION</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_VSS_SERVER">FLAG_VSS_SERVER</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#FLAG_WORKING_DIR">FLAG_WORKING_DIR</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html#PROJECT_PREFIX">PROJECT_PREFIX</A></CODE></TD>
158</TR>
159</TABLE>
160&nbsp;
161<!-- ======== CONSTRUCTOR SUMMARY ======== -->
162
163<A NAME="constructor_summary"><!-- --></A>
164<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
165<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
166<TD COLSPAN=2><FONT SIZE="+2">
167<B>Constructor Summary</B></FONT></TD>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#SOS()">SOS</A></B>()</CODE>
171
172<BR>
173&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
174</TR>
175</TABLE>
176&nbsp;
177<!-- ========== METHOD SUMMARY =========== -->
178
179<A NAME="method_summary"><!-- --></A>
180<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
181<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
182<TD COLSPAN=2><FONT SIZE="+2">
183<B>Method Summary</B></FONT></TD>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187<CODE>&nbsp;void</CODE></FONT></TD>
188<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#execute()">execute</A></B>()</CODE>
189
190<BR>
191&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Execute the created command line.</TD>
192</TR>
193<TR BGCOLOR="white" CLASS="TableRowColor">
194<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
195<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
196<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getComment()">getComment</A></B>()</CODE>
197
198<BR>
199&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the comment</TD>
200</TR>
201<TR BGCOLOR="white" CLASS="TableRowColor">
202<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
203<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
204<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getFilename()">getFilename</A></B>()</CODE>
205
206<BR>
207&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the filename to be acted upon</TD>
208</TR>
209<TR BGCOLOR="white" CLASS="TableRowColor">
210<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
211<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
212<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getLabel()">getLabel</A></B>()</CODE>
213
214<BR>
215&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the label</TD>
216</TR>
217<TR BGCOLOR="white" CLASS="TableRowColor">
218<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
219<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
220<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getLocalPath()">getLocalPath</A></B>()</CODE>
221
222<BR>
223&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Builds and returns the working directory.</TD>
224</TR>
225<TR BGCOLOR="white" CLASS="TableRowColor">
226<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
227<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
228<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getNoCache()">getNoCache</A></B>()</CODE>
229
230<BR>
231&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the NoCache flag</TD>
232</TR>
233<TR BGCOLOR="white" CLASS="TableRowColor">
234<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
235<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
236<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getNoCompress()">getNoCompress</A></B>()</CODE>
237
238<BR>
239&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the NoCompress flag</TD>
240</TR>
241<TR BGCOLOR="white" CLASS="TableRowColor">
242<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
243<CODE>protected &nbsp;void</CODE></FONT></TD>
244<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getOptionalAttributes()">getOptionalAttributes</A></B>()</CODE>
245
246<BR>
247&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the optional attributes to the command line.</TD>
248</TR>
249<TR BGCOLOR="white" CLASS="TableRowColor">
250<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
251<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
252<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getPassword()">getPassword</A></B>()</CODE>
253
254<BR>
255&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the password</TD>
256</TR>
257<TR BGCOLOR="white" CLASS="TableRowColor">
258<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
259<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
260<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getProjectPath()">getProjectPath</A></B>()</CODE>
261
262<BR>
263&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the project path</TD>
264</TR>
265<TR BGCOLOR="white" CLASS="TableRowColor">
266<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
267<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
268<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getRecursive()">getRecursive</A></B>()</CODE>
269
270<BR>
271&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the 'recursive' Flag</TD>
272</TR>
273<TR BGCOLOR="white" CLASS="TableRowColor">
274<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
275<CODE>protected &nbsp;void</CODE></FONT></TD>
276<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getRequiredAttributes()">getRequiredAttributes</A></B>()</CODE>
277
278<BR>
279&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the executable and add the required attributes to the command line.</TD>
280</TR>
281<TR BGCOLOR="white" CLASS="TableRowColor">
282<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
283<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
284<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getSosCommand()">getSosCommand</A></B>()</CODE>
285
286<BR>
287&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the executable to run.</TD>
288</TR>
289<TR BGCOLOR="white" CLASS="TableRowColor">
290<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
291<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
292<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getSosHome()">getSosHome</A></B>()</CODE>
293
294<BR>
295&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the SOS home directory</TD>
296</TR>
297<TR BGCOLOR="white" CLASS="TableRowColor">
298<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
299<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
300<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getSosServerPath()">getSosServerPath</A></B>()</CODE>
301
302<BR>
303&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the SOS serve path</TD>
304</TR>
305<TR BGCOLOR="white" CLASS="TableRowColor">
306<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
307<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
308<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getUsername()">getUsername</A></B>()</CODE>
309
310<BR>
311&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the username</TD>
312</TR>
313<TR BGCOLOR="white" CLASS="TableRowColor">
314<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
315<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
316<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getVerbose()">getVerbose</A></B>()</CODE>
317
318<BR>
319&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the 'verbose' Flag</TD>
320</TR>
321<TR BGCOLOR="white" CLASS="TableRowColor">
322<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
323<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
324<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getVersion()">getVersion</A></B>()</CODE>
325
326<BR>
327&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the version</TD>
328</TR>
329<TR BGCOLOR="white" CLASS="TableRowColor">
330<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
331<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
332<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#getVssServerPath()">getVssServerPath</A></B>()</CODE>
333
334<BR>
335&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the VSS server path</TD>
336</TR>
337<TR BGCOLOR="white" CLASS="TableRowColor">
338<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
339<CODE>protected &nbsp;int</CODE></FONT></TD>
340<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#run(org.apache.tools.ant.types.Commandline)">run</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A>&nbsp;cmd)</CODE>
341
342<BR>
343&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Execute the created command line.</TD>
344</TR>
345<TR BGCOLOR="white" CLASS="TableRowColor">
346<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
347<CODE>protected &nbsp;void</CODE></FONT></TD>
348<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setInternalComment(java.lang.String)">setInternalComment</A></B>(java.lang.String&nbsp;text)</CODE>
349
350<BR>
351&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
352</TR>
353<TR BGCOLOR="white" CLASS="TableRowColor">
354<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
355<CODE>protected &nbsp;void</CODE></FONT></TD>
356<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setInternalFilename(java.lang.String)">setInternalFilename</A></B>(java.lang.String&nbsp;file)</CODE>
357
358<BR>
359&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
360</TR>
361<TR BGCOLOR="white" CLASS="TableRowColor">
362<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
363<CODE>protected &nbsp;void</CODE></FONT></TD>
364<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setInternalLabel(java.lang.String)">setInternalLabel</A></B>(java.lang.String&nbsp;text)</CODE>
365
366<BR>
367&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
368</TR>
369<TR BGCOLOR="white" CLASS="TableRowColor">
370<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
371<CODE>protected &nbsp;void</CODE></FONT></TD>
372<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setInternalRecursive(boolean)">setInternalRecursive</A></B>(boolean&nbsp;recurse)</CODE>
373
374<BR>
375&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
376</TR>
377<TR BGCOLOR="white" CLASS="TableRowColor">
378<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
379<CODE>protected &nbsp;void</CODE></FONT></TD>
380<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setInternalVersion(java.lang.String)">setInternalVersion</A></B>(java.lang.String&nbsp;text)</CODE>
381
382<BR>
383&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
384</TR>
385<TR BGCOLOR="white" CLASS="TableRowColor">
386<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
387<CODE>&nbsp;void</CODE></FONT></TD>
388<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setLocalPath(org.apache.tools.ant.types.Path)">setLocalPath</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;path)</CODE>
389
390<BR>
391&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Override the working directory and get to the specified path.</TD>
392</TR>
393<TR BGCOLOR="white" CLASS="TableRowColor">
394<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
395<CODE>&nbsp;void</CODE></FONT></TD>
396<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setNoCache(boolean)">setNoCache</A></B>(boolean&nbsp;nocache)</CODE>
397
398<BR>
399&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flag to disable the cache when set.</TD>
400</TR>
401<TR BGCOLOR="white" CLASS="TableRowColor">
402<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
403<CODE>&nbsp;void</CODE></FONT></TD>
404<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setNoCompress(boolean)">setNoCompress</A></B>(boolean&nbsp;nocompress)</CODE>
405
406<BR>
407&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flag to disable compression when set.</TD>
408</TR>
409<TR BGCOLOR="white" CLASS="TableRowColor">
410<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
411<CODE>&nbsp;void</CODE></FONT></TD>
412<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setPassword(java.lang.String)">setPassword</A></B>(java.lang.String&nbsp;password)</CODE>
413
414<BR>
415&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The SourceSafe password.</TD>
416</TR>
417<TR BGCOLOR="white" CLASS="TableRowColor">
418<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
419<CODE>&nbsp;void</CODE></FONT></TD>
420<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setProjectPath(java.lang.String)">setProjectPath</A></B>(java.lang.String&nbsp;projectpath)</CODE>
421
422<BR>
423&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The SourceSafe project path.</TD>
424</TR>
425<TR BGCOLOR="white" CLASS="TableRowColor">
426<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
427<CODE>&nbsp;void</CODE></FONT></TD>
428<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setSosCmd(java.lang.String)">setSosCmd</A></B>(java.lang.String&nbsp;dir)</CODE>
429
430<BR>
431&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The directory where soscmd(.exe) is located.</TD>
432</TR>
433<TR BGCOLOR="white" CLASS="TableRowColor">
434<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
435<CODE>&nbsp;void</CODE></FONT></TD>
436<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setSosHome(java.lang.String)">setSosHome</A></B>(java.lang.String&nbsp;sosHome)</CODE>
437
438<BR>
439&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Path to the SourceOffSite home directory.</TD>
440</TR>
441<TR BGCOLOR="white" CLASS="TableRowColor">
442<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
443<CODE>&nbsp;void</CODE></FONT></TD>
444<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setSosServerPath(java.lang.String)">setSosServerPath</A></B>(java.lang.String&nbsp;sosServerPath)</CODE>
445
446<BR>
447&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The address and port of SourceOffSite Server,
448 for example 192.168.0.1:8888.</TD>
449</TR>
450<TR BGCOLOR="white" CLASS="TableRowColor">
451<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
452<CODE>&nbsp;void</CODE></FONT></TD>
453<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setUsername(java.lang.String)">setUsername</A></B>(java.lang.String&nbsp;username)</CODE>
454
455<BR>
456&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The SourceSafe username.</TD>
457</TR>
458<TR BGCOLOR="white" CLASS="TableRowColor">
459<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
460<CODE>&nbsp;void</CODE></FONT></TD>
461<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setVerbose(boolean)">setVerbose</A></B>(boolean&nbsp;verbose)</CODE>
462
463<BR>
464&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Enable verbose output.</TD>
465</TR>
466<TR BGCOLOR="white" CLASS="TableRowColor">
467<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
468<CODE>&nbsp;void</CODE></FONT></TD>
469<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOS.html#setVssServerPath(java.lang.String)">setVssServerPath</A></B>(java.lang.String&nbsp;vssServerPath)</CODE>
470
471<BR>
472&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The path to the location of the ss.ini file.</TD>
473</TR>
474</TABLE>
475&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
476<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
477<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
478<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
479</TR>
480<TR BGCOLOR="white" CLASS="TableRowColor">
481<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#getDescription()">getDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getLocation()">getLocation</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#init()">init</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#perform()">perform</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setLocation(org.apache.tools.ant.Location)">setLocation</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</A></CODE></TD>
482</TR>
483</TABLE>
484&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
485<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
486<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
487<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
488</TR>
489<TR BGCOLOR="white" CLASS="TableRowColor">
490<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
491</TR>
492</TABLE>
493&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
494<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
495<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
496<TD><B>Methods inherited from class java.lang.Object</B></TD>
497</TR>
498<TR BGCOLOR="white" CLASS="TableRowColor">
499<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
500</TR>
501</TABLE>
502&nbsp;
503<P>
504
505<!-- ============ FIELD DETAIL =========== -->
506
507<A NAME="field_detail"><!-- --></A>
508<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
509<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
510<TD COLSPAN=1><FONT SIZE="+2">
511<B>Field Detail</B></FONT></TD>
512</TR>
513</TABLE>
514
515<A NAME="commandLine"><!-- --></A><H3>
516commandLine</H3>
517<PRE>
518protected <A HREF="../../../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A> <B>commandLine</B></PRE>
519<DL>
520<DD>Commandline to be executed
521<P>
522<DL>
523</DL>
524</DL>
525
526<!-- ========= CONSTRUCTOR DETAIL ======== -->
527
528<A NAME="constructor_detail"><!-- --></A>
529<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
530<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
531<TD COLSPAN=1><FONT SIZE="+2">
532<B>Constructor Detail</B></FONT></TD>
533</TR>
534</TABLE>
535
536<A NAME="SOS()"><!-- --></A><H3>
537SOS</H3>
538<PRE>
539public <B>SOS</B>()</PRE>
540<DL>
541</DL>
542
543<!-- ============ METHOD DETAIL ========== -->
544
545<A NAME="method_detail"><!-- --></A>
546<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
547<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
548<TD COLSPAN=1><FONT SIZE="+2">
549<B>Method Detail</B></FONT></TD>
550</TR>
551</TABLE>
552
553<A NAME="setNoCache(boolean)"><!-- --></A><H3>
554setNoCache</H3>
555<PRE>
556public final void <B>setNoCache</B>(boolean&nbsp;nocache)</PRE>
557<DL>
558<DD>Flag to disable the cache when set.
559 Required if SOSHOME is set as an environment variable.
560 Defaults to false.
561<P>
562<DD><DL>
563</DL>
564</DD>
565<DD><DL>
566<DT><B>Parameters:</B><DD><CODE>nocache</CODE> - True to disable caching.</DL>
567</DD>
568</DL>
569<HR>
570
571<A NAME="setNoCompress(boolean)"><!-- --></A><H3>
572setNoCompress</H3>
573<PRE>
574public final void <B>setNoCompress</B>(boolean&nbsp;nocompress)</PRE>
575<DL>
576<DD>Flag to disable compression when set. Defaults to false.
577<P>
578<DD><DL>
579</DL>
580</DD>
581<DD><DL>
582<DT><B>Parameters:</B><DD><CODE>nocompress</CODE> - True to disable compression.</DL>
583</DD>
584</DL>
585<HR>
586
587<A NAME="setSosCmd(java.lang.String)"><!-- --></A><H3>
588setSosCmd</H3>
589<PRE>
590public final void <B>setSosCmd</B>(java.lang.String&nbsp;dir)</PRE>
591<DL>
592<DD>The directory where soscmd(.exe) is located.
593 soscmd must be on the path if omitted.
594<P>
595<DD><DL>
596</DL>
597</DD>
598<DD><DL>
599<DT><B>Parameters:</B><DD><CODE>dir</CODE> - The new sosCmd value</DL>
600</DD>
601</DL>
602<HR>
603
604<A NAME="setUsername(java.lang.String)"><!-- --></A><H3>
605setUsername</H3>
606<PRE>
607public final void <B>setUsername</B>(java.lang.String&nbsp;username)</PRE>
608<DL>
609<DD>The SourceSafe username.
610<P>
611<DD><DL>
612</DL>
613</DD>
614<DD><DL>
615<DT><B>Parameters:</B><DD><CODE>username</CODE> - The new username value</DL>
616</DD>
617</DL>
618<HR>
619
620<A NAME="setPassword(java.lang.String)"><!-- --></A><H3>
621setPassword</H3>
622<PRE>
623public final void <B>setPassword</B>(java.lang.String&nbsp;password)</PRE>
624<DL>
625<DD>The SourceSafe password.
626<P>
627<DD><DL>
628</DL>
629</DD>
630<DD><DL>
631<DT><B>Parameters:</B><DD><CODE>password</CODE> - The new password value</DL>
632</DD>
633</DL>
634<HR>
635
636<A NAME="setProjectPath(java.lang.String)"><!-- --></A><H3>
637setProjectPath</H3>
638<PRE>
639public final void <B>setProjectPath</B>(java.lang.String&nbsp;projectpath)</PRE>
640<DL>
641<DD>The SourceSafe project path.
642<P>
643<DD><DL>
644</DL>
645</DD>
646<DD><DL>
647<DT><B>Parameters:</B><DD><CODE>projectpath</CODE> - The new projectpath value</DL>
648</DD>
649</DL>
650<HR>
651
652<A NAME="setVssServerPath(java.lang.String)"><!-- --></A><H3>
653setVssServerPath</H3>
654<PRE>
655public final void <B>setVssServerPath</B>(java.lang.String&nbsp;vssServerPath)</PRE>
656<DL>
657<DD>The path to the location of the ss.ini file.
658<P>
659<DD><DL>
660</DL>
661</DD>
662<DD><DL>
663<DT><B>Parameters:</B><DD><CODE>vssServerPath</CODE> - The new vssServerPath value</DL>
664</DD>
665</DL>
666<HR>
667
668<A NAME="setSosHome(java.lang.String)"><!-- --></A><H3>
669setSosHome</H3>
670<PRE>
671public final void <B>setSosHome</B>(java.lang.String&nbsp;sosHome)</PRE>
672<DL>
673<DD>Path to the SourceOffSite home directory.
674<P>
675<DD><DL>
676</DL>
677</DD>
678<DD><DL>
679<DT><B>Parameters:</B><DD><CODE>sosHome</CODE> - The new sosHome value</DL>
680</DD>
681</DL>
682<HR>
683
684<A NAME="setSosServerPath(java.lang.String)"><!-- --></A><H3>
685setSosServerPath</H3>
686<PRE>
687public final void <B>setSosServerPath</B>(java.lang.String&nbsp;sosServerPath)</PRE>
688<DL>
689<DD>The address and port of SourceOffSite Server,
690 for example 192.168.0.1:8888.
691<P>
692<DD><DL>
693</DL>
694</DD>
695<DD><DL>
696<DT><B>Parameters:</B><DD><CODE>sosServerPath</CODE> - The new sosServerPath value</DL>
697</DD>
698</DL>
699<HR>
700
701<A NAME="setLocalPath(org.apache.tools.ant.types.Path)"><!-- --></A><H3>
702setLocalPath</H3>
703<PRE>
704public final void <B>setLocalPath</B>(<A HREF="../../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;path)</PRE>
705<DL>
706<DD>Override the working directory and get to the specified path.
707<P>
708<DD><DL>
709</DL>
710</DD>
711<DD><DL>
712<DT><B>Parameters:</B><DD><CODE>path</CODE> - The new localPath value</DL>
713</DD>
714</DL>
715<HR>
716
717<A NAME="setVerbose(boolean)"><!-- --></A><H3>
718setVerbose</H3>
719<PRE>
720public void <B>setVerbose</B>(boolean&nbsp;verbose)</PRE>
721<DL>
722<DD>Enable verbose output. Defaults to false.
723<P>
724<DD><DL>
725</DL>
726</DD>
727<DD><DL>
728<DT><B>Parameters:</B><DD><CODE>verbose</CODE> - True for verbose output.</DL>
729</DD>
730</DL>
731<HR>
732
733<A NAME="setInternalFilename(java.lang.String)"><!-- --></A><H3>
734setInternalFilename</H3>
735<PRE>
736protected void <B>setInternalFilename</B>(java.lang.String&nbsp;file)</PRE>
737<DL>
738<DD><DL>
739</DL>
740</DD>
741<DD><DL>
742</DL>
743</DD>
744</DL>
745<HR>
746
747<A NAME="setInternalRecursive(boolean)"><!-- --></A><H3>
748setInternalRecursive</H3>
749<PRE>
750protected void <B>setInternalRecursive</B>(boolean&nbsp;recurse)</PRE>
751<DL>
752<DD><DL>
753</DL>
754</DD>
755<DD><DL>
756</DL>
757</DD>
758</DL>
759<HR>
760
761<A NAME="setInternalComment(java.lang.String)"><!-- --></A><H3>
762setInternalComment</H3>
763<PRE>
764protected void <B>setInternalComment</B>(java.lang.String&nbsp;text)</PRE>
765<DL>
766<DD><DL>
767</DL>
768</DD>
769<DD><DL>
770</DL>
771</DD>
772</DL>
773<HR>
774
775<A NAME="setInternalLabel(java.lang.String)"><!-- --></A><H3>
776setInternalLabel</H3>
777<PRE>
778protected void <B>setInternalLabel</B>(java.lang.String&nbsp;text)</PRE>
779<DL>
780<DD><DL>
781</DL>
782</DD>
783<DD><DL>
784</DL>
785</DD>
786</DL>
787<HR>
788
789<A NAME="setInternalVersion(java.lang.String)"><!-- --></A><H3>
790setInternalVersion</H3>
791<PRE>
792protected void <B>setInternalVersion</B>(java.lang.String&nbsp;text)</PRE>
793<DL>
794<DD><DL>
795</DL>
796</DD>
797<DD><DL>
798</DL>
799</DD>
800</DL>
801<HR>
802
803<A NAME="getSosCommand()"><!-- --></A><H3>
804getSosCommand</H3>
805<PRE>
806protected java.lang.String <B>getSosCommand</B>()</PRE>
807<DL>
808<DD>Get the executable to run. Add the path if it was specifed in the build file
809<P>
810<DD><DL>
811</DL>
812</DD>
813<DD><DL>
814
815<DT><B>Returns:</B><DD>the executable to run</DL>
816</DD>
817</DL>
818<HR>
819
820<A NAME="getComment()"><!-- --></A><H3>
821getComment</H3>
822<PRE>
823protected java.lang.String <B>getComment</B>()</PRE>
824<DL>
825<DD>Get the comment
826<P>
827<DD><DL>
828</DL>
829</DD>
830<DD><DL>
831
832<DT><B>Returns:</B><DD>if it was set, null if not</DL>
833</DD>
834</DL>
835<HR>
836
837<A NAME="getVersion()"><!-- --></A><H3>
838getVersion</H3>
839<PRE>
840protected java.lang.String <B>getVersion</B>()</PRE>
841<DL>
842<DD>Get the version
843<P>
844<DD><DL>
845</DL>
846</DD>
847<DD><DL>
848
849<DT><B>Returns:</B><DD>if it was set, null if not</DL>
850</DD>
851</DL>
852<HR>
853
854<A NAME="getLabel()"><!-- --></A><H3>
855getLabel</H3>
856<PRE>
857protected java.lang.String <B>getLabel</B>()</PRE>
858<DL>
859<DD>Get the label
860<P>
861<DD><DL>
862</DL>
863</DD>
864<DD><DL>
865
866<DT><B>Returns:</B><DD>if it was set, null if not</DL>
867</DD>
868</DL>
869<HR>
870
871<A NAME="getUsername()"><!-- --></A><H3>
872getUsername</H3>
873<PRE>
874protected java.lang.String <B>getUsername</B>()</PRE>
875<DL>
876<DD>Get the username
877<P>
878<DD><DL>
879</DL>
880</DD>
881<DD><DL>
882
883<DT><B>Returns:</B><DD>if it was set, null if not</DL>
884</DD>
885</DL>
886<HR>
887
888<A NAME="getPassword()"><!-- --></A><H3>
889getPassword</H3>
890<PRE>
891protected java.lang.String <B>getPassword</B>()</PRE>
892<DL>
893<DD>Get the password
894<P>
895<DD><DL>
896</DL>
897</DD>
898<DD><DL>
899
900<DT><B>Returns:</B><DD>empty string if it wans't set</DL>
901</DD>
902</DL>
903<HR>
904
905<A NAME="getProjectPath()"><!-- --></A><H3>
906getProjectPath</H3>
907<PRE>
908protected java.lang.String <B>getProjectPath</B>()</PRE>
909<DL>
910<DD>Get the project path
911<P>
912<DD><DL>
913</DL>
914</DD>
915<DD><DL>
916
917<DT><B>Returns:</B><DD>if it was set, null if not</DL>
918</DD>
919</DL>
920<HR>
921
922<A NAME="getVssServerPath()"><!-- --></A><H3>
923getVssServerPath</H3>
924<PRE>
925protected java.lang.String <B>getVssServerPath</B>()</PRE>
926<DL>
927<DD>Get the VSS server path
928<P>
929<DD><DL>
930</DL>
931</DD>
932<DD><DL>
933
934<DT><B>Returns:</B><DD>if it was set, null if not</DL>
935</DD>
936</DL>
937<HR>
938
939<A NAME="getSosHome()"><!-- --></A><H3>
940getSosHome</H3>
941<PRE>
942protected java.lang.String <B>getSosHome</B>()</PRE>
943<DL>
944<DD>Get the SOS home directory
945<P>
946<DD><DL>
947</DL>
948</DD>
949<DD><DL>
950
951<DT><B>Returns:</B><DD>if it was set, null if not</DL>
952</DD>
953</DL>
954<HR>
955
956<A NAME="getSosServerPath()"><!-- --></A><H3>
957getSosServerPath</H3>
958<PRE>
959protected java.lang.String <B>getSosServerPath</B>()</PRE>
960<DL>
961<DD>Get the SOS serve path
962<P>
963<DD><DL>
964</DL>
965</DD>
966<DD><DL>
967
968<DT><B>Returns:</B><DD>if it was set, null if not</DL>
969</DD>
970</DL>
971<HR>
972
973<A NAME="getFilename()"><!-- --></A><H3>
974getFilename</H3>
975<PRE>
976protected java.lang.String <B>getFilename</B>()</PRE>
977<DL>
978<DD>Get the filename to be acted upon
979<P>
980<DD><DL>
981</DL>
982</DD>
983<DD><DL>
984
985<DT><B>Returns:</B><DD>if it was set, null if not</DL>
986</DD>
987</DL>
988<HR>
989
990<A NAME="getNoCompress()"><!-- --></A><H3>
991getNoCompress</H3>
992<PRE>
993protected java.lang.String <B>getNoCompress</B>()</PRE>
994<DL>
995<DD>Get the NoCompress flag
996<P>
997<DD><DL>
998</DL>
999</DD>
1000<DD><DL>
1001
1002<DT><B>Returns:</B><DD>the 'nocompress' Flag if the attribute was 'true',
1003 otherwise an empty string</DL>
1004</DD>
1005</DL>
1006<HR>
1007
1008<A NAME="getNoCache()"><!-- --></A><H3>
1009getNoCache</H3>
1010<PRE>
1011protected java.lang.String <B>getNoCache</B>()</PRE>
1012<DL>
1013<DD>Get the NoCache flag
1014<P>
1015<DD><DL>
1016</DL>
1017</DD>
1018<DD><DL>
1019
1020<DT><B>Returns:</B><DD>the 'nocache' Flag if the attribute was 'true', otherwise an empty string</DL>
1021</DD>
1022</DL>
1023<HR>
1024
1025<A NAME="getVerbose()"><!-- --></A><H3>
1026getVerbose</H3>
1027<PRE>
1028protected java.lang.String <B>getVerbose</B>()</PRE>
1029<DL>
1030<DD>Get the 'verbose' Flag
1031<P>
1032<DD><DL>
1033</DL>
1034</DD>
1035<DD><DL>
1036
1037<DT><B>Returns:</B><DD>the 'verbose' Flag if the attribute was 'true', otherwise an empty string</DL>
1038</DD>
1039</DL>
1040<HR>
1041
1042<A NAME="getRecursive()"><!-- --></A><H3>
1043getRecursive</H3>
1044<PRE>
1045protected java.lang.String <B>getRecursive</B>()</PRE>
1046<DL>
1047<DD>Get the 'recursive' Flag
1048<P>
1049<DD><DL>
1050</DL>
1051</DD>
1052<DD><DL>
1053
1054<DT><B>Returns:</B><DD>the 'recursive' Flag if the attribute was 'true', otherwise an empty string</DL>
1055</DD>
1056</DL>
1057<HR>
1058
1059<A NAME="getLocalPath()"><!-- --></A><H3>
1060getLocalPath</H3>
1061<PRE>
1062protected java.lang.String <B>getLocalPath</B>()</PRE>
1063<DL>
1064<DD>Builds and returns the working directory.
1065 <p>
1066 The localpath is created if it didn't exist
1067<P>
1068<DD><DL>
1069</DL>
1070</DD>
1071<DD><DL>
1072
1073<DT><B>Returns:</B><DD>the absolute path of the working directory</DL>
1074</DD>
1075</DL>
1076<HR>
1077
1078<A NAME="execute()"><!-- --></A><H3>
1079execute</H3>
1080<PRE>
1081public void <B>execute</B>()
1082 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1083<DL>
1084<DD>Execute the created command line.
1085<P>
1086<DD><DL>
1087<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#execute()">execute</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
1088</DD>
1089<DD><DL>
1090
1091<DT><B>Throws:</B>
1092<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
1093</DD>
1094</DL>
1095<HR>
1096
1097<A NAME="run(org.apache.tools.ant.types.Commandline)"><!-- --></A><H3>
1098run</H3>
1099<PRE>
1100protected int <B>run</B>(<A HREF="../../../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</A>&nbsp;cmd)</PRE>
1101<DL>
1102<DD>Execute the created command line.
1103<P>
1104<DD><DL>
1105</DL>
1106</DD>
1107<DD><DL>
1108<DT><B>Parameters:</B><DD><CODE>cmd</CODE> - The command line to run.
1109<DT><B>Returns:</B><DD>int the exit code.
1110<DT><B>Throws:</B>
1111<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
1112</DD>
1113</DL>
1114<HR>
1115
1116<A NAME="getRequiredAttributes()"><!-- --></A><H3>
1117getRequiredAttributes</H3>
1118<PRE>
1119protected void <B>getRequiredAttributes</B>()</PRE>
1120<DL>
1121<DD>Sets the executable and add the required attributes to the command line.
1122<P>
1123<DD><DL>
1124</DL>
1125</DD>
1126<DD><DL>
1127</DL>
1128</DD>
1129</DL>
1130<HR>
1131
1132<A NAME="getOptionalAttributes()"><!-- --></A><H3>
1133getOptionalAttributes</H3>
1134<PRE>
1135protected void <B>getOptionalAttributes</B>()</PRE>
1136<DL>
1137<DD>Adds the optional attributes to the command line.
1138<P>
1139<DD><DL>
1140</DL>
1141</DD>
1142<DD><DL>
1143</DL>
1144</DD>
1145</DL>
1146<!-- ========= END OF CLASS DATA ========= -->
1147<HR>
1148
1149
1150<!-- ======= START OF BOTTOM NAVBAR ====== -->
1151<A NAME="navbar_bottom"><!-- --></A>
1152<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1153<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1154<TR>
1155<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1156<A NAME="navbar_bottom_firstrow"><!-- --></A>
1157<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1158 <TR ALIGN="center" VALIGN="top">
1159 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
1160 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
1161 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1162 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
1163 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1164 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
1165 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1166 </TR>
1167</TABLE>
1168</TD>
1169<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1170</EM>
1171</TD>
1172</TR>
1173
1174<TR>
1175<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1176&nbsp;PREV CLASS&nbsp;
1177&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/sos/SOSCheckin.html" title="class in org.apache.tools.ant.taskdefs.optional.sos"><B>NEXT CLASS</B></A></FONT></TD>
1178<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1179 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
1180&nbsp;<A HREF="SOS.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
1181&nbsp;<SCRIPT type="text/javascript">
1182 <!--
1183 if(window==top) {
1184 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1185 }
1186 //-->
1187</SCRIPT>
1188<NOSCRIPT>
1189 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
1190</NOSCRIPT>
1191
1192</FONT></TD>
1193</TR>
1194<TR>
1195<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1196 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
1197<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1198DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
1199</TR>
1200</TABLE>
1201<A NAME="skip-navbar_bottom"></A>
1202<!-- ======== END OF BOTTOM NAVBAR ======= -->
1203
1204<HR>
1205Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
1206</BODY>
1207</HTML>
Note: See TracBrowser for help on using the repository browser.