]> git.ipfire.org Git - thirdparty/cups.git/blob - scripting/java/docs/com/easysw/cups/Cups.html
Add missing files for test.
[thirdparty/cups.git] / scripting / java / docs / com / easysw / cups / Cups.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc on Tue Feb 11 14:29:07 PST 2003 -->
6 <TITLE>
7 : Class Cups
8 </TITLE>
9 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
10 </HEAD>
11 <BODY BGCOLOR="white">
12
13 <!-- ========== START OF NAVBAR ========== -->
14 <A NAME="navbar_top"><!-- --></A>
15 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
16 <TR>
17 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
18 <A NAME="navbar_top_firstrow"><!-- --></A>
19 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
20 <TR ALIGN="center" VALIGN="top">
21 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
22 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
23 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
24 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
25 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
26 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
27 </TR>
28 </TABLE>
29 </TD>
30 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
31 </EM>
32 </TD>
33 </TR>
34
35 <TR>
36 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
37 &nbsp;PREV CLASS&nbsp;
38 &nbsp;<A HREF="../../../com/easysw/cups/CupsJob.html"><B>NEXT CLASS</B></A></FONT></TD>
39 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
40 <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A> &nbsp;
41 &nbsp;<A HREF="Cups.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
42 </TR>
43 <TR>
44 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
45 SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
46 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
47 DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
48 </TR>
49 </TABLE>
50 <!-- =========== END OF NAVBAR =========== -->
51
52 <HR>
53 <!-- ======== START OF CLASS DATA ======== -->
54 <H2>
55 <FONT SIZE="-1">
56 com.easysw.cups</FONT>
57 <BR>
58 Class Cups</H2>
59 <PRE>
60 java.lang.Object
61 |
62 +--<B>com.easysw.cups.Cups</B>
63 </PRE>
64 <HR>
65 <DL>
66 <DT>public class <B>Cups</B><DT>extends java.lang.Object</DL>
67
68 <P>
69 <HR>
70
71 <P>
72 <!-- ======== INNER CLASS SUMMARY ======== -->
73
74
75 <!-- =========== FIELD SUMMARY =========== -->
76
77
78 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
79
80 <A NAME="constructor_summary"><!-- --></A>
81 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
82 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
83 <TD COLSPAN=2><FONT SIZE="+2">
84 <B>Constructor Summary</B></FONT></TD>
85 </TR>
86 <TR BGCOLOR="white" CLASS="TableRowColor">
87 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#Cups()">Cups</A></B>()</CODE>
88
89 <BR>
90 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Void constructor.</TD>
91 </TR>
92 <TR BGCOLOR="white" CLASS="TableRowColor">
93 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#Cups(java.net.URL)">Cups</A></B>(java.net.URL&nbsp;p_url)</CODE>
94
95 <BR>
96 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor using a <code>URL</code>.</TD>
97 </TR>
98 </TABLE>
99 &nbsp;
100 <!-- ========== METHOD SUMMARY =========== -->
101
102 <A NAME="method_summary"><!-- --></A>
103 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
104 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
105 <TD COLSPAN=2><FONT SIZE="+2">
106 <B>Method Summary</B></FONT></TD>
107 </TR>
108 <TR BGCOLOR="white" CLASS="TableRowColor">
109 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
110 <CODE>&nbsp;int</CODE></FONT></TD>
111 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#cupsCancelJob(java.lang.String, int, java.lang.String)">cupsCancelJob</A></B>(java.lang.String&nbsp;printer_name,
112 int&nbsp;p_job_id,
113 java.lang.String&nbsp;p_user_name)</CODE>
114
115 <BR>
116 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Cancel a job - send a job cancel request to the server.</TD>
117 </TR>
118 <TR BGCOLOR="white" CLASS="TableRowColor">
119 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
120 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
121 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#cupsGetDefault()">cupsGetDefault</A></B>()</CODE>
122
123 <BR>
124 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get default destination.</TD>
125 </TR>
126 <TR BGCOLOR="white" CLASS="TableRowColor">
127 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
128 <CODE>&nbsp;<A HREF="../../../com/easysw/cups/CupsJob.html">CupsJob</A>[]</CODE></FONT></TD>
129 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#cupsGetJobs(boolean, boolean)">cupsGetJobs</A></B>(boolean&nbsp;showMyJobs,
130 boolean&nbsp;showCompleted)</CODE>
131
132 <BR>
133 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a list of jobs.</TD>
134 </TR>
135 <TR BGCOLOR="white" CLASS="TableRowColor">
136 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137 <CODE>&nbsp;java.util.List</CODE></FONT></TD>
138 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#cupsGetPrinterAttributes(java.lang.String)">cupsGetPrinterAttributes</A></B>(java.lang.String&nbsp;printer_name)</CODE>
139
140 <BR>
141 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get printer attributes</TD>
142 </TR>
143 <TR BGCOLOR="white" CLASS="TableRowColor">
144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145 <CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>
146 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#cupsGetPrinters()">cupsGetPrinters</A></B>()</CODE>
147
148 <BR>
149 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a list of printers.</TD>
150 </TR>
151 <TR BGCOLOR="white" CLASS="TableRowColor">
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153 <CODE>&nbsp;java.util.List</CODE></FONT></TD>
154 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#cupsGetPrinterStatus(java.lang.String)">cupsGetPrinterStatus</A></B>(java.lang.String&nbsp;printer_name)</CODE>
155
156 <BR>
157 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
158 </TR>
159 <TR BGCOLOR="white" CLASS="TableRowColor">
160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161 <CODE>&nbsp;<A HREF="../../../com/easysw/cups/CupsJob.html">CupsJob</A></CODE></FONT></TD>
162 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#cupsPrintFile(java.lang.String, com.easysw.cups.IPPAttribute[])">cupsPrintFile</A></B>(java.lang.String&nbsp;p_filename,
163 <A HREF="../../../com/easysw/cups/IPPAttribute.html">IPPAttribute</A>[]&nbsp;p_attrs)</CODE>
164
165 <BR>
166 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Print a file.</TD>
167 </TR>
168 <TR BGCOLOR="white" CLASS="TableRowColor">
169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170 <CODE>&nbsp;boolean</CODE></FONT></TD>
171 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#doRequest()">doRequest</A></B>()</CODE>
172
173 <BR>
174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Do a CUPS request to the server.</TD>
175 </TR>
176 <TR BGCOLOR="white" CLASS="TableRowColor">
177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
178 <CODE>&nbsp;boolean</CODE></FONT></TD>
179 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#doRequest(java.io.File)">doRequest</A></B>(java.io.File&nbsp;file)</CODE>
180
181 <BR>
182 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Send a FILE to the CUPS server.</TD>
183 </TR>
184 <TR BGCOLOR="white" CLASS="TableRowColor">
185 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186 <CODE>&nbsp;boolean</CODE></FONT></TD>
187 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#doRequest(java.lang.String)">doRequest</A></B>(java.lang.String&nbsp;from)</CODE>
188
189 <BR>
190 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
191 </TR>
192 <TR BGCOLOR="white" CLASS="TableRowColor">
193 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194 <CODE>&nbsp;boolean</CODE></FONT></TD>
195 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#getEncrypt()">getEncrypt</A></B>()</CODE>
196
197 <BR>
198 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the value of the <code>encrypt</code> member.</TD>
199 </TR>
200 <TR BGCOLOR="white" CLASS="TableRowColor">
201 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202 <CODE>&nbsp;void</CODE></FONT></TD>
203 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#setDest(java.lang.String)">setDest</A></B>(java.lang.String&nbsp;p_dest)</CODE>
204
205 <BR>
206 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value of the <code>dest</code> member.</TD>
207 </TR>
208 <TR BGCOLOR="white" CLASS="TableRowColor">
209 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
210 <CODE>&nbsp;void</CODE></FONT></TD>
211 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#setEncrypt(boolean)">setEncrypt</A></B>(boolean&nbsp;p_encrypt)</CODE>
212
213 <BR>
214 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value of the <code>encrypt</code> member.</TD>
215 </TR>
216 <TR BGCOLOR="white" CLASS="TableRowColor">
217 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
218 <CODE>&nbsp;void</CODE></FONT></TD>
219 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#setInstance(java.lang.String)">setInstance</A></B>(java.lang.String&nbsp;p_instance)</CODE>
220
221 <BR>
222 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value of the <code>instance</code> member.</TD>
223 </TR>
224 <TR BGCOLOR="white" CLASS="TableRowColor">
225 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
226 <CODE>&nbsp;void</CODE></FONT></TD>
227 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#setPasswd(java.lang.String)">setPasswd</A></B>(java.lang.String&nbsp;p_passwd)</CODE>
228
229 <BR>
230 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value of the <code>passwd</code> member.</TD>
231 </TR>
232 <TR BGCOLOR="white" CLASS="TableRowColor">
233 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
234 <CODE>&nbsp;void</CODE></FONT></TD>
235 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#setPath(java.lang.String)">setPath</A></B>(java.lang.String&nbsp;p_path)</CODE>
236
237 <BR>
238 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value of the <code>path</code> member.</TD>
239 </TR>
240 <TR BGCOLOR="white" CLASS="TableRowColor">
241 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
242 <CODE>&nbsp;void</CODE></FONT></TD>
243 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#setPort(int)">setPort</A></B>(int&nbsp;p_port)</CODE>
244
245 <BR>
246 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value of the <code>port</code> member.</TD>
247 </TR>
248 <TR BGCOLOR="white" CLASS="TableRowColor">
249 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
250 <CODE>&nbsp;void</CODE></FONT></TD>
251 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#setProtocol(java.lang.String)">setProtocol</A></B>(java.lang.String&nbsp;p_protocol)</CODE>
252
253 <BR>
254 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value of the <code>protocol</code> member.</TD>
255 </TR>
256 <TR BGCOLOR="white" CLASS="TableRowColor">
257 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
258 <CODE>&nbsp;void</CODE></FONT></TD>
259 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#setServer(java.lang.String)">setServer</A></B>(java.lang.String&nbsp;p_server)</CODE>
260
261 <BR>
262 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value of the <code>server</code> member.</TD>
263 </TR>
264 <TR BGCOLOR="white" CLASS="TableRowColor">
265 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
266 <CODE>&nbsp;void</CODE></FONT></TD>
267 <TD><CODE><B><A HREF="../../../com/easysw/cups/Cups.html#setUser(java.lang.String)">setUser</A></B>(java.lang.String&nbsp;p_user)</CODE>
268
269 <BR>
270 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the value of the <code>user</code> member.</TD>
271 </TR>
272 </TABLE>
273 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
274 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
275 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
276 <TD><B>Methods inherited from class java.lang.Object</B></TD>
277 </TR>
278 <TR BGCOLOR="white" CLASS="TableRowColor">
279 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
280 </TR>
281 </TABLE>
282 &nbsp;
283 <P>
284
285 <!-- ============ FIELD DETAIL =========== -->
286
287
288 <!-- ========= CONSTRUCTOR DETAIL ======== -->
289
290 <A NAME="constructor_detail"><!-- --></A>
291 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
292 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
293 <TD COLSPAN=1><FONT SIZE="+2">
294 <B>Constructor Detail</B></FONT></TD>
295 </TR>
296 </TABLE>
297
298 <A NAME="Cups()"><!-- --></A><H3>
299 Cups</H3>
300 <PRE>
301 public <B>Cups</B>()</PRE>
302 <DL>
303 <DD>Void constructor.</DL>
304 <HR>
305
306 <A NAME="Cups(java.net.URL)"><!-- --></A><H3>
307 Cups</H3>
308 <PRE>
309 public <B>Cups</B>(java.net.URL&nbsp;p_url)</PRE>
310 <DL>
311 <DD>Constructor using a <code>URL</code>.<DD><DL>
312 <DT><B>Parameters:</B><DD><CODE><code>p_url</code></CODE> - A <code>URL</code> object.</DL>
313 </DD>
314 </DL>
315
316 <!-- ============ METHOD DETAIL ========== -->
317
318 <A NAME="method_detail"><!-- --></A>
319 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
320 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
321 <TD COLSPAN=1><FONT SIZE="+2">
322 <B>Method Detail</B></FONT></TD>
323 </TR>
324 </TABLE>
325
326 <A NAME="setProtocol(java.lang.String)"><!-- --></A><H3>
327 setProtocol</H3>
328 <PRE>
329 public void <B>setProtocol</B>(java.lang.String&nbsp;p_protocol)</PRE>
330 <DL>
331 <DD>Set the value of the <code>protocol</code> member. Valid values
332 are ipp or http.<DD><DL>
333 <DT><B>Parameters:</B><DD><CODE><code>p_protocol</code></CODE> - String with protocol.</DL>
334 </DD>
335 </DL>
336 <HR>
337
338 <A NAME="setServer(java.lang.String)"><!-- --></A><H3>
339 setServer</H3>
340 <PRE>
341 public void <B>setServer</B>(java.lang.String&nbsp;p_server)</PRE>
342 <DL>
343 <DD>Set the value of the <code>server</code> member. This is an
344 IP address or a hostname.<DD><DL>
345 <DT><B>Parameters:</B><DD><CODE><code>p_server</code></CODE> - IP address or hostname.</DL>
346 </DD>
347 </DL>
348 <HR>
349
350 <A NAME="setPort(int)"><!-- --></A><H3>
351 setPort</H3>
352 <PRE>
353 public void <B>setPort</B>(int&nbsp;p_port)</PRE>
354 <DL>
355 <DD>Set the value of the <code>port</code> member.<DD><DL>
356 <DT><B>Parameters:</B><DD><CODE><code>p_port</code></CODE> - Port number.</DL>
357 </DD>
358 </DL>
359 <HR>
360
361 <A NAME="setUser(java.lang.String)"><!-- --></A><H3>
362 setUser</H3>
363 <PRE>
364 public void <B>setUser</B>(java.lang.String&nbsp;p_user)</PRE>
365 <DL>
366 <DD>Set the value of the <code>user</code> member.<DD><DL>
367 <DT><B>Parameters:</B><DD><CODE><code>p_user</code></CODE> - User name.</DL>
368 </DD>
369 </DL>
370 <HR>
371
372 <A NAME="setPasswd(java.lang.String)"><!-- --></A><H3>
373 setPasswd</H3>
374 <PRE>
375 public void <B>setPasswd</B>(java.lang.String&nbsp;p_passwd)</PRE>
376 <DL>
377 <DD>Set the value of the <code>passwd</code> member.<DD><DL>
378 <DT><B>Parameters:</B><DD><CODE><code>p_passwd</code></CODE> - Password.</DL>
379 </DD>
380 </DL>
381 <HR>
382
383 <A NAME="setDest(java.lang.String)"><!-- --></A><H3>
384 setDest</H3>
385 <PRE>
386 public void <B>setDest</B>(java.lang.String&nbsp;p_dest)</PRE>
387 <DL>
388 <DD>Set the value of the <code>dest</code> member.<DD><DL>
389 <DT><B>Parameters:</B><DD><CODE><code>p_dest</code></CODE> - Destination.</DL>
390 </DD>
391 </DL>
392 <HR>
393
394 <A NAME="setInstance(java.lang.String)"><!-- --></A><H3>
395 setInstance</H3>
396 <PRE>
397 public void <B>setInstance</B>(java.lang.String&nbsp;p_instance)</PRE>
398 <DL>
399 <DD>Set the value of the <code>instance</code> member.<DD><DL>
400 <DT><B>Parameters:</B><DD><CODE><code>p_instance</code></CODE> - Instance.</DL>
401 </DD>
402 </DL>
403 <HR>
404
405 <A NAME="setEncrypt(boolean)"><!-- --></A><H3>
406 setEncrypt</H3>
407 <PRE>
408 public void <B>setEncrypt</B>(boolean&nbsp;p_encrypt)</PRE>
409 <DL>
410 <DD>Set the value of the <code>encrypt</code> member.<DD><DL>
411 <DT><B>Parameters:</B><DD><CODE><code>p_enrypt</code></CODE> - Yes or no.</DL>
412 </DD>
413 </DL>
414 <HR>
415
416 <A NAME="getEncrypt()"><!-- --></A><H3>
417 getEncrypt</H3>
418 <PRE>
419 public boolean <B>getEncrypt</B>()</PRE>
420 <DL>
421 <DD>Get the value of the <code>encrypt</code> member.<DD><DL>
422 <DT><B>Returns:</B><DD><code>boolean</code> Encryption on or off.</DL>
423 </DD>
424 </DL>
425 <HR>
426
427 <A NAME="setPath(java.lang.String)"><!-- --></A><H3>
428 setPath</H3>
429 <PRE>
430 public void <B>setPath</B>(java.lang.String&nbsp;p_path)</PRE>
431 <DL>
432 <DD>Set the value of the <code>path</code> member. This is the
433 path that will be used in the POST method.<DD><DL>
434 <DT><B>Parameters:</B><DD><CODE><code>p_path</code></CODE> - Path on server.</DL>
435 </DD>
436 </DL>
437 <HR>
438
439 <A NAME="doRequest(java.lang.String)"><!-- --></A><H3>
440 doRequest</H3>
441 <PRE>
442 public boolean <B>doRequest</B>(java.lang.String&nbsp;from)
443 throws java.io.IOException</PRE>
444 <DL>
445 </DL>
446 <HR>
447
448 <A NAME="doRequest()"><!-- --></A><H3>
449 doRequest</H3>
450 <PRE>
451 public boolean <B>doRequest</B>()
452 throws java.io.IOException</PRE>
453 <DL>
454 <DD>Do a CUPS request to the server.<DD><DL>
455 <DT><B>Parameters:</B><DD><CODE><code>p_dest</code></CODE> - Destination name.<DT><B>Returns:</B><DD><code>boolean</code> True on success, false otherwise</DL>
456 </DD>
457 </DL>
458 <HR>
459
460 <A NAME="doRequest(java.io.File)"><!-- --></A><H3>
461 doRequest</H3>
462 <PRE>
463 public boolean <B>doRequest</B>(java.io.File&nbsp;file)
464 throws java.io.IOException</PRE>
465 <DL>
466 <DD>Send a FILE to the CUPS server.<DD><DL>
467 <DT><B>Parameters:</B><DD><CODE><code>file</code></CODE> - File to send.<DT><B>Returns:</B><DD><code>boolean</code> True on success, false otherwise</DL>
468 </DD>
469 </DL>
470 <HR>
471
472 <A NAME="cupsGetJobs(boolean, boolean)"><!-- --></A><H3>
473 cupsGetJobs</H3>
474 <PRE>
475 public <A HREF="../../../com/easysw/cups/CupsJob.html">CupsJob</A>[] <B>cupsGetJobs</B>(boolean&nbsp;showMyJobs,
476 boolean&nbsp;showCompleted)
477 throws java.io.IOException</PRE>
478 <DL>
479 <DD>Get a list of jobs.<DD><DL>
480 <DT><B>Parameters:</B><DD><CODE><code>showMyJobs</code></CODE> - Show only jobs for user.<DD><CODE><code>showCompleted</code></CODE> - Show completed OR active jobs.<DT><B>Returns:</B><DD><code>CupsJob[]</code> Array of job objects, or null.</DL>
481 </DD>
482 </DL>
483 <HR>
484
485 <A NAME="cupsGetPrinters()"><!-- --></A><H3>
486 cupsGetPrinters</H3>
487 <PRE>
488 public java.lang.String[] <B>cupsGetPrinters</B>()
489 throws java.io.IOException</PRE>
490 <DL>
491 <DD>Get a list of printers.<DD><DL>
492 <DT><B>Returns:</B><DD><code>String[]</code> Array of printers, or null.</DL>
493 </DD>
494 </DL>
495 <HR>
496
497 <A NAME="cupsGetDefault()"><!-- --></A><H3>
498 cupsGetDefault</H3>
499 <PRE>
500 public java.lang.String <B>cupsGetDefault</B>()
501 throws java.io.IOException</PRE>
502 <DL>
503 <DD>Get default destination.<DD><DL>
504 <DT><B>Returns:</B><DD><code>String</code> Name of default printer, or null.</DL>
505 </DD>
506 </DL>
507 <HR>
508
509 <A NAME="cupsGetPrinterAttributes(java.lang.String)"><!-- --></A><H3>
510 cupsGetPrinterAttributes</H3>
511 <PRE>
512 public java.util.List <B>cupsGetPrinterAttributes</B>(java.lang.String&nbsp;printer_name)
513 throws java.io.IOException</PRE>
514 <DL>
515 <DD>Get printer attributes<DD><DL>
516 <DT><B>Parameters:</B><DD><CODE><code>printer_name</code></CODE> - Name of printer to get info for.<DT><B>Returns:</B><DD><code>List</code> List of attributes.<DT><B>See Also: </B><DD><code>CupsPrinter</code></DL>
517 </DD>
518 </DL>
519 <HR>
520
521 <A NAME="cupsPrintFile(java.lang.String, com.easysw.cups.IPPAttribute[])"><!-- --></A><H3>
522 cupsPrintFile</H3>
523 <PRE>
524 public <A HREF="../../../com/easysw/cups/CupsJob.html">CupsJob</A> <B>cupsPrintFile</B>(java.lang.String&nbsp;p_filename,
525 <A HREF="../../../com/easysw/cups/IPPAttribute.html">IPPAttribute</A>[]&nbsp;p_attrs)
526 throws java.io.IOException</PRE>
527 <DL>
528 <DD>Print a file.<DD><DL>
529 <DT><B>Parameters:</B><DD><CODE><code>p_filename</code></CODE> - Path of file to print.<DD><CODE><code>p_attrs[]</code></CODE> - Array of print job attributes.<DT><B>Returns:</B><DD><code>CupsJob</code> Object with job info.<DT><B>See Also: </B><DD><code>CupsJob</code></DL>
530 </DD>
531 </DL>
532 <HR>
533
534 <A NAME="cupsCancelJob(java.lang.String, int, java.lang.String)"><!-- --></A><H3>
535 cupsCancelJob</H3>
536 <PRE>
537 public int <B>cupsCancelJob</B>(java.lang.String&nbsp;printer_name,
538 int&nbsp;p_job_id,
539 java.lang.String&nbsp;p_user_name)
540 throws java.io.IOException</PRE>
541 <DL>
542 <DD>Cancel a job - send a job cancel request to the server.<DD><DL>
543 <DT><B>Parameters:</B><DD><CODE><code>printer_name</code></CODE> - Destination.<DD><CODE><code>p_job_id</code></CODE> - ID of job.<DD><CODE><code>p_user_name</code></CODE> - Requesting user name.</DL>
544 </DD>
545 </DL>
546 <HR>
547
548 <A NAME="cupsGetPrinterStatus(java.lang.String)"><!-- --></A><H3>
549 cupsGetPrinterStatus</H3>
550 <PRE>
551 public java.util.List <B>cupsGetPrinterStatus</B>(java.lang.String&nbsp;printer_name)
552 throws java.io.IOException</PRE>
553 <DL>
554 </DL>
555 <!-- ========= END OF CLASS DATA ========= -->
556 <HR>
557
558 <!-- ========== START OF NAVBAR ========== -->
559 <A NAME="navbar_bottom"><!-- --></A>
560 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
561 <TR>
562 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
563 <A NAME="navbar_bottom_firstrow"><!-- --></A>
564 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
565 <TR ALIGN="center" VALIGN="top">
566 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
567 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
568 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
569 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
570 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
571 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
572 </TR>
573 </TABLE>
574 </TD>
575 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
576 </EM>
577 </TD>
578 </TR>
579
580 <TR>
581 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
582 &nbsp;PREV CLASS&nbsp;
583 &nbsp;<A HREF="../../../com/easysw/cups/CupsJob.html"><B>NEXT CLASS</B></A></FONT></TD>
584 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
585 <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A> &nbsp;
586 &nbsp;<A HREF="Cups.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
587 </TR>
588 <TR>
589 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
590 SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
591 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
592 DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
593 </TR>
594 </TABLE>
595 <!-- =========== END OF NAVBAR =========== -->
596
597 <HR>
598
599 </BODY>
600 </HTML>