1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5
<!-- Generated by javadoc (build 1.4.2_04) on Wed Apr 13 20:01:07 MEST 2005 -->
10
<META NAME="keywords" CONTENT="org.ggf.drmaa package">
12
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
14
<SCRIPT type="text/javascript">
15
function windowTitle()
17
parent.document.title="org.ggf.drmaa";
23
<BODY BGCOLOR="white" onload="windowTitle();">
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="">
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> </TD>
36
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
37
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
38
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
39
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
40
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
41
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
45
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52
<A HREF="../../../com/sun/grid/drmaa/package-summary.html"><B>PREV PACKAGE</B></A>
53
NEXT PACKAGE</FONT></TD>
54
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55
<A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
56
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
57
<SCRIPT type="text/javascript">
60
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
65
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
71
<A NAME="skip-navbar_top"></A>
72
<!-- ========= END OF TOP NAVBAR ========= -->
78
Provides an implementation of the Distributed Resource Management
79
Application API (DRMAA).
83
<A HREF="#package_description"><B>Description</B></A>
86
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
87
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
88
<TD COLSPAN=2><FONT SIZE="+2">
89
<B>Interface Summary</B></FONT></TD>
91
<TR BGCOLOR="white" CLASS="TableRowColor">
92
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/Session.html" title="interface in org.ggf.drmaa">Session</A></B></TD>
93
<TD>This interface represents a the operations available for interacting with the
101
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
102
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
103
<TD COLSPAN=2><FONT SIZE="+2">
104
<B>Class Summary</B></FONT></TD>
106
<TR BGCOLOR="white" CLASS="TableRowColor">
107
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/FileTransferMode.html" title="class in org.ggf.drmaa">FileTransferMode</A></B></TD>
108
<TD>This class represents the streams which should be used for file transfers.</TD>
110
<TR BGCOLOR="white" CLASS="TableRowColor">
111
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/JobInfo.html" title="class in org.ggf.drmaa">JobInfo</A></B></TD>
112
<TD>The class represents the status and usage information for a finished job.</TD>
114
<TR BGCOLOR="white" CLASS="TableRowColor">
115
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/JobTemplate.html" title="class in org.ggf.drmaa">JobTemplate</A></B></TD>
116
<TD>This class represents a template to be used for the creation of a job.</TD>
118
<TR BGCOLOR="white" CLASS="TableRowColor">
119
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/PartialTimestamp.html" title="class in org.ggf.drmaa">PartialTimestamp</A></B></TD>
120
<TD>The PartialTimestamp is a subclass of java.util.Calendar which allows for a
121
partially specified time that is resolved as the soonest matching time that is
122
in the future as the time of resolution.</TD>
124
<TR BGCOLOR="white" CLASS="TableRowColor">
125
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/PartialTimestampFormat.html" title="class in org.ggf.drmaa">PartialTimestampFormat</A></B></TD>
126
<TD>This class coverts a PartialTimestamp to and from the DRMAA specified time
129
<TR BGCOLOR="white" CLASS="TableRowColor">
130
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/SessionFactory.html" title="class in org.ggf.drmaa">SessionFactory</A></B></TD>
131
<TD>This class is used to retrieve a Session object tailored to the
134
<TR BGCOLOR="white" CLASS="TableRowColor">
135
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/Version.html" title="class in org.ggf.drmaa">Version</A></B></TD>
136
<TD>Class used to represent the DRM version info</TD>
143
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
144
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
145
<TD COLSPAN=2><FONT SIZE="+2">
146
<B>Exception Summary</B></FONT></TD>
148
<TR BGCOLOR="white" CLASS="TableRowColor">
149
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/AlreadyActiveSessionException.html" title="class in org.ggf.drmaa">AlreadyActiveSessionException</A></B></TD>
150
<TD>Initialization failed due to existing DRMAA session.</TD>
152
<TR BGCOLOR="white" CLASS="TableRowColor">
153
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/AuthorizationException.html" title="class in org.ggf.drmaa">AuthorizationException</A></B></TD>
154
<TD>The specified request is not processed successfully due to an
155
authorization failure.</TD>
157
<TR BGCOLOR="white" CLASS="TableRowColor">
158
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/ConflictingAttributeValuesException.html" title="class in org.ggf.drmaa">ConflictingAttributeValuesException</A></B></TD>
159
<TD>The value of this attribute conflicts with the values of one or more previously
162
<TR BGCOLOR="white" CLASS="TableRowColor">
163
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/DefaultContactStringException.html" title="class in org.ggf.drmaa">DefaultContactStringException</A></B></TD>
164
<TD>DRMAA could not use the default contact string to connect to the DRM
167
<TR BGCOLOR="white" CLASS="TableRowColor">
168
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/DeniedByDrmException.html" title="class in org.ggf.drmaa">DeniedByDrmException</A></B></TD>
169
<TD>The DRM system rejected the job.</TD>
171
<TR BGCOLOR="white" CLASS="TableRowColor">
172
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></B></TD>
173
<TD>The base class for all caught DRMAA Exceptions.</TD>
175
<TR BGCOLOR="white" CLASS="TableRowColor">
176
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/DrmaaRuntimeException.html" title="class in org.ggf.drmaa">DrmaaRuntimeException</A></B></TD>
177
<TD>The base class for all uncaught DRMAA Exceptions.</TD>
179
<TR BGCOLOR="white" CLASS="TableRowColor">
180
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/DrmCommunicationException.html" title="class in org.ggf.drmaa">DrmCommunicationException</A></B></TD>
181
<TD>Could not contact DRM system for this request.</TD>
183
<TR BGCOLOR="white" CLASS="TableRowColor">
184
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/DrmsExitException.html" title="class in org.ggf.drmaa">DrmsExitException</A></B></TD>
185
<TD>DRM system disengagement failed.</TD>
187
<TR BGCOLOR="white" CLASS="TableRowColor">
188
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/DrmsInitException.html" title="class in org.ggf.drmaa">DrmsInitException</A></B></TD>
189
<TD>DRM system initialization failed.</TD>
191
<TR BGCOLOR="white" CLASS="TableRowColor">
192
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/ExitTimeoutException.html" title="class in org.ggf.drmaa">ExitTimeoutException</A></B></TD>
193
<TD>We have encountered a time-out condition for DRMAASession.synchronize()
194
or DRMAASession.wait().</TD>
196
<TR BGCOLOR="white" CLASS="TableRowColor">
197
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/HoldInconsistentStateException.html" title="class in org.ggf.drmaa">HoldInconsistentStateException</A></B></TD>
198
<TD>The job is not in a state where it can be held.</TD>
200
<TR BGCOLOR="white" CLASS="TableRowColor">
201
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/InconsistentStateException.html" title="class in org.ggf.drmaa">InconsistentStateException</A></B></TD>
202
<TD>The job cannot be moved to the requested state.</TD>
204
<TR BGCOLOR="white" CLASS="TableRowColor">
205
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/InternalException.html" title="class in org.ggf.drmaa">InternalException</A></B></TD>
206
<TD>Unexpected or internal DRMAA error like memory allocation,
207
system call failure, etc.</TD>
209
<TR BGCOLOR="white" CLASS="TableRowColor">
210
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/InvalidArgumentException.html" title="class in org.ggf.drmaa">InvalidArgumentException</A></B></TD>
211
<TD>The input value for an argument is invalid.</TD>
213
<TR BGCOLOR="white" CLASS="TableRowColor">
214
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/InvalidAttributeException.html" title="class in org.ggf.drmaa">InvalidAttributeException</A></B></TD>
215
<TD>The value or format of an attribute is invalid.</TD>
217
<TR BGCOLOR="white" CLASS="TableRowColor">
218
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/InvalidAttributeFormatException.html" title="class in org.ggf.drmaa">InvalidAttributeFormatException</A></B></TD>
219
<TD>The format for the attribute value is invalid.</TD>
221
<TR BGCOLOR="white" CLASS="TableRowColor">
222
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/InvalidAttributeValueException.html" title="class in org.ggf.drmaa">InvalidAttributeValueException</A></B></TD>
223
<TD>The value for the attribute is invalid.</TD>
225
<TR BGCOLOR="white" CLASS="TableRowColor">
226
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/InvalidContactStringException.html" title="class in org.ggf.drmaa">InvalidContactStringException</A></B></TD>
227
<TD>Initialization failed due to an invalid contact string.</TD>
229
<TR BGCOLOR="white" CLASS="TableRowColor">
230
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/InvalidJobException.html" title="class in org.ggf.drmaa">InvalidJobException</A></B></TD>
231
<TD>The job specified by the given id does not exist.</TD>
233
<TR BGCOLOR="white" CLASS="TableRowColor">
234
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/InvalidJobTemplateException.html" title="class in org.ggf.drmaa">InvalidJobTemplateException</A></B></TD>
235
<TD>The JobTemplate object is no longer valid.</TD>
237
<TR BGCOLOR="white" CLASS="TableRowColor">
238
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/NoActiveSessionException.html" title="class in org.ggf.drmaa">NoActiveSessionException</A></B></TD>
239
<TD>Requested action failed because there is no active session.</TD>
241
<TR BGCOLOR="white" CLASS="TableRowColor">
242
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/NoDefaultContactStringException.html" title="class in org.ggf.drmaa">NoDefaultContactStringException</A></B></TD>
243
<TD>No default contact string was given to use to connect to the DRM system.</TD>
245
<TR BGCOLOR="white" CLASS="TableRowColor">
246
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/NoResourceUsageException.html" title="class in org.ggf.drmaa">NoResourceUsageException</A></B></TD>
247
<TD>Thrown by Session.wait() when a job has finished
248
but no resource usage information and exit status data could be provided.</TD>
250
<TR BGCOLOR="white" CLASS="TableRowColor">
251
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/ReleaseInconsistentStateException.html" title="class in org.ggf.drmaa">ReleaseInconsistentStateException</A></B></TD>
252
<TD>The job is not in a state where it can be released.</TD>
254
<TR BGCOLOR="white" CLASS="TableRowColor">
255
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/ResumeInconsistentStateException.html" title="class in org.ggf.drmaa">ResumeInconsistentStateException</A></B></TD>
256
<TD>The job is not in a state where it can be resumed.</TD>
258
<TR BGCOLOR="white" CLASS="TableRowColor">
259
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/SessionException.html" title="class in org.ggf.drmaa">SessionException</A></B></TD>
260
<TD>A problem occured with the DRM session preventing the routine from completing.</TD>
262
<TR BGCOLOR="white" CLASS="TableRowColor">
263
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/SuspendInconsistentStateException.html" title="class in org.ggf.drmaa">SuspendInconsistentStateException</A></B></TD>
264
<TD>The job is not in a state where it can be suspended.</TD>
266
<TR BGCOLOR="white" CLASS="TableRowColor">
267
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/TryLaterException.html" title="class in org.ggf.drmaa">TryLaterException</A></B></TD>
268
<TD>Could not submit the job to DRM system at this time.</TD>
270
<TR BGCOLOR="white" CLASS="TableRowColor">
271
<TD WIDTH="15%"><B><A HREF="../../../org/ggf/drmaa/UnsupportedAttributeException.html" title="class in org.ggf.drmaa">UnsupportedAttributeException</A></B></TD>
272
<TD>This exception is thrown when a setter or getter is called for an unsupported
273
optional attribute.</TD>
279
<A NAME="package_description"><!-- --></A><H2>
280
Package org.ggf.drmaa Description
284
Provides an implementation of the Distributed Resource Management
285
Application API (DRMAA). DRMAA is used for interacting with a Distributed
286
Resource Manager (DRM). The Session interface is the main point of
287
interaction and provides the ability to submit, monitor, and control jobs.
292
<DT><B>Since:</B></DT>
294
<DT><B>Version:</B></DT>
296
<DT><B>Author:</B></DT>
297
<DD>dan.templeton@sun.com</DD>
298
<DT><B>See Also:</B><DD><A HREF="../../../org/ggf/drmaa/Session.html" title="interface in org.ggf.drmaa"><CODE>Session</CODE></A></DL>
302
<!-- ======= START OF BOTTOM NAVBAR ====== -->
303
<A NAME="navbar_bottom"><!-- --></A>
304
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
305
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
307
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
308
<A NAME="navbar_bottom_firstrow"><!-- --></A>
309
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
310
<TR ALIGN="center" VALIGN="top">
311
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
312
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
313
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
314
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
315
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
316
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
317
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
321
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
327
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
328
<A HREF="../../../com/sun/grid/drmaa/package-summary.html"><B>PREV PACKAGE</B></A>
329
NEXT PACKAGE</FONT></TD>
330
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
331
<A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>
332
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
333
<SCRIPT type="text/javascript">
336
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
341
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
347
<A NAME="skip-navbar_bottom"></A>
348
<!-- ======== END OF BOTTOM NAVBAR ======= -->