~ubuntu-branches/ubuntu/utopic/gridengine/utopic

<DT>All Known Implementing Classes: <DD><A HREF="../../../com/sun/grid/drmaa/SessionImpl.html" title="class in com.sun.grid.drmaa">SessionImpl</A></DD>

</DL>

<HR>

<DL>

<DT>public interface Session</DL>

This interface represents a the operations available for interacting with the

DRM. In DRMAA, (almost) all DRM interaction occur within the context of a

session. The spec also strongly recommends that a DRMAA implementation not

allow concurrent sessions. Since DRMAA has no facility for user authentication

or authorization, most DRMAA implementations will likely only support one

100

session per implementation instance.

101

In order to use a Session, it must first be initialized. Once initialized it

102

is the responsibility of the programmer to ensure that the session also be

103

explicitly terminated. Otherwise, session artifacts may be left behind on

104

the client and/or server. A handy way to make sure the Session is terminated is

105

to set up a shutdown hook to call the exit() method on the active session.

106

To get a Session implementation appropriate for the DRM in use, one uses the

107

SessionFactory.getSession() method.

108

Example:

109

<pre>public static void main (String[] args) throws Exception {

110

SessionFactory factory = SessionFactory.getFactory ();

111

Session session = factory.getSession ();

112

113

try {

114

session.init (null);

115

JobTemplate jt = session.createJobTemplate ();

116

jt.setRemoteCommand ("sleeper.sh");

117

jt.setArgs (new String[] {"5"});

118

119

String id = session.runJob (jt);

120

121

session.deleteJobTemplate (jt);

122

123

while (session.getJobProgramStatus (id) != Session.RUNNING) {

124

Thread.sleep (1000);

125

}

126

127

System.out.println ("Job " + id + " is now running.");

128

129

session.control (id, Session.SUSPEND);

130

Thread.sleep (1000);

131

session.control (id, Session.RELEASE);

132

133

JobInfo info = session.wait (id, Session.TIMEOUT_WAIT_FOREVER);

134

135

System.out.println ("Job " + info.getJobId () + " exited with status: " +

136

info.getExitStatus ());

137

138

session.exit ();

139

}

140

catch (DrmaaException e) {

141

System.out.println ("Error: " + e.getMessage ());

142

}

143

}

144

</pre>

145

146

147

148

<DL>

149

<DT>Since:</DT>

150

151

<DT>Author:</DT>

152

<DD>dan.templeton@sun.com</DD>

153

<DT>See Also:<DD><CODE>Runtime.addShutdownHook(java.lang.Thread)</CODE>,

154

<A HREF="../../../org/ggf/drmaa/SessionFactory.html" title="class in org.ggf.drmaa"><CODE>SessionFactory</CODE></A>,

155

156

href="http://gridengine.sunsource.net/project/gridengine/howto/drmaa_java.html">Grid

157

Engine DRMAA Java[TM] Language Binding HowTo</a></DL>

158

<HR>

159

160

161

162

163

164

165

166

167

168

169

170

Field Summary</TD>

171

</TR>

172

173

174

<CODE>static int</CODE></TD>

175

176

177

178

Job has finished normally</TD>

179

</TR>

180

181

182

<CODE>static int</CODE></TD>

183

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#FAILED">FAILED</A></CODE>

184

185

186

Job finished, but terminated abnormally</TD>

187

</TR>

188

189

190

<CODE>static int</CODE></TD>

191

192

193

194

Put the job on hold</TD>

195

</TR>

196

197

198

<CODE>static java.lang.String</CODE></TD>

199

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#JOB_IDS_SESSION_ALL">JOB_IDS_SESSION_ALL</A></CODE>

200

201

202

All jobs submitted during this DRMAA session</TD>

203

</TR>

204

205

206

<CODE>static java.lang.String</CODE></TD>

207

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#JOB_IDS_SESSION_ANY">JOB_IDS_SESSION_ANY</A></CODE>

208

209

210

Any job from the session</TD>

211

</TR>

212

213

214

<CODE>static int</CODE></TD>

215

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#QUEUED_ACTIVE">QUEUED_ACTIVE</A></CODE>

216

217

218

Job is queued and active</TD>

219

</TR>

220

221

222

<CODE>static int</CODE></TD>

223

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#RELEASE">RELEASE</A></CODE>

224

225

226

Release the hold on the job</TD>

227

</TR>

228

229

230

<CODE>static int</CODE></TD>

231

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#RESUME">RESUME</A></CODE>

232

233

234

Resume the job</TD>

235

</TR>

236

237

238

<CODE>static int</CODE></TD>

239

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#RUNNING">RUNNING</A></CODE>

240

241

242

Job is running</TD>

243

</TR>

244

245

246

<CODE>static int</CODE></TD>

247

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#SUSPEND">SUSPEND</A></CODE>

248

249

250

Suspend the job</TD>

251

</TR>

252

253

254

<CODE>static int</CODE></TD>

255

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#SYSTEM_ON_HOLD">SYSTEM_ON_HOLD</A></CODE>

256

257

258

Job is queued and in system hold</TD>

259

</TR>

260

261

262

<CODE>static int</CODE></TD>

263

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#SYSTEM_SUSPENDED">SYSTEM_SUSPENDED</A></CODE>

264

265

266

Job is system suspended</TD>

267

</TR>

268

269

270

<CODE>static int</CODE></TD>

271

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#TERMINATE">TERMINATE</A></CODE>

272

273

274

Kill the job</TD>

275

</TR>

276

277

278

<CODE>static long</CODE></TD>

279

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#TIMEOUT_NO_WAIT">TIMEOUT_NO_WAIT</A></CODE>

280

281

282

Return immediately if no result is available</TD>

283

</TR>

284

285

286

<CODE>static long</CODE></TD>

287

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#TIMEOUT_WAIT_FOREVER">TIMEOUT_WAIT_FOREVER</A></CODE>

288

289

290

Wait indefinitely for a result</TD>

291

</TR>

292

293

294

<CODE>static int</CODE></TD>

295

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#UNDETERMINED">UNDETERMINED</A></CODE>

296

297

298

Job status cannot be determined</TD>

299

</TR>

300

301

302

<CODE>static int</CODE></TD>

303

304

305

306

Job is queued and in user hold</TD>

307

</TR>

308

309

310

<CODE>static int</CODE></TD>

311

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#USER_SUSPENDED">USER_SUSPENDED</A></CODE>

312

313

314

Job is user suspended</TD>

315

</TR>

316

317

318

<CODE>static int</CODE></TD>

319

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#USER_SYSTEM_ON_HOLD">USER_SYSTEM_ON_HOLD</A></CODE>

320

321

322

Job is queued and in user and system hold</TD>

323

</TR>

324

325

326

<CODE>static int</CODE></TD>

327

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#USER_SYSTEM_SUSPENDED">USER_SYSTEM_SUSPENDED</A></CODE>

328

329

330

Job is user suspended</TD>

331

</TR>

332

</TABLE>

333

334

335

336

337

338

339

340

341

342

343

Method Summary</TD>

344

</TR>

345

346

347

348

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#control(java.lang.String, int)">control</A>(java.lang.String jobId,

349

int action)</CODE>

350

351

352

Hold, release, suspend, resume, or kill the job identified by jobId.</TD>

353

</TR>

354

355

356

<CODE> <A HREF="../../../org/ggf/drmaa/JobTemplate.html" title="class in org.ggf.drmaa">JobTemplate</A></CODE></TD>

357

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#createJobTemplate()">createJobTemplate</A>()</CODE>

358

359

360

Get a new job template.</TD>

361

</TR>

362

363

364

365

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#deleteJobTemplate(org.ggf.drmaa.JobTemplate)">deleteJobTemplate</A>(<A HREF="../../../org/ggf/drmaa/JobTemplate.html" title="class in org.ggf.drmaa">JobTemplate</A> jt)</CODE>

366

367

368

Deallocate a job template.</TD>

369

</TR>

370

371

372

373

374

375

376

          Disengage from DRM and allow the DRMAA implementation to perform

377

any necessary internal cleanup.</TD>

378

</TR>

379

380

381

<CODE> java.lang.String</CODE></TD>

382

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#getContact()">getContact</A>()</CODE>

383

384

385

          If called before init(), this method returns a comma delimited String containing

386

the contact Strings available from the default DRMAA

387

implementation, one element per DRM system available.</TD>

388

</TR>

389

390

391

<CODE> java.lang.String</CODE></TD>

392

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#getDrmaaImplementation()">getDrmaaImplementation</A>()</CODE>

393

394

395

          If called before init(), this method returns a comma delimited list of DRMAA

396

implementations, one element for each DRMAA implementation provided.</TD>

397

</TR>

398

399

400

<CODE> java.lang.String</CODE></TD>

401

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#getDrmSystem()">getDrmSystem</A>()</CODE>

402

403

404

          If called before init(), this method returns a comma delimited list of DRM

405

systems, one element per DRM system implementation provided.</TD>

406

</TR>

407

408

409

410

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#getJobProgramStatus(java.lang.String)">getJobProgramStatus</A>(java.lang.String jobId)</CODE>

411

412

413

Get the program status of the job identified by jobId.</TD>

414

</TR>

415

416

417

<CODE> <A HREF="../../../org/ggf/drmaa/Version.html" title="class in org.ggf.drmaa">Version</A></CODE></TD>

418

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#getVersion()">getVersion</A>()</CODE>

419

420

421

          Returns a Version object containing the major and minor version numbers of the

422

DRMAA library.</TD>

423

</TR>

424

425

426

427

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#init(java.lang.String)">init</A>(java.lang.String contact)</CODE>

428

429

430

Initialize the DRMAA implementation.</TD>

431

</TR>

432

433

434

435

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#runBulkJobs(org.ggf.drmaa.JobTemplate, int, int, int)">runBulkJobs</A>(<A HREF="../../../org/ggf/drmaa/JobTemplate.html" title="class in org.ggf.drmaa">JobTemplate</A> jt,

436

int start,

437

int end,

438

int incr)</CODE>

439

440

441

          Submit a set of parametric jobs, dependent on the implied loop index,

442

each with attributes defined in the job template, jt.</TD>

443

</TR>

444

445

446

<CODE> java.lang.String</CODE></TD>

447

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#runJob(org.ggf.drmaa.JobTemplate)">runJob</A>(<A HREF="../../../org/ggf/drmaa/JobTemplate.html" title="class in org.ggf.drmaa">JobTemplate</A> jt)</CODE>

448

449

450

Submit a job with attributes defined in the job template, jt.</TD>

451

</TR>

452

453

454

455

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#synchronize(java.util.List, long, boolean)">synchronize</A>(java.util.List jobIds,

456

long timeout,

457

boolean dispose)</CODE>

458

459

460

Wait until all jobs specified by jobIds have finished execution.</TD>

461

</TR>

462

463

464

<CODE> <A HREF="../../../org/ggf/drmaa/JobInfo.html" title="class in org.ggf.drmaa">JobInfo</A></CODE></TD>

465

<TD><CODE><A HREF="../../../org/ggf/drmaa/Session.html#wait(java.lang.String, long)">wait</A>(java.lang.String jobId,

466

long timeout)</CODE>

467

468

469

This method will wait for a job with jobId to finish execution or fail.</TD>

470

</TR>

471

</TABLE>

472

473

474

475

476

477

478

479

480

481

Field Detail</TD>

482

</TR>

483

</TABLE>

484

485

486

SUSPEND</H3>

487

<PRE>

488

public static final int SUSPEND</PRE>

489

<DL>

490

<DD>Suspend the job

491

492

<DL>

493

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.SUSPEND">Constant Field Values</A></DL>

494

</DL>

495

<HR>

496

497

498

RESUME</H3>

499

<PRE>

500

public static final int RESUME</PRE>

501

<DL>

502

<DD>Resume the job

503

504

<DL>

505

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.RESUME">Constant Field Values</A></DL>

506

</DL>

507

<HR>

508

509

510

HOLD</H3>

511

<PRE>

512

public static final int HOLD</PRE>

513

<DL>

514

<DD>Put the job on hold

515

516

<DL>

517

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.HOLD">Constant Field Values</A></DL>

518

</DL>

519

<HR>

520

521

522

RELEASE</H3>

523

<PRE>

524

public static final int RELEASE</PRE>

525

<DL>

526

<DD>Release the hold on the job

527

528

<DL>

529

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.RELEASE">Constant Field Values</A></DL>

530

</DL>

531

<HR>

532

533

534

TERMINATE</H3>

535

<PRE>

536

public static final int TERMINATE</PRE>

537

<DL>

538

<DD>Kill the job

539

540

<DL>

541

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.TERMINATE">Constant Field Values</A></DL>

542

</DL>

543

<HR>

544

545

546

JOB_IDS_SESSION_ALL</H3>

547

<PRE>

548

public static final java.lang.String JOB_IDS_SESSION_ALL</PRE>

549

<DL>

550

<DD>All jobs submitted during this DRMAA session

551

552

<DL>

553

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.JOB_IDS_SESSION_ALL">Constant Field Values</A></DL>

554

</DL>

555

<HR>

556

557

558

JOB_IDS_SESSION_ANY</H3>

559

<PRE>

560

public static final java.lang.String JOB_IDS_SESSION_ANY</PRE>

561

<DL>

562

<DD>Any job from the session

563

564

<DL>

565

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.JOB_IDS_SESSION_ANY">Constant Field Values</A></DL>

566

</DL>

567

<HR>

568

569

570

TIMEOUT_WAIT_FOREVER</H3>

571

<PRE>

572

public static final long TIMEOUT_WAIT_FOREVER</PRE>

573

<DL>

574

<DD>Wait indefinitely for a result

575

576

<DL>

577

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.TIMEOUT_WAIT_FOREVER">Constant Field Values</A></DL>

578

</DL>

579

<HR>

580

581

582

TIMEOUT_NO_WAIT</H3>

583

<PRE>

584

public static final long TIMEOUT_NO_WAIT</PRE>

585

<DL>

586

<DD>Return immediately if no result is available

587

588

<DL>

589

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.TIMEOUT_NO_WAIT">Constant Field Values</A></DL>

590

</DL>

591

<HR>

592

593

594

UNDETERMINED</H3>

595

<PRE>

596

public static final int UNDETERMINED</PRE>

597

<DL>

598

<DD>Job status cannot be determined

599

600

<DL>

601

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.UNDETERMINED">Constant Field Values</A></DL>

602

</DL>

603

<HR>

604

605

606

QUEUED_ACTIVE</H3>

607

<PRE>

608

public static final int QUEUED_ACTIVE</PRE>

609

<DL>

610

<DD>Job is queued and active

611

612

<DL>

613

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.QUEUED_ACTIVE">Constant Field Values</A></DL>

614

</DL>

615

<HR>

616

617

618

SYSTEM_ON_HOLD</H3>

619

<PRE>

620

public static final int SYSTEM_ON_HOLD</PRE>

621

<DL>

622

<DD>Job is queued and in system hold

623

624

<DL>

625

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.SYSTEM_ON_HOLD">Constant Field Values</A></DL>

626

</DL>

627

<HR>

628

629

630

USER_ON_HOLD</H3>

631

<PRE>

632

public static final int USER_ON_HOLD</PRE>

633

<DL>

634

<DD>Job is queued and in user hold

635

636

<DL>

637

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.USER_ON_HOLD">Constant Field Values</A></DL>

638

</DL>

639

<HR>

640

641

642

USER_SYSTEM_ON_HOLD</H3>

643

<PRE>

644

public static final int USER_SYSTEM_ON_HOLD</PRE>

645

<DL>

646

<DD>Job is queued and in user and system hold

647

648

<DL>

649

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.USER_SYSTEM_ON_HOLD">Constant Field Values</A></DL>

650

</DL>

651

<HR>

652

653

654

RUNNING</H3>

655

<PRE>

656

public static final int RUNNING</PRE>

657

<DL>

658

<DD>Job is running

659

660

<DL>

661

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.RUNNING">Constant Field Values</A></DL>

662

</DL>

663

<HR>

664

665

666

SYSTEM_SUSPENDED</H3>

667

<PRE>

668

public static final int SYSTEM_SUSPENDED</PRE>

669

<DL>

670

<DD>Job is system suspended

671

672

<DL>

673

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.SYSTEM_SUSPENDED">Constant Field Values</A></DL>

674

</DL>

675

<HR>

676

677

678

USER_SUSPENDED</H3>

679

<PRE>

680

public static final int USER_SUSPENDED</PRE>

681

<DL>

682

<DD>Job is user suspended

683

684

<DL>

685

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.USER_SUSPENDED">Constant Field Values</A></DL>

686

</DL>

687

<HR>

688

689

690

USER_SYSTEM_SUSPENDED</H3>

691

<PRE>

692

public static final int USER_SYSTEM_SUSPENDED</PRE>

693

<DL>

694

<DD>Job is user suspended

695

696

<DL>

697

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.USER_SYSTEM_SUSPENDED">Constant Field Values</A></DL>

698

</DL>

699

<HR>

700

701

702

DONE</H3>

703

<PRE>

704

public static final int DONE</PRE>

705

<DL>

706

<DD>Job has finished normally

707

708

<DL>

709

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.DONE">Constant Field Values</A></DL>

710

</DL>

711

<HR>

712

713

714

FAILED</H3>

715

<PRE>

716

public static final int FAILED</PRE>

717

<DL>

718

<DD>Job finished, but terminated abnormally

719

720

<DL>

721

<DT>See Also:<DD><A HREF="../../../constant-values.html#org.ggf.drmaa.Session.FAILED">Constant Field Values</A></DL>

722

</DL>

723

724

725

726

727

728

729

730

731

732

733

Method Detail</TD>

734

</TR>

735

</TABLE>

736

737

738

init</H3>

739

<PRE>

740

public void init(java.lang.String contact)

741

throws <A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></PRE>

742

<DL>

743

<DD>Initialize the DRMAA implementation.

744

contact is an implementation-dependent string that may be used to specify

745

which DRM system to use. This routine must be called before any

746

other DRMAA calls, except for getVersion(), getDRMSystem(),

747

getDRMAAImplementation(), or getContact().

748

If contact is <CODE>null</CODE>, the default DRM system is used,

749

provided there is only one DRMAA implementation in the module.

750

If there is more than one DRMAA implementation in the module, init() throws a

751

NoDefaultContactStringSelectedException.

752

init() should be called only once, by only one of the threads. The main thread is

753

recommended. A call to init() by another thread or additional calls to init()

754

by the same thread with throw a SessionAlreadyActiveException.

755

756

757

<DT>Parameters:<DD><CODE>contact</CODE> - implementation-dependent string that may be used to specify

758

which DRM system to use. If null, will select the default DRM if there

759

is only one DRMAA implementation available.

760

<DT>Throws:

761

<DD><CODE><A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></CODE> - May be be one of the following:

762

<UL>

763

<LI>InvalidContactStringException</LI>

764

<LI>AlreadyActiveSessionException</LI>

765

<LI>DefaultContactStringException</LI>

766

<LI>NoDefaultContactStringSelectedException</LI>

767

</UL></DL>

768

</DD>

769

</DL>

770

<HR>

771

772

773

exit</H3>

774

<PRE>

775

public void exit()

776

throws <A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></PRE>

777

<DL>

778

<DD>Disengage from DRM and allow the DRMAA implementation to perform

779

any necessary internal cleanup.

780

This routine ends the current DRMAA session but doesn't affect any

781

jobs (e.g., queued and running jobs remain queued and running).

782

exit() should be called only once, by only one of the threads. Additional

783

calls to exit() beyond the first will throw a NoActiveSessionException.

784

785

786

787

<DT>Throws:

788

<DD><CODE><A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></CODE> - May be one of the following:

789

<UL>

790

<LI>DrmsExitException</LI>

791

<LI>NoActiveSessionException</LI>

792

</UL></DL>

793

</DD>

794

</DL>

795

<HR>

796

797

798

createJobTemplate</H3>

799

<PRE>

800

public <A HREF="../../../org/ggf/drmaa/JobTemplate.html" title="class in org.ggf.drmaa">JobTemplate</A> createJobTemplate()

801

throws <A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></PRE>

802

<DL>

803

<DD>Get a new job template. The job template is used to set the

804

environment for jobs to be submitted. Once the job template has been created,

805

it should also be deleted (via deleteJobTemplate()) when no longer needed.

806

Failure to do so may result in a memory leak.

807

808

809

810

<DT>Returns:<DD>a blank JobTemplate object

811

<DT>Throws:

812

<DD><CODE><A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></CODE> - May be one of the following:

813

<UL>

814

<LI>DrmCommunicationException</LI>

815

</UL><DT>See Also:<DD><A HREF="../../../org/ggf/drmaa/JobTemplate.html" title="class in org.ggf.drmaa"><CODE>JobTemplate</CODE></A></DL>

816

</DD>

817

</DL>

818

<HR>

819

820

821

deleteJobTemplate</H3>

822

<PRE>

823

public void deleteJobTemplate(<A HREF="../../../org/ggf/drmaa/JobTemplate.html" title="class in org.ggf.drmaa">JobTemplate</A> jt)

824

throws <A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></PRE>

825

<DL>

826

<DD>Deallocate a job template. This routine has no effect on running jobs.

827

828

829

<DT>Parameters:<DD><CODE>jt</CODE> - the JobTemplate to delete

830

<DT>Throws:

831

<DD><CODE><A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></CODE> - May be one of the following:

832

<UL>

833

<LI>DrmCommunicationException</LI>

834

<LI>InvalidJobTemplateException</LI>

835

</UL></DL>

836

</DD>

837

</DL>

838

<HR>

839

840

841

runJob</H3>

842

<PRE>

843

public java.lang.String runJob(<A HREF="../../../org/ggf/drmaa/JobTemplate.html" title="class in org.ggf.drmaa">JobTemplate</A> jt)

844

throws <A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></PRE>

845

<DL>

846

<DD>Submit a job with attributes defined in the job template, jt.

847

The returned job identifier is a String identical to that returned

848

from the underlying DRM system.

849

850

851

<DT>Parameters:<DD><CODE>jt</CODE> - the job template to be used to create the job

852

<DT>Returns:<DD>job identifier String identical to that returned from the

853

underlying DRM system

854

<DT>Throws:

855

<DD><CODE><A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></CODE> - May be one of the following:

856

<UL>

857

<LI>TryLaterException</LI>

858

<LI>DeniedByDrmException</LI>

859

<LI>DrmCommunicationException</LI>

860

<LI>AuthorizationException</LI>

861

<LI>InvalidJobTemplateException</LI>

862

</UL></DL>

863

</DD>

864

</DL>

865

<HR>

866

867

868

runBulkJobs</H3>

869

<PRE>

870

public java.util.List runBulkJobs(<A HREF="../../../org/ggf/drmaa/JobTemplate.html" title="class in org.ggf.drmaa">JobTemplate</A> jt,

871

int start,

872

int end,

873

int incr)

874

throws <A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></PRE>

875

<DL>

876

<DD>Submit a set of parametric jobs, dependent on the implied loop index,

877

each with attributes defined in the job template, jt.

878

The returned job identifiers are Strings identical to those returned

879

from the underlying DRM system.

880

The JobTemplate class defines a <code>PARAMETRIC_INDEX</code> placeholder for use in

881

specifying paths. This placeholder is used to represent the individual

882

identifiers of the tasks submitted through this method.

883

884

885

<DT>Parameters:<DD><CODE>start</CODE> - the starting value for the loop index<DD><CODE>end</CODE> - the terminating value for the loop index<DD><CODE>incr</CODE> - the value by which to increment the loop index each iteration<DD><CODE>jt</CODE> - the job template to be used to create the job

886

<DT>Returns:<DD>job identifier Strings identical to that returned by the

887

underlying DRM system

888

<DT>Throws:

889

<DD><CODE><A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></CODE> - May be one of the following:

890

<UL>

891

<LI>TryLaterException</LI>

892

<LI>DeniedByDrmException</LI>

893

<LI>DrmCommunicationException</LI>

894

<LI>AuthorizationException</LI>

895

<LI>InvalidJobTemplateException</LI>

896

</UL></DL>

897

</DD>

898

</DL>

899

<HR>

900

901

902

control</H3>

903

<PRE>

904

public void control(java.lang.String jobId,

905

int action)

906

throws <A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></PRE>

907

<DL>

908

<DD>Hold, release, suspend, resume, or kill the job identified by jobId.

909

If jobId is <code>JOB_IDS_SESSION_ALL</code>, then this routine acts on all jobs

910

submitted during this DRMAA session up to the moment control() is

911

called. To avoid thread races in multithreaded applications, the DRMAA

912

implementation user should explicitly synchronize this call with any other

913

job submission calls or control calls that may change the number of remote

914

jobs.

915

The legal values for action and their meanings are:

916

<UL>

917

<LI><code>SUSPEND</code>: stop the job,</LI>

918

<LI><code>RESUME</code>: (re)start the job,</LI>

919

920

<LI><code>RELEASE</code>: release the hold on the job, and</LI>

921

<LI><code>TERMINATE</code>: kill the job.</LI>

922

</UL>

923

924

This method returns once the action has been acknowledged by

925

the DRM system, but does not necessarily wait until the action

926

has been completed.

927

Some DRMAA implementations may allow this method to be used to control jobs

928

submitted external to the DRMAA session, such as jobs submitted by other DRMAA

929

session in other DRMAA implementations or jobs submitted via native

930

utilities.

931

932

933

<DT>Parameters:<DD><CODE>jobId</CODE> - The id of the job to control<DD><CODE>action</CODE> - the control action to be taken

934

<DT>Throws:

935

<DD><CODE><A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></CODE> - May be one of the following:

936

<UL>

937

<LI>DrmCommunicationException</LI>

938

<LI>AuthorizationException</LI>

939

<LI>ResumeInconsistentStateException</LI>

940

<LI>SuspendInconsistentStateException</LI>

941

<LI>HoldInconsistentStateException</LI>

942

<LI>ReleaseInconsistentStateException</LI>

943

<LI>InvalidJobException</LI>

944

</UL></DL>

945

</DD>

946

</DL>

947

<HR>

948

949

950

synchronize</H3>

951

<PRE>

952

public void synchronize(java.util.List jobIds,

953

long timeout,

954

boolean dispose)

955

throws <A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></PRE>

956

<DL>

957

<DD>Wait until all jobs specified by jobIds have finished execution.

958

If jobIds contains <code>JOB_IDS_SESSION_ALL</code>, then this method waits for all

959

jobs submitted during this DRMAA session up to the moment

960

synchronize() is called. To avoid thread race conditions in multithreaded

961

applications, the DRMAA implementation user should explicitly synchronize

962

this call with any other job submission calls or control calls that may

963

change the number of remote jobs.

964

To prevent blocking indefinitely in this call, the caller may use a timeout

965

specifying after how many seconds to block in this call. The value

966

<code>TIMEOUT_WAIT_FOREVER MAY</code> be specified to wait indefinitely for a result.

967

The value <code>TIMEOUT_NO_WAIT MAY</code> be specified to return immediately if no

968

result is available. If the call exits before the timeout has elapsed, all the

969

jobs have been waited on or there was an interrupt.

970

If the invocation exits on timeout, an ExitTimeException is thrown.

971

The caller should check system time before and after this call in order to

972

be sure of how much time has passed.

973

The dispose parameter specifies how to treat the reaping of the remote job's

974

internal data record, which includes a record of the job's consumption of system

975

resources during its execution and other statistical information. If set to

976

<code>true</code>, the DRM will dispose of the job's data record at the end of

977

the synchroniize() call. If set to <code>false</code>, the data record will be

978

left for future access via the wait() method.

979

980

981

<DT>Parameters:<DD><CODE>jobIds</CODE> - the ids of the jobs to synchronize<DD><CODE>timeout</CODE> - the maximum number of seconds to wait<DD><CODE>dispose</CODE> - specifies how to treat reaping information

982

<DT>Throws:

983

<DD><CODE><A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></CODE> - May be one of the following:

984

<UL>

985

<LI>DrmCommunicationException</LI>

986

<LI>AuthorizationException</LI>

987

<LI>ExitTimeoutException</LI>

988

<LI>InvalidJobException</LI>

989

</UL><DT>See Also:<DD><A HREF="../../../org/ggf/drmaa/Session.html#wait(java.lang.String, long)"><CODE>wait(java.lang.String, long)</CODE></A></DL>

990

</DD>

991

</DL>

992

<HR>

993

994

995

wait</H3>

996

<PRE>

997

public <A HREF="../../../org/ggf/drmaa/JobInfo.html" title="class in org.ggf.drmaa">JobInfo</A> wait(java.lang.String jobId,

998

long timeout)

999

throws <A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></PRE>

1000

<DL>

1001

<DD>This method will wait for a job with jobId to finish execution or fail.

1002

If the special string, <code>JOB_IDS_SESSION_ANY</code>, is provided as the

1003

jobId,

1004

this routine will wait for any job from the session. This routine is

1005

modeled on the wait3 POSIX routine.

1006

The timeout value is used to specify the desired behavior when a result

1007

is not immediately available. The value, <code>TIMEOUT_WAIT_FOREVER<code>, may be

1008

specified to wait indefinitely for a result. The value, <code>TIMEOUT_NO_WAIT<code>,

1009

may be specified to return immediately if no result is available.

1010

Alternatively, a number of seconds may be specified to indicate how

1011

long to wait for a result to become available.

1012

If the call exits before timeout, either the job has been waited on

1013

successfully or there was an interrupt.

1014

If the invocation exits on timeout, an ExitTimeoutException is thrown.

1015

The caller should check system time before and after this call

1016

in order to be sure how much time has passed.

1017

The routine reaps job data records on a successful call, so any subsequent

1018

calls to wait() will fail, throwing an InvalidJobException, meaning

1019

that the job's data record has been already reaped. This exception is the same as

1020

if the job was unknown. (The only case where wait() can be successfully called

1021

on a single job more than once is when the previous call to wait() timed out

1022

before the job finished.)

1023

When successful, the resource usage information for the job is provided as a

1024

Map of usage parameter names and their values.

1025

The values contain the amount of resources consumed by the job and are

1026

implementation defined.

1027

1028

1029

<DT>Parameters:<DD><CODE>jobId</CODE> - the id of the job for which to wait<DD><CODE>timeout</CODE> - the maximum number of seconds to wait

1030

<DT>Returns:<DD>the resource usage and status information

1031

<DT>Throws:

1032

<DD><CODE><A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></CODE> - May be one of the following:

1033

<UL>

1034

<LI>DrmCommunicationException</LI>

1035

<LI>AuthorizationException</LI>

1036

<LI>NoResourceUsageDataException</LI>

1037

<LI>ExitTimeoutException</LI>

1038

<LI>InvalidJobException</LI>

1039

</UL></DL>

1040

</DD>

1041

</DL>

1042

<HR>

1043

1044

1045

getJobProgramStatus</H3>

1046

<PRE>

1047

public int getJobProgramStatus(java.lang.String jobId)

1048

throws <A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></PRE>

1049

<DL>

1050

<DD>Get the program status of the job identified by jobId.

1051

The possible values returned from this method are:

1052

<UL>

1053

<LI><code>UNDETERMINED</code>: process status cannot be determined</LI>

1054

<LI><code>QUEUED_ACTIVE</code>: job is queued and active</LI>

1055

<LI><code>SYSTEM_ON_HOLD</code>: job is queued and in system hold</LI>

1056

<LI><code>USER_ON_HOLD</code>: job is queued and in user hold</LI>

1057

<LI><code>USER_SYSTEM_ON_HOLD</code>: job is queued and in user and system hold</LI>

1058

<LI><code>RUNNING</code>: job is running</LI>

1059

<LI><code>SYSTEM_SUSPENDED</code>: job is system suspended</LI>

1060

<LI><code>USER_SUSPENDED</code>: job is user suspended</LI>

1061

<LI><code>DONE</code>: job finished normally</LI>

1062

<LI><code>FAILED</code>: job finished, but failed.</LI>

1063

</UL>

1064

The DRMAA implementation should always get the status of jobId from DRM system

1065

unless the status has already been determined to be <code>FAILED</code> or <code>DONE</code> and the

1066

status has been successfully cached. Terminated jobs return a <code>FAILED</code> status.

1067

1068

1069

<DT>Parameters:<DD><CODE>jobId</CODE> - the id of the job whose status is to be retrieved

1070

<DT>Returns:<DD>the program status

1071

<DT>Throws:

1072

<DD><CODE><A HREF="../../../org/ggf/drmaa/DrmaaException.html" title="class in org.ggf.drmaa">DrmaaException</A></CODE> - May be one of the following:

1073

<UL>

1074

<LI>DrmCommunicationException</LI>

1075

<LI>AuthorizationException</LI>

1076

<LI>InvalidJobException</LI>

1077

</UL></DL>

1078

</DD>

1079

</DL>

1080

<HR>

1081

1082

1083

getContact</H3>

1084

<PRE>

1085

public java.lang.String getContact()</PRE>

1086

<DL>

1087

<DD>If called before init(), this method returns a comma delimited String containing

1088

the contact Strings available from the default DRMAA

1089

implementation, one element per DRM system available. If called after init(),

1090

this method returns the contact String for the DRM system to which the session

1091

is attached. The returned String is implementation dependent.

1092

1093

1094

1095

<DT>Returns:<DD>current contact information for DRM system or a comma delimited

1096

list of possible contact Strings</DL>

1097

</DD>

1098

</DL>

1099

<HR>

1100

1101

1102

getVersion</H3>

1103

<PRE>

1104

public <A HREF="../../../org/ggf/drmaa/Version.html" title="class in org.ggf.drmaa">Version</A> getVersion()</PRE>

1105

<DL>

1106

<DD>Returns a Version object containing the major and minor version numbers of the

1107

DRMAA library. For DRMAA 0.5, major is 0 and minor is 5.

1108

1109

1110

1111

<DT>Returns:<DD>the version number as a Version object<DT>See Also:<DD><A HREF="../../../org/ggf/drmaa/Version.html" title="class in org.ggf.drmaa"><CODE>Version</CODE></A></DL>

1112

</DD>

1113

</DL>

1114

<HR>

1115

1116

1117

getDrmSystem</H3>

1118

<PRE>

1119

public java.lang.String getDrmSystem()</PRE>

1120

<DL>

1121

<DD>If called before init(), this method returns a comma delimited list of DRM

1122

systems, one element per DRM system implementation provided. If called after

1123

init(), this method returns the selected DRM system. The returned String is

1124

implementation dependent.

1125

1126

1127

1128

<DT>Returns:<DD>DRM system implementation information</DL>

1129

</DD>

1130

</DL>

1131

<HR>

1132

1133

1134

getDrmaaImplementation</H3>

1135

<PRE>

1136

public java.lang.String getDrmaaImplementation()</PRE>

1137

<DL>

1138

<DD>If called before init(), this method returns a comma delimited list of DRMAA

1139

implementations, one element for each DRMAA implementation provided. If

1140

called after init(), this method returns the selected DRMAA implementation.

1141

The returned String is implementation dependent and may contain the DRM

1142

system as a component.

1143

1144

1145

1146

<DT>Returns:<DD>DRMAA implementation information</DL>

1147

</DD>

1148

</DL>

1149

1150

<HR>

1151

1152

1153

1154

1155

1156

1157

<TR>

1158

1159

1160

1161

1162

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html">Overview</A> </TD>

1163

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A> </TD>

1164

<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  Class </TD>

1165

1166

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html">Deprecated</A> </TD>

1167

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html">Index</A> </TD>

1168

1169

</TR>

1170

</TABLE>

1171

</TD>

1172

1173

1174

</TD>

1175

</TR>

1176

1177

<TR>

1178

1179

<A HREF="../../../org/ggf/drmaa/ResumeInconsistentStateException.html" title="class in org.ggf.drmaa">PREV CLASS</A>

1180

<A HREF="../../../org/ggf/drmaa/SessionException.html" title="class in org.ggf.drmaa">NEXT CLASS</A></TD>

1181

1182

<A HREF="../../../index.html" target="_top">FRAMES</A>

1183

<A HREF="Session.html" target="_top">NO FRAMES</A>

1184

1185

<!--

1186

if(window==top) {

1187

document.writeln('<A HREF="../../../allclasses-noframe.html">All Classes</A>');

1188

}

1189

//-->

1190

</SCRIPT>

1191

1192

<A HREF="../../../allclasses-noframe.html">All Classes</A>

1193

</NOSCRIPT>

1194

1195

</TD>

1196

</TR>

1197

<TR>

1198

1199

SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></TD>

1200

1201

DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></TD>

1202

</TR>

1203

</TABLE>

1204

1205

1206

1207

<HR>

1208

1209

</BODY>

1210

</HTML>

Older »