A

ACTIVE_STATE - Static variable in interface org.ggf.drmaa.JobTemplate

Means the job has been queued and is eligible to run.

add(int, int) - Method in class org.ggf.drmaa.PartialTimestamp

Adds the given value to the given field.

AlreadyActiveSessionException - Exception in org.ggf.drmaa

Initialization failed due to existing DRMAA session.

AlreadyActiveSessionException() - Constructor for exception org.ggf.drmaa.AlreadyActiveSessionException

Creates a new instance of SessionAlreadyActiveException without detail message.

AlreadyActiveSessionException(String) - Constructor for exception org.ggf.drmaa.AlreadyActiveSessionException

Constructs an instance of SessionAlreadyActiveException with the specified detail message.

AuthorizationException - Exception in org.ggf.drmaa

The action failed due to an authorization failure.

AuthorizationException() - Constructor for exception org.ggf.drmaa.AuthorizationException

Creates a new instance of AuthorizationException without detail message.

AuthorizationException(String) - Constructor for exception org.ggf.drmaa.AuthorizationException

Constructs an instance of AuthorizationException with the specified detail message.

C

CENTURY - Static variable in class org.ggf.drmaa.PartialTimestamp

CENTURY is a field required by the DRMAA timestamp.

clone() - Method in class org.ggf.drmaa.FileTransferMode

Creates a copy of this FileTransferMode object.

clone() - Method in class org.ggf.drmaa.PartialTimestamp

Makes a complete copy of this object.

clone() - Method in class org.ggf.drmaa.PartialTimestampFormat

Creates a copy of this object.

clone() - Method in class org.ggf.drmaa.Version

Returns a copy of this object.

com.sun.grid.drmaa - package com.sun.grid.drmaa

Provides a DRMAA implementation for the N1™ Grid Engine software.

compareTo(Object) - Method in class org.ggf.drmaa.Version

Compares this object with the specified object for order.

ConflictingAttributeValuesException - Exception in org.ggf.drmaa

The value of this property conflicts with the values of one or more previously set properties.

ConflictingAttributeValuesException() - Constructor for exception org.ggf.drmaa.ConflictingAttributeValuesException

Creates a new instance of ConflictingAttributeValuesException without detail message.

ConflictingAttributeValuesException(String) - Constructor for exception org.ggf.drmaa.ConflictingAttributeValuesException

Constructs an instance of ConflictingAttributeValuesException with the specified detail message.

control(String, int) - Method in class com.sun.grid.drmaa.SessionImpl

Controls a jobs.

control(String, int) - Method in interface org.ggf.drmaa.Session

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

createJobTemplate() - Method in class com.sun.grid.drmaa.SessionImpl

Get a new job template.

createJobTemplate() - Method in interface org.ggf.drmaa.Session

Get a new job template.

D

DefaultContactStringException - Exception in org.ggf.drmaa

DRMAA could not use the default contact string to connect to the DRM system.

DefaultContactStringException() - Constructor for exception org.ggf.drmaa.DefaultContactStringException

Creates a new instance of DefaultContactStringException without detail message.

DefaultContactStringException(String) - Constructor for exception org.ggf.drmaa.DefaultContactStringException

Constructs an instance of DefaultContactStringException with the specified detail message.

deleteJobTemplate(JobTemplate) - Method in class com.sun.grid.drmaa.SessionImpl

Deallocate a job template.

deleteJobTemplate(JobTemplate) - Method in interface org.ggf.drmaa.Session

Deallocate a job template.

DeniedByDrmException - Exception in org.ggf.drmaa

The DRM system rejected the job.

DeniedByDrmException() - Constructor for exception org.ggf.drmaa.DeniedByDrmException

Creates a new instance of DeniedByDrmException without detail message.

DeniedByDrmException(String) - Constructor for exception org.ggf.drmaa.DeniedByDrmException

Constructs an instance of DeniedByDrmException with the specified detail message.

DONE - Static variable in interface org.ggf.drmaa.Session

Job has finished normally.

DrmaaException - Exception in org.ggf.drmaa

The base class for all DRMAA Exceptions.

DrmaaException() - Constructor for exception org.ggf.drmaa.DrmaaException

Creates a new instance of DrmaaException without detail message.

DrmaaException(String) - Constructor for exception org.ggf.drmaa.DrmaaException

Constructs an instance of DrmaaException with the specified detail message.

DrmCommunicationException - Exception in org.ggf.drmaa

Could not contact DRM system for this request.

DrmCommunicationException() - Constructor for exception org.ggf.drmaa.DrmCommunicationException

Creates a new instance of CommunicationException without detail message.

DrmCommunicationException(String) - Constructor for exception org.ggf.drmaa.DrmCommunicationException

Constructs an instance of CommunicationException with the specified detail message.

DrmsExitException - Exception in org.ggf.drmaa

DRM system disengagement failed.

DrmsExitException() - Constructor for exception org.ggf.drmaa.DrmsExitException

Creates a new instance of DrmsExitException without detail message.

DrmsExitException(String) - Constructor for exception org.ggf.drmaa.DrmsExitException

Constructs an instance of DrmsExitException with the specified detail message.

DrmsInitException - Exception in org.ggf.drmaa

DRM system initialization failed.

DrmsInitException() - Constructor for exception org.ggf.drmaa.DrmsInitException

Creates a new instance of DrmsInitException without detail message.

DrmsInitException(String) - Constructor for exception org.ggf.drmaa.DrmsInitException

Constructs an instance of DrmsInitException with the specified detail message.

E

equals(Object) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Tests whether this JobTemplateImpl represents the same native job template as the given object.

equals(Object) - Method in class org.ggf.drmaa.FileTransferMode

Test whether two FileTransferMode objects have the same property settings.

equals(Object) - Method in class org.ggf.drmaa.PartialTimestamp

Compares two PartialTimestamp objects.

equals(Object) - Method in class org.ggf.drmaa.Version

Test for equality between two Version objects.

exit() - Method in class com.sun.grid.drmaa.SessionImpl

The exit() method closes the DRMAA session for all threads and must be called before process termination.

exit() - Method in interface org.ggf.drmaa.Session

Disengage from the DRM and allow the DRMAA implementation to perform any necessary internal cleanup.

ExitTimeoutException - Exception in org.ggf.drmaa

A call to Session.synchronize() or Session.wait() has timed out.

ExitTimeoutException() - Constructor for exception org.ggf.drmaa.ExitTimeoutException

Creates a new instance of ExitTimeoutException without detail message.

ExitTimeoutException(String) - Constructor for exception org.ggf.drmaa.ExitTimeoutException

Constructs an instance of ExitTimeoutException with the specified detail message.

F

FAILED - Static variable in interface org.ggf.drmaa.Session

Job finished, but terminated abnormally.

FileTransferMode - Class in org.ggf.drmaa

This class represents the streams which should be used for file transfers.

FileTransferMode() - Constructor for class org.ggf.drmaa.FileTransferMode

Creates a new instance of FileTransferMode

FileTransferMode(boolean, boolean, boolean) - Constructor for class org.ggf.drmaa.FileTransferMode

Create a new instance with the property values preset.

format(Object, StringBuffer, FieldPosition) - Method in class org.ggf.drmaa.PartialTimestampFormat

Translates the PartialTimestamp into a DRMAA specified time string and appends the string to the given StringBuffer.

format(PartialTimestamp, StringBuffer, FieldPosition) - Method in class org.ggf.drmaa.PartialTimestampFormat

Translates the PartialTimestamp into a DRMAA specified time string and appends the string to the given StringBuffer.

format(PartialTimestamp) - Method in class org.ggf.drmaa.PartialTimestampFormat

Translates the PartialTimestamp into a DRMAA specified time string.

G

get(int) - Method in class org.ggf.drmaa.PartialTimestamp

Get the value of the given field.

getActualMaximum(int) - Method in class org.ggf.drmaa.PartialTimestamp

Returns the actual maximum value for the field, based on the current field values.

getActualMinimum(int) - Method in class org.ggf.drmaa.PartialTimestamp

Returns the actual minimum value for the field, based on the current field values.

getArgs() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Get the arguments to the job.

getArgs() - Method in interface org.ggf.drmaa.JobTemplate

Get the arguments to the job.

getArgs() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getAttributeNames() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Returns the list of supported properties names.

getAttributeNames() - Method in interface org.ggf.drmaa.JobTemplate

Returns the list of supported property names.

getAttributeNames() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getBlockEmail() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Get whether to block sending e-mail by default, regardless of the DRMS settings.

getBlockEmail() - Method in interface org.ggf.drmaa.JobTemplate

Get whether to block sending e-mail by default, regardless of the DRMS settings.

getBlockEmail() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getContact() - Method in class com.sun.grid.drmaa.SessionImpl

getContact() returns an opaque string containing contact information related to the current DRMAA session to be used with the init() method.

getContact() - Method in interface org.ggf.drmaa.Session

If called before init(), this method returns a comma delimited String containing the contact Strings available from the default DRMAA implementation, one element per DRM system available.

getDeadlineTime() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Unsupported property.

getDeadlineTime() - Method in interface org.ggf.drmaa.JobTemplate

Sets a deadline after which the DRMS will terminate the job.

getDeadlineTime() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getDrmaaImplementation() - Method in class com.sun.grid.drmaa.SessionImpl

The getDrmaaImplementation() method returns a string containing the DRMAA Java language binding implementation version information.

getDrmaaImplementation() - Method in interface org.ggf.drmaa.Session

If called before init(), this method returns a comma delimited list of available DRMAA implementations, one element for each DRMAA implementation provided.

getDrmSystem() - Method in class com.sun.grid.drmaa.SessionImpl

The getDRMSystem() method returns a string containing the DRM product and version information.

getDrmSystem() - Method in interface org.ggf.drmaa.Session

If called before init(), this method returns a comma delimited list of available DRM systems, one element per DRM system implementation provided.

getEmail() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Get the list of email addresses used to report the job completion and status.

getEmail() - Method in interface org.ggf.drmaa.JobTemplate

Get the list of email addresses used to report the job completion and status.

getEmail() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getErrorPath() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Gets how to direct the job's standard error.

getErrorPath() - Method in interface org.ggf.drmaa.JobTemplate

Gets how to direct the job's standard error.

getErrorPath() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getErrorStream() - Method in class org.ggf.drmaa.FileTransferMode

Whether to transfer error stream files.

getExitStatus() - Method in class com.sun.grid.drmaa.JobInfoImpl

 

getExitStatus() - Method in interface org.ggf.drmaa.JobInfo

If hasExited() returns true, this function returns the exit code that the job passed to _exit() (see exit(2)) or exit(3C)), or the value that the child process returned from its main method.

getFactory() - Static method in class org.ggf.drmaa.SessionFactory

Gets a SessionFactory instance appropriate for the DRM in use.

getGreatestMinimum(int) - Method in class org.ggf.drmaa.PartialTimestamp

Gets the greatest minimum value that the field may ever have.

getHardRunDurationLimit() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Unsupported property.

getHardRunDurationLimit() - Method in interface org.ggf.drmaa.JobTemplate

Gets how long the job may be in a running state before its limit has been exceeded.

getHardRunDurationLimit() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getHardWallclockTimeLimit() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Unsupported property.

getHardWallclockTimeLimit() - Method in interface org.ggf.drmaa.JobTemplate

Gets the duration of the job's wall clock time limit.

getHardWallclockTimeLimit() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getInputPath() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Get the job's standard input path.

getInputPath() - Method in interface org.ggf.drmaa.JobTemplate

Get the job's standard input path.

getInputPath() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getInputStream() - Method in class org.ggf.drmaa.FileTransferMode

Whether to transfer error stream files.

getJobCategory() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Get the opaque string specifying how to resolve site-specific resources and/or policies.

getJobCategory() - Method in interface org.ggf.drmaa.JobTemplate

Get the opaque string specifying how to resolve site-specific resources and/or policies.

getJobCategory() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getJobEnvironment() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Get the environment values that define the remote environment.

getJobEnvironment() - Method in interface org.ggf.drmaa.JobTemplate

Get the environment values that define the remote environment.

getJobEnvironment() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getJobId() - Method in class com.sun.grid.drmaa.JobInfoImpl

 

getJobId() - Method in interface org.ggf.drmaa.JobInfo

Get the id of the finished job.

getJobName() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Get the name of the job.

getJobName() - Method in interface org.ggf.drmaa.JobTemplate

Get the name of the job.

getJobName() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getJobProgramStatus(String) - Method in class com.sun.grid.drmaa.SessionImpl

Get the job programm status.

getJobProgramStatus(String) - Method in interface org.ggf.drmaa.Session

Get the program status of the job identified by jobId.

getJobSubmissionState() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Get the job state at submission.

getJobSubmissionState() - Method in interface org.ggf.drmaa.JobTemplate

Get the job state at submission.

getJobSubmissionState() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getJoinFiles() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Gets whether the error stream should be intermixed with the output stream.

getJoinFiles() - Method in interface org.ggf.drmaa.JobTemplate

Gets whether the error stream should be intermixed with the output stream.

getJoinFiles() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getLeastMaximum(int) - Method in class org.ggf.drmaa.PartialTimestamp

Gets the least maximum value that the field may ever have.

getMajor() - Method in class org.ggf.drmaa.Version

Get the major version number.

getMaximum(int) - Method in class org.ggf.drmaa.PartialTimestamp

Gets the greatest maximum value that the field may ever have.

getMinimum(int) - Method in class org.ggf.drmaa.PartialTimestamp

Gets the least minimum value that the field may ever have.

getMinor() - Method in class org.ggf.drmaa.Version

Get the minor version number.

getModifier(int) - Method in class org.ggf.drmaa.PartialTimestamp

Returns the value of the modifier for the given field.

getNativeSpecification() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Get the opaque string that is passed by the end user to DRMAA to specify site-specific resources and/or policies.

getNativeSpecification() - Method in interface org.ggf.drmaa.JobTemplate

Get the opaque string that is passed by the end user to DRMAA to specify site-specific resources and/or policies.

getNativeSpecification() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getOutputPath() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Gets how to direct the job's standard output.

getOutputPath() - Method in interface org.ggf.drmaa.JobTemplate

Gets how to direct the job's standard output.

getOutputPath() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getOutputStream() - Method in class org.ggf.drmaa.FileTransferMode

Whether to transfer error stream files.

getRemoteCommand() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Get the command string to execute as the job.

getRemoteCommand() - Method in interface org.ggf.drmaa.JobTemplate

Get the command string to execute as the job.

getRemoteCommand() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getResourceUsage() - Method in class com.sun.grid.drmaa.JobInfoImpl

 

getResourceUsage() - Method in interface org.ggf.drmaa.JobInfo

Get the resource usage data for the finished job.

getSession() - Method in class com.sun.grid.drmaa.SessionFactoryImpl

 

getSession() - Method in class org.ggf.drmaa.SessionFactory

Gets a Session instance appropriate for the DRM in use.

getSoftRunDurationLimit() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Unsupported property.

getSoftRunDurationLimit() - Method in interface org.ggf.drmaa.JobTemplate

Gets an estimate as to how long the job will need to remain in a running state to complete.

getSoftRunDurationLimit() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getSoftWallclockTimeLimit() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Unsupported property.

getSoftWallclockTimeLimit() - Method in interface org.ggf.drmaa.JobTemplate

Gets an estimate as to how much wall clock time job will need to complete.

getSoftWallclockTimeLimit() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getStartTime() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Get the earliest time when the job may be eligible to be run.

getStartTime() - Method in interface org.ggf.drmaa.JobTemplate

Get the earliest time when the job may be eligible to be run.

getStartTime() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getTerminatingSignal() - Method in class com.sun.grid.drmaa.JobInfoImpl

If hasSignaled() returns true, this method returns a representation of the signal that caused the termination of the job.

getTerminatingSignal() - Method in interface org.ggf.drmaa.JobInfo

If hasSignaled() returns true, this method returns a representation of the signal that caused the termination of the job.

getTransferFiles() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Gets how to transfer files between hosts.

getTransferFiles() - Method in interface org.ggf.drmaa.JobTemplate

Gets how to transfer files between hosts.

getTransferFiles() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

getVersion() - Method in class com.sun.grid.drmaa.SessionImpl

Returns a Version instance containing the major and minor version numbers of the DRMAA library.

getVersion() - Method in interface org.ggf.drmaa.Session

Returns a Version instance containing the major and minor version numbers of the DRMAA library.

getWorkingDirectory() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Get the directory where the job is executed.

getWorkingDirectory() - Method in interface org.ggf.drmaa.JobTemplate

Get the directory where the job is executed.

getWorkingDirectory() - Method in class org.ggf.drmaa.SimpleJobTemplate

 

H

hasCoreDump() - Method in class com.sun.grid.drmaa.JobInfoImpl

 

hasCoreDump() - Method in interface org.ggf.drmaa.JobInfo

If hasSignaled() returns true, this function returns true if a core image of the terminated job was created.

hasExited() - Method in class com.sun.grid.drmaa.JobInfoImpl

 

hasExited() - Method in interface org.ggf.drmaa.JobInfo

Returns true if the job terminated normally.

hashCode() - Method in class com.sun.grid.drmaa.JobTemplateImpl

Returns a hash code based on the associated native job template's table index.

hashCode() - Method in class org.ggf.drmaa.FileTransferMode

Returns a hash code based on the file transfer properties.

hashCode() - Method in class org.ggf.drmaa.Version

Get a hash code based on the major and minor version numbers.

hasSignaled() - Method in class com.sun.grid.drmaa.JobInfoImpl

 

hasSignaled() - Method in interface org.ggf.drmaa.JobInfo

Returns true if the job terminated due to the receipt of a signal.

HOLD - Static variable in interface org.ggf.drmaa.Session

Put the job on hold.

HOLD_STATE - Static variable in interface org.ggf.drmaa.JobTemplate

Means the job has been queued but it is not eligible to run.

HoldInconsistentStateException - Exception in org.ggf.drmaa

The job is not in a state where it can be held.

HoldInconsistentStateException() - Constructor for exception org.ggf.drmaa.HoldInconsistentStateException

Creates a new instance of HoldInconsistentStateException without detail message.

HoldInconsistentStateException(String) - Constructor for exception org.ggf.drmaa.HoldInconsistentStateException

Constructs an instance of HoldInconsistentStateException with the specified detail message.

HOME_DIRECTORY - Static variable in interface org.ggf.drmaa.JobTemplate

Placeholder which represents the home directory in the workingDirectory, inputPath, outputPath, and errorPath properties

I

InconsistentStateException - Exception in org.ggf.drmaa

The job cannot be moved to the requested state.

InconsistentStateException() - Constructor for exception org.ggf.drmaa.InconsistentStateException

Creates a new instance of InconsistentStateException without detail message.

InconsistentStateException(String) - Constructor for exception org.ggf.drmaa.InconsistentStateException

Constructs an instance of InconsistentStateException with the specified detail message.

init(String) - Method in class com.sun.grid.drmaa.SessionImpl

The init() method initializes the Grid Engine DRMAA API library for all threads of the process and creates a new DRMAA Session.

init(String) - Method in interface org.ggf.drmaa.Session

Initialize the DRMAA implementation.

InternalException - Exception in org.ggf.drmaa

Unexpected or internal DRMAA error like memory allocation, system call failure, etc.

InternalException() - Constructor for exception org.ggf.drmaa.InternalException

Creates a new instance of InternalException without detail message.

InternalException(String) - Constructor for exception org.ggf.drmaa.InternalException

Constructs an instance of InternalException with the specified detail message.

InvalidAttributeFormatException - Exception in org.ggf.drmaa

The format for the property value is invalid.

InvalidAttributeFormatException() - Constructor for exception org.ggf.drmaa.InvalidAttributeFormatException

Creates a new instance of InvalidAttributeFormatException without detail message.

InvalidAttributeFormatException(String) - Constructor for exception org.ggf.drmaa.InvalidAttributeFormatException

Constructs an instance of InvalidAttributeFormatException with the specified detail message.

InvalidAttributeValueException - Exception in org.ggf.drmaa

The value for the property is invalid.

InvalidAttributeValueException() - Constructor for exception org.ggf.drmaa.InvalidAttributeValueException

Creates a new instance of InvalidAttributeValueException without detail message.

InvalidAttributeValueException(String) - Constructor for exception org.ggf.drmaa.InvalidAttributeValueException

Constructs an instance of InvalidAttributeValueException with the specified detail message.

InvalidContactStringException - Exception in org.ggf.drmaa

Initialization failed due to an invalid contact string.

InvalidContactStringException() - Constructor for exception org.ggf.drmaa.InvalidContactStringException

Creates a new instance of InvalidContextStringException without detail message.

InvalidContactStringException(String) - Constructor for exception org.ggf.drmaa.InvalidContactStringException

Constructs an instance of InvalidContextStringException with the specified detail message.

InvalidJobException - Exception in org.ggf.drmaa

The job specified by the given id does not exist.

InvalidJobException() - Constructor for exception org.ggf.drmaa.InvalidJobException

Creates a new instance of InvalidJobException without detail message.

InvalidJobException(String) - Constructor for exception org.ggf.drmaa.InvalidJobException

Constructs an instance of InvalidJobException with the specified detail message.

InvalidJobTemplateException - Exception in org.ggf.drmaa

The JobTemplate object is no longer valid.

InvalidJobTemplateException() - Constructor for exception org.ggf.drmaa.InvalidJobTemplateException

Creates a new instance of InvalidJobException without detail message.

InvalidJobTemplateException(String) - Constructor for exception org.ggf.drmaa.InvalidJobTemplateException

Constructs an instance of InvalidJobException with the specified detail message.

J

JOB_IDS_SESSION_ALL - Static variable in interface org.ggf.drmaa.Session

All jobs submitted during this DRMAA session.

JOB_IDS_SESSION_ANY - Static variable in interface org.ggf.drmaa.Session

Any job from the session.

JobInfo - Interface in org.ggf.drmaa

This interface represents the status and usage information for a finished job.

JobInfoImpl - Class in com.sun.grid.drmaa

This class provides information about a completed Grid Engine job.

JobTemplate - Interface in org.ggf.drmaa

This interface represents a template to be used for the creation of a job.

JobTemplateImpl - Class in com.sun.grid.drmaa

This class represents a remote job and its attributes.

N

NoActiveSessionException - Exception in org.ggf.drmaa

Requested action failed because there is no active session.

NoActiveSessionException() - Constructor for exception org.ggf.drmaa.NoActiveSessionException

Creates a new instance of NoActiveSessionException without detail message.

NoActiveSessionException(String) - Constructor for exception org.ggf.drmaa.NoActiveSessionException

Constructs an instance of NoActiveSessionException with the specified detail message.

NoDefaultContactStringException - Exception in org.ggf.drmaa

No contact string was given to use to connect to the DRM system, and no default contact string is set.

NoDefaultContactStringException() - Constructor for exception org.ggf.drmaa.NoDefaultContactStringException

Creates a new instance of DefaultContactStringException without detail message.

NoDefaultContactStringException(String) - Constructor for exception org.ggf.drmaa.NoDefaultContactStringException

Constructs an instance of DefaultContactStringException with the specified detail message.

O

org.ggf.drmaa - package org.ggf.drmaa

Provides an implementation of the Distributed Resource Management Application API (DRMAA).

P

PARAMETRIC_INDEX - Static variable in interface org.ggf.drmaa.JobTemplate

Placeholder which represents the job id for a job in a parametric job set in the inputPath, outputPath, and errorPath properties

parse(String) - Method in class org.ggf.drmaa.PartialTimestampFormat

Translates a DRMAA specified time string into a PartialTimestamp object.

parse(String, ParsePosition) - Method in class org.ggf.drmaa.PartialTimestampFormat

Translates a DRMAA specified time string into a PartialTimestamp object.

parseObject(String, ParsePosition) - Method in class org.ggf.drmaa.PartialTimestampFormat

Translates a DRMAA specified time string into a PartialTimestamp object.

PartialTimestamp - Class in org.ggf.drmaa

The PartialTimestamp is a subclass of java.util.Calendar that allows for a partially specified time that is resolved to the soonest matching time that is in the future at the time of resolution.

PartialTimestamp() - Constructor for class org.ggf.drmaa.PartialTimestamp

Constructs a default PartialTimestamp instance using the current time in the default time zone with the default locale.

PartialTimestamp(TimeZone) - Constructor for class org.ggf.drmaa.PartialTimestamp

Constructs a PartialTimestamp instance based on the current time in the given time zone with the default locale.

PartialTimestamp(Locale) - Constructor for class org.ggf.drmaa.PartialTimestamp

Constructs a PartialTimestamp instance based on the current time in the default time zone with the given locale.

PartialTimestamp(TimeZone, Locale) - Constructor for class org.ggf.drmaa.PartialTimestamp

Constructs a PartialTimestamp instance based on the current time in the given time zone with the given locale.

PartialTimestamp(int, int, int, int, int) - Constructor for class org.ggf.drmaa.PartialTimestamp

Constructs a PartialTimestamp instance with the given date and time set for the default time zone with the default locale.

PartialTimestamp(int, int, int) - Constructor for class org.ggf.drmaa.PartialTimestamp

Constructs a PartialTimestamp instance with the given date and time set for the default time zone with the default locale.

PartialTimestamp(int, int, int, int, int, int) - Constructor for class org.ggf.drmaa.PartialTimestamp

Constructs a PartialTimestamp instance with the given date and time set for the default time zone with the default locale.

PartialTimestampFormat - Class in org.ggf.drmaa

This class coverts a PartialTimestamp to and from the DRMAA specified time string.

PartialTimestampFormat() - Constructor for class org.ggf.drmaa.PartialTimestampFormat

Creates a new instance of PartialTimestampFormat

Q

QUEUED_ACTIVE - Static variable in interface org.ggf.drmaa.Session

Job is queued and active.

R

RELEASE - Static variable in interface org.ggf.drmaa.Session

Release the hold on the job.

ReleaseInconsistentStateException - Exception in org.ggf.drmaa

The job is not in a state where it can be released.

ReleaseInconsistentStateException() - Constructor for exception org.ggf.drmaa.ReleaseInconsistentStateException

Creates a new instance of ReleaseInconsistentStateException without detail message.

ReleaseInconsistentStateException(String) - Constructor for exception org.ggf.drmaa.ReleaseInconsistentStateException

Constructs an instance of ReleaseInconsistentStateException with the specified detail message.

RESUME - Static variable in interface org.ggf.drmaa.Session

Resume the job.

ResumeInconsistentStateException - Exception in org.ggf.drmaa

The job is not in a state where it can be resumed.

ResumeInconsistentStateException() - Constructor for exception org.ggf.drmaa.ResumeInconsistentStateException

Creates a new instance of ResumeInconsistentStateException without detail message.

ResumeInconsistentStateException(String) - Constructor for exception org.ggf.drmaa.ResumeInconsistentStateException

Constructs an instance of ResumeInconsistentStateException with the specified detail message.

roll(int, boolean) - Method in class org.ggf.drmaa.PartialTimestamp

This method naively rolls the value of the given field by 1, either up or down.

roll(int, int) - Method in class org.ggf.drmaa.PartialTimestamp

This method naively rolls the value of the given field up by the given amount.

runBulkJobs(JobTemplate, int, int, int) - Method in class com.sun.grid.drmaa.SessionImpl

The runBulkJobs() method submits a Grid Engine array job very much as if the qsub option `-t start-end:incr' had been used with the corresponding attributes defined in the DRMAA JobTemplate, jt.

runBulkJobs(JobTemplate, int, int, int) - Method in interface org.ggf.drmaa.Session

Submit a range of parametric jobs, each with attributes defined in the job template, jt.

runJob(JobTemplate) - Method in class com.sun.grid.drmaa.SessionImpl

The runJob() method submits a Grid Engine job with attributes defined in the DRMAA JobTemplate jt.

runJob(JobTemplate) - Method in interface org.ggf.drmaa.Session

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

RUNNING - Static variable in interface org.ggf.drmaa.Session

Job is running.

S

Session - Interface in org.ggf.drmaa

This interface represents the operations available for interacting with the DRM.

SessionFactory - Class in org.ggf.drmaa

This class is used to retrieve a Session instance tailored to the DRM and DRMAA implementation in use.

SessionFactory() - Constructor for class org.ggf.drmaa.SessionFactory

 

SessionFactoryImpl - Class in com.sun.grid.drmaa

This class is used to create a SessionImpl instance.

SessionFactoryImpl() - Constructor for class com.sun.grid.drmaa.SessionFactoryImpl

Creates a new instance of SessionFactoryImpl.

SessionImpl - Class in com.sun.grid.drmaa

The SessionImpl class provides a DRMAA interface to Grid Engine.

set(int, int) - Method in class org.ggf.drmaa.PartialTimestamp

Sets the value of the given field.

setArgs(List) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Specifies the arguments to the job.

setArgs(List) - Method in interface org.ggf.drmaa.JobTemplate

Sets the arguments to the job.

setArgs(List) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setBlockEmail(boolean) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Specifies whether e-mail sending shall blocked or not.

setBlockEmail(boolean) - Method in interface org.ggf.drmaa.JobTemplate

Set whether to block sending e-mail by default, regardless of the DRMS settings.

setBlockEmail(boolean) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setDeadlineTime(PartialTimestamp) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Unsupported property.

setDeadlineTime(PartialTimestamp) - Method in interface org.ggf.drmaa.JobTemplate

Sets a deadline after which the DRMS will terminate the job.

setDeadlineTime(PartialTimestamp) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setEmail(Set) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Set the list of email addresses used to report the job completion and status.

setEmail(Set) - Method in interface org.ggf.drmaa.JobTemplate

Set the list of email addresses used to report the job completion and status.

setEmail(Set) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setErrorPath(String) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Sets how to direct the job's standard error.

setErrorPath(String) - Method in interface org.ggf.drmaa.JobTemplate

Sets how to direct the job's standard error.

setErrorPath(String) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setErrorStream(boolean) - Method in class org.ggf.drmaa.FileTransferMode

Set whether to transfer error stream files.

setHardRunDurationLimit(long) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Unsupported property.

setHardRunDurationLimit(long) - Method in interface org.ggf.drmaa.JobTemplate

Sets how long the job may be in a running state before its limit has been exceeded, and therefore is terminated by the DRMS.

setHardRunDurationLimit(long) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setHardWallclockTimeLimit(long) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Unsupported property.

setHardWallclockTimeLimit(long) - Method in interface org.ggf.drmaa.JobTemplate

Sets when the job's wall clock time limit has been exceeded.

setHardWallclockTimeLimit(long) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setInputPath(String) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Set the job's standard input path.

setInputPath(String) - Method in interface org.ggf.drmaa.JobTemplate

Set the job's standard input path.

setInputPath(String) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setInputStream(boolean) - Method in class org.ggf.drmaa.FileTransferMode

Set whether to transfer error stream files.

setJobCategory(String) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Specifies the DRMAA job category.

setJobCategory(String) - Method in interface org.ggf.drmaa.JobTemplate

Set an opaque string specifying how to resolve site-specific resources and/or policies.

setJobCategory(String) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setJobEnvironment(Map) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Sets the environment values that define the remote environment.

setJobEnvironment(Map) - Method in interface org.ggf.drmaa.JobTemplate

Set the environment values that define the remote environment.

setJobEnvironment(Map) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setJobName(String) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Set the name of the job.

setJobName(String) - Method in interface org.ggf.drmaa.JobTemplate

Set the name of the job.

setJobName(String) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setJobSubmissionState(int) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Specifies the job state at submission.

setJobSubmissionState(int) - Method in interface org.ggf.drmaa.JobTemplate

Set the job state at submission.

setJobSubmissionState(int) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setJoinFiles(boolean) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Sets whether the error stream should be intermixed with the output stream.

setJoinFiles(boolean) - Method in interface org.ggf.drmaa.JobTemplate

Sets whether the error stream should be intermixed with the output stream.

setJoinFiles(boolean) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setModifier(int, int) - Method in class org.ggf.drmaa.PartialTimestamp

Sets the value of the modifier for the given field.

setNativeSpecification(String) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Specifies native qsub options which will be interpreted as part of the DRMAA job template.

setNativeSpecification(String) - Method in interface org.ggf.drmaa.JobTemplate

Set an opaque string that is passed by the end user to DRMAA to specify site-specific resources and/or policies.

setNativeSpecification(String) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setOutputPath(String) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Sets how to direct the job's standard output.

setOutputPath(String) - Method in interface org.ggf.drmaa.JobTemplate

Sets how to direct the job's standard output.

setOutputPath(String) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setOutputStream(boolean) - Method in class org.ggf.drmaa.FileTransferMode

Set whether to transfer error stream files.

setRemoteCommand(String) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Specifies the remote command to execute.

setRemoteCommand(String) - Method in interface org.ggf.drmaa.JobTemplate

Set the command string to execute as the job.

setRemoteCommand(String) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setSoftRunDurationLimit(long) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Unsupported property.

setSoftRunDurationLimit(long) - Method in interface org.ggf.drmaa.JobTemplate

Sets an estimate as to how long the job will need to remain in a running state to complete.

setSoftRunDurationLimit(long) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setSoftWallclockTimeLimit(long) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Unsupported property.

setSoftWallclockTimeLimit(long) - Method in interface org.ggf.drmaa.JobTemplate

Sets an estimate as to how much wall clock time job will need to complete.

setSoftWallclockTimeLimit(long) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setStartTime(PartialTimestamp) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Set the earliest time when the job may be eligible to be run.

setStartTime(PartialTimestamp) - Method in interface org.ggf.drmaa.JobTemplate

Set the earliest time when the job may be eligible to be run.

setStartTime(PartialTimestamp) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setTransferFiles(FileTransferMode) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Set Transfer Files

setTransferFiles(FileTransferMode) - Method in interface org.ggf.drmaa.JobTemplate

Specifies, which of the standard I/O files (stdin, stdout and stderr) are to be transferred to/from the execution host.

setTransferFiles(FileTransferMode) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

setWorkingDirectory(String) - Method in class com.sun.grid.drmaa.JobTemplateImpl

Specifies the directory name where the job will be executed.

setWorkingDirectory(String) - Method in interface org.ggf.drmaa.JobTemplate

Set the directory where the job is executed.

setWorkingDirectory(String) - Method in class org.ggf.drmaa.SimpleJobTemplate

 

SimpleJobTemplate - Class in org.ggf.drmaa

This class is a trivial implementation of the JobTemplate interface.

SimpleJobTemplate() - Constructor for class org.ggf.drmaa.SimpleJobTemplate

Create a new instance of a JobTemplate.

SUSPEND - Static variable in interface org.ggf.drmaa.Session

Suspend the job.

SuspendInconsistentStateException - Exception in org.ggf.drmaa

The job is not in a state where it can be suspended.

SuspendInconsistentStateException() - Constructor for exception org.ggf.drmaa.SuspendInconsistentStateException

Creates a new instance of SuspendInconsistentStateException without detail message.

SuspendInconsistentStateException(String) - Constructor for exception org.ggf.drmaa.SuspendInconsistentStateException

Constructs an instance of SuspendInconsistentStateException with the specified detail message.

synchronize(List, long, boolean) - Method in class com.sun.grid.drmaa.SessionImpl

Wait until all jobs specified by jobIds have finished execution.

synchronize(List, long, boolean) - Method in interface org.ggf.drmaa.Session

Wait until all jobs specified by jobIds have finished execution.

SYSTEM_ON_HOLD - Static variable in interface org.ggf.drmaa.Session

Job is queued and in system hold.

SYSTEM_SUSPENDED - Static variable in interface org.ggf.drmaa.Session

Job is system suspended.

T

TERMINATE - Static variable in interface org.ggf.drmaa.Session

Kill the job.

TIMEOUT_NO_WAIT - Static variable in interface org.ggf.drmaa.Session

Return immediately if no result is available.

TIMEOUT_WAIT_FOREVER - Static variable in interface org.ggf.drmaa.Session

Wait indefinitely for a result.

toString() - Method in class org.ggf.drmaa.FileTransferMode

Returns a string containing the stream settings.

toString() - Method in class org.ggf.drmaa.SimpleJobTemplate

Converts this JobTemplate into a String which contains all property settings.

toString() - Method in class org.ggf.drmaa.Version

Converts this Version object into a printable String.

TryLaterException - Exception in org.ggf.drmaa

Could not submit the job to DRM system at this time.

TryLaterException() - Constructor for exception org.ggf.drmaa.TryLaterException

Creates a new instance of TryLaterException without detail message.

TryLaterException(String) - Constructor for exception org.ggf.drmaa.TryLaterException

Constructs an instance of TryLaterException with the specified detail message.

U

UNDETERMINED - Static variable in interface org.ggf.drmaa.Session

Job status cannot be determined.

UNSET - Static variable in class org.ggf.drmaa.PartialTimestamp

UNSET is the value assigned to fields which have not yet been set.

UnsupportedAttributeException - Exception in org.ggf.drmaa

This exception is thrown when a setter or getter is called for an unsupported optional property.

UnsupportedAttributeException() - Constructor for exception org.ggf.drmaa.UnsupportedAttributeException

Creates a new instance of UnsupportedAttributeException without detail message.

UnsupportedAttributeException(String) - Constructor for exception org.ggf.drmaa.UnsupportedAttributeException

Constructs an instance of UnsupportedAttributeException with the specified detail message.

USER_ON_HOLD - Static variable in interface org.ggf.drmaa.Session

Job is queued and in user hold.

USER_SUSPENDED - Static variable in interface org.ggf.drmaa.Session

Job is user suspended.

USER_SYSTEM_ON_HOLD - Static variable in interface org.ggf.drmaa.Session

Job is queued and in user and system hold.

USER_SYSTEM_SUSPENDED - Static variable in interface org.ggf.drmaa.Session

Job is user suspended.

V

Version - Class in org.ggf.drmaa

This class is used to represent the DRM version info.

Version(int, int) - Constructor for class org.ggf.drmaa.Version

Create a new Version instance

W

wait(String, long) - Method in class com.sun.grid.drmaa.SessionImpl

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

wait(String, long) - Method in interface org.ggf.drmaa.Session

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

wasAborted() - Method in class com.sun.grid.drmaa.JobInfoImpl

 

wasAborted() - Method in interface org.ggf.drmaa.JobInfo

Returns true if the job ended before entering the running state.

WORKING_DIRECTORY - Static variable in interface org.ggf.drmaa.JobTemplate

Placeholder which represents the working directory in the workingDirectory, inputPath, outputPath, and errorPath properties