A B C D E F G H I J M N O P Q R S T U V W

A

ACTIVE - Static variable in class org.ggf.drmaa.JobTemplate
jobSumissionState which means the job has been queued and is eligible to run
AlreadyActiveSessionException - exception org.ggf.drmaa.AlreadyActiveSessionException.
Initialization failed due to existing DRMAA session.
AlreadyActiveSessionException() - Constructor for class org.ggf.drmaa.AlreadyActiveSessionException
Creates a new instance of SessionAlreadyActiveException without detail message.
AlreadyActiveSessionException(String) - Constructor for class org.ggf.drmaa.AlreadyActiveSessionException
Constructs an instance of SessionAlreadyActiveException with the specified detail message.
AuthorizationException - exception org.ggf.drmaa.AuthorizationException.
The specified request is not processed successfully due to an authorization failure.
AuthorizationException() - Constructor for class org.ggf.drmaa.AuthorizationException
Creates a new instance of AuthorizationException without detail message.
AuthorizationException(String) - Constructor for class org.ggf.drmaa.AuthorizationException
Constructs an instance of AuthorizationException with the specified detail message.
add(int, int) - Method in class org.ggf.drmaa.PartialTimestamp
Adds the given value to the given field.
args - Variable in class org.ggf.drmaa.JobTemplate
Input parameters passed as arguments to the job

B

blockEmail - Variable in class org.ggf.drmaa.JobTemplate
Blocks sending e-mail by default, regardless of the DRMS setting

C

CENTURY - Static variable in class org.ggf.drmaa.PartialTimestamp
CENTURY is a field required by the DRMAA timestamp.
ConflictingAttributeValuesException - exception org.ggf.drmaa.ConflictingAttributeValuesException.
The value of this attribute conflicts with the values of one or more previously set attributes.
ConflictingAttributeValuesException() - Constructor for class org.ggf.drmaa.ConflictingAttributeValuesException
Creates a new instance of ConflictingAttributeValuesException without detail message.
ConflictingAttributeValuesException(String) - Constructor for class org.ggf.drmaa.ConflictingAttributeValuesException
Constructs an instance of ConflictingAttributeValuesException with the specified detail message.
category - Variable in class org.ggf.drmaa.JobTemplate
An implementation-defined string specifying how to resolve site-specific resources and/or policies
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
 
com.sun.grid.drmaa - package com.sun.grid.drmaa
Provides a DRMAA implementation for the N1[TM] Grid Engine software.
computeFields() - Method in class org.ggf.drmaa.PartialTimestamp
This method is called directly after the internal time in milliseconds is set.
computeTime() - Method in class org.ggf.drmaa.PartialTimestamp
This method uses the set fields and the current time to calculate the soonest time in milliseconds for this PartialTimestamp object which is in the future.
control(String, int) - Method in class com.sun.grid.drmaa.SessionImpl
Hold, release, suspend, resume, or kill the job identified by jobId.
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

DONE - Static variable in interface org.ggf.drmaa.Session
Job has finished normally
DefaultContactStringException - exception org.ggf.drmaa.DefaultContactStringException.
DRMAA could not use the default contact string to connect to the DRM system.
DefaultContactStringException() - Constructor for class org.ggf.drmaa.DefaultContactStringException
Creates a new instance of DefaultContactStringException without detail message.
DefaultContactStringException(String) - Constructor for class org.ggf.drmaa.DefaultContactStringException
Constructs an instance of DefaultContactStringException with the specified detail message.
DeniedByDrmException - exception org.ggf.drmaa.DeniedByDrmException.
The DRM system rejected the job.
DeniedByDrmException() - Constructor for class org.ggf.drmaa.DeniedByDrmException
Creates a new instance of DeniedByDrmException without detail message.
DeniedByDrmException(String) - Constructor for class org.ggf.drmaa.DeniedByDrmException
Constructs an instance of DeniedByDrmException with the specified detail message.
DrmCommunicationException - exception org.ggf.drmaa.DrmCommunicationException.
Could not contact DRM system for this request.
DrmCommunicationException() - Constructor for class org.ggf.drmaa.DrmCommunicationException
Creates a new instance of CommunicationException without detail message.
DrmCommunicationException(String) - Constructor for class org.ggf.drmaa.DrmCommunicationException
Constructs an instance of CommunicationException with the specified detail message.
DrmaaException - exception org.ggf.drmaa.DrmaaException.
The base class for all caught DRMAA Exceptions.
DrmaaException() - Constructor for class org.ggf.drmaa.DrmaaException
Creates a new instance of DrmaaException without detail message.
DrmaaException(String) - Constructor for class org.ggf.drmaa.DrmaaException
Constructs an instance of DrmaaException with the specified detail message.
DrmaaRuntimeException - exception org.ggf.drmaa.DrmaaRuntimeException.
The base class for all uncaught DRMAA Exceptions.
DrmaaRuntimeException() - Constructor for class org.ggf.drmaa.DrmaaRuntimeException
Creates a new instance of DrmaaRuntimeException without detail message.
DrmaaRuntimeException(String) - Constructor for class org.ggf.drmaa.DrmaaRuntimeException
Constructs an instance of DrmaaRuntimeException with the specified detail message.
DrmsExitException - exception org.ggf.drmaa.DrmsExitException.
DRM system disengagement failed.
DrmsExitException() - Constructor for class org.ggf.drmaa.DrmsExitException
Creates a new instance of DrmsExitException without detail message.
DrmsExitException(String) - Constructor for class org.ggf.drmaa.DrmsExitException
Constructs an instance of DrmsExitException with the specified detail message.
DrmsInitException - exception org.ggf.drmaa.DrmsInitException.
DRM system initialization failed.
DrmsInitException() - Constructor for class org.ggf.drmaa.DrmsInitException
Creates a new instance of DrmsInitException without detail message.
DrmsInitException(String) - Constructor for class org.ggf.drmaa.DrmsInitException
Constructs an instance of DrmsInitException with the specified detail message.
deleteJobTemplate(JobTemplate) - Method in class com.sun.grid.drmaa.SessionImpl
The deleteJobTemplate() method releases all resources associated with the DRMAA JobTemplate.
deleteJobTemplate(JobTemplate) - Method in interface org.ggf.drmaa.Session
Deallocate a job template.

E

ExitTimeoutException - exception org.ggf.drmaa.ExitTimeoutException.
We have encountered a time-out condition for DRMAASession.synchronize() or DRMAASession.wait().
ExitTimeoutException() - Constructor for class org.ggf.drmaa.ExitTimeoutException
Creates a new instance of ExitTimeoutException without detail message.
ExitTimeoutException(String) - Constructor for class org.ggf.drmaa.ExitTimeoutException
Constructs an instance of ExitTimeoutException with the specified detail message.
email - Variable in class org.ggf.drmaa.JobTemplate
E-mail addresses used to report the job completion and status
env - Variable in class org.ggf.drmaa.JobTemplate
The environment values that define the job's remote environment
equals(Object) - Method in class com.sun.grid.drmaa.JobTemplateImpl
Tests whether this JobTemplateImpl represents the same 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.
errorPath - Variable in class org.ggf.drmaa.JobTemplate
The job's standard error stream
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 DRM and allow the DRMAA implementation to perform any necessary internal cleanup.

F

FAILED - Static variable in interface org.ggf.drmaa.Session
Job finished, but terminated abnormally
FileTransferMode - class org.ggf.drmaa.FileTransferMode.
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 parameters passed as arguments to the job.
getArgs() - Method in class org.ggf.drmaa.JobTemplate
Get The parameters passed as arguments to the job.
getAttributeNames() - Method in class com.sun.grid.drmaa.JobTemplateImpl
Returns the list of supported properties names.
getAttributeNames() - Method in class org.ggf.drmaa.JobTemplate
Returns the list of supported property names.
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 class org.ggf.drmaa.JobTemplate
Get whether to block sending e-mail by default, regardless of the DRMS settings.
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 org.ggf.drmaa.JobTemplate
Sets a deadline after which the DRMS will terminate the job.
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 DRM systems, one element per DRM system implementation provided.
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 DRMAA implementations, one element for each DRMAA implementation provided.
getEmail() - Method in class org.ggf.drmaa.JobTemplate
Get the list of email addresses used to report the job completion and status.
getEmailAddresses() - Method in class com.sun.grid.drmaa.JobTemplateImpl
Get the list of email addresses used to report the job completion and status.
getErrorPath() - Method in class com.sun.grid.drmaa.JobTemplateImpl
Gets how to direct the job's standard error.
getErrorPath() - Method in class org.ggf.drmaa.JobTemplate
Gets how to direct the job's standard error.
getErrorStream() - Method in class org.ggf.drmaa.FileTransferMode
Whether to transfer error stream files.
getExitStatus() - Method in class com.sun.grid.drmaa.JobInfoImpl
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 main.
getExitStatus() - Method in class 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 main.
getFactory() - Static method in class org.ggf.drmaa.SessionFactory
Gets a SessionFactory object 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 org.ggf.drmaa.JobTemplate
Gets how long the job may be in a running state before its limit has been exceeded, and therefore is terminated by the DRMS.
getHardWallclockTimeLimit() - Method in class org.ggf.drmaa.JobTemplate
Gets the duration of the job's wall clock time limit.
getInputPath() - Method in class com.sun.grid.drmaa.JobTemplateImpl
Get the job's standard input path.
getInputPath() - Method in class org.ggf.drmaa.JobTemplate
Get the job's standard input path.
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 class org.ggf.drmaa.JobTemplate
Get the opaque string specifying how to resolve site-specific resources and/or policies.
getJobEnvironment() - Method in class com.sun.grid.drmaa.JobTemplateImpl
Get the environment values that define the remote environment.
getJobEnvironment() - Method in class org.ggf.drmaa.JobTemplate
Get the environment values that define the remote environment.
getJobId() - Method in class org.ggf.drmaa.JobInfo
Get the job id.
getJobName() - Method in class com.sun.grid.drmaa.JobTemplateImpl
Get the name of the job.
getJobName() - Method in class org.ggf.drmaa.JobTemplate
Get the name of the job.
getJobProgramStatus(String) - Method in class com.sun.grid.drmaa.SessionImpl
Get the program status of the job identified by jobId.
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 class org.ggf.drmaa.JobTemplate
Get the job state at submission.
getJoinFiles() - Method in class com.sun.grid.drmaa.JobTemplateImpl
Gets whether the error stream should be intermixed with the output stream.
getJoinFiles() - Method in class org.ggf.drmaa.JobTemplate
Gets whether the error stream should be intermixed with the output stream.
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 class 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.
getOptionalAttributeNames() - Method in class org.ggf.drmaa.JobTemplate
This method returns the names of all optional and implementation-specific properties supported by this DRMAA implementation.
getOutputPath() - Method in class com.sun.grid.drmaa.JobTemplateImpl
Gets how to direct the job's standard output.
getOutputPath() - Method in class org.ggf.drmaa.JobTemplate
Gets how to direct the job's standard output.
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 to execute as the job.
getRemoteCommand() - Method in class org.ggf.drmaa.JobTemplate
Get the command string to execute as the job.
getResourceUsage() - Method in class org.ggf.drmaa.JobInfo
Get the resource usage data.
getSession() - Method in class com.sun.grid.drmaa.SessionFactoryImpl
Gets a SessionImpl object.
getSession() - Method in class org.ggf.drmaa.SessionFactory
Gets a Session object appropriate for the DRM in use.
getSoftRunDurationLimit() - Method in class org.ggf.drmaa.JobTemplate
Gets an estimate as to how long the job will need to remain in a running state to complete.
getSoftWallclockTimeLimit() - Method in class org.ggf.drmaa.JobTemplate
Gets an estimate as to how much wall clock time job will need to complete.
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 class org.ggf.drmaa.JobTemplate
Get the earliest time when the job may be eligible to be run.
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 class org.ggf.drmaa.JobInfo
If hasSignaled() returns true, this 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 class org.ggf.drmaa.JobTemplate
Gets how to transfer files between hosts.
getVersion() - Method in class com.sun.grid.drmaa.SessionImpl
The getVersion() method returns a Version object containing the major and minor version numbers of the DRMAA library.
getVersion() - Method in interface org.ggf.drmaa.Session
Returns a Version object containing the major and minor version numbers of the DRMAA library.
getWorkingDirectory() - Method in class com.sun.grid.drmaa.JobTemplateImpl
Get the directory name where the job will be executed.
getWorkingDirectory() - Method in class org.ggf.drmaa.JobTemplate
Get the directory where the job is executed.

H

HOLD - Static variable in class org.ggf.drmaa.JobTemplate
jobSubmissionState which means the job has been queued but it is not eligible to run
HOLD - Static variable in interface org.ggf.drmaa.Session
Put the job on hold
HOME_DIRECTORY - Static variable in class org.ggf.drmaa.JobTemplate
Placeholder which represents the home directory in the workingDirectory, inputPath, outputPath, and errorPath properties
HoldInconsistentStateException - exception org.ggf.drmaa.HoldInconsistentStateException.
The job is not in a state where it can be held.
HoldInconsistentStateException() - Constructor for class org.ggf.drmaa.HoldInconsistentStateException
Creates a new instance of HoldInconsistentStateException without detail message.
HoldInconsistentStateException(String) - Constructor for class org.ggf.drmaa.HoldInconsistentStateException
Constructs an instance of HoldInconsistentStateException with the specified detail message.
hasCoreDump() - Method in class com.sun.grid.drmaa.JobInfoImpl
If hasSignaled() returns true, this function returns true if a core image of the terminated job was created.
hasCoreDump() - Method in class 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
Returns true if the job terminated normally.
hasExited() - Method in class org.ggf.drmaa.JobInfo
Returns true if the job terminated normally.
hasSignaled() - Method in class com.sun.grid.drmaa.JobInfoImpl
Returns true if the job terminated due to the receipt of a signal.
hasSignaled() - Method in class org.ggf.drmaa.JobInfo
Returns true if the job terminated due to the receipt of a signal.
hashCode() - Method in class com.sun.grid.drmaa.JobTemplateImpl
Returns a hash code based on the id used to associate this JobTemplateImpl with its native peer.
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.

I

InconsistentStateException - exception org.ggf.drmaa.InconsistentStateException.
The job cannot be moved to the requested state.
InconsistentStateException() - Constructor for class org.ggf.drmaa.InconsistentStateException
Creates a new instance of InconsistentStateException without detail message.
InconsistentStateException(String) - Constructor for class org.ggf.drmaa.InconsistentStateException
Constructs an instance of InconsistentStateException with the specified detail message.
InternalException - exception org.ggf.drmaa.InternalException.
Unexpected or internal DRMAA error like memory allocation, system call failure, etc.
InternalException() - Constructor for class org.ggf.drmaa.InternalException
Creates a new instance of InternalException without detail message.
InternalException(String) - Constructor for class org.ggf.drmaa.InternalException
Constructs an instance of InternalException with the specified detail message.
InvalidArgumentException - exception org.ggf.drmaa.InvalidArgumentException.
The input value for an argument is invalid.
InvalidArgumentException() - Constructor for class org.ggf.drmaa.InvalidArgumentException
Creates a new instance of InvalidArgumentException without detail message.
InvalidArgumentException(String) - Constructor for class org.ggf.drmaa.InvalidArgumentException
Constructs an instance of InvalidArgumentException with the specified detail message.
InvalidAttributeException - exception org.ggf.drmaa.InvalidAttributeException.
The value or format of an attribute is invalid.
InvalidAttributeException() - Constructor for class org.ggf.drmaa.InvalidAttributeException
Creates a new instance of AttributeException without detail message.
InvalidAttributeException(String) - Constructor for class org.ggf.drmaa.InvalidAttributeException
Constructs an instance of AttributeException with the specified detail message.
InvalidAttributeFormatException - exception org.ggf.drmaa.InvalidAttributeFormatException.
The format for the attribute value is invalid.
InvalidAttributeFormatException() - Constructor for class org.ggf.drmaa.InvalidAttributeFormatException
Creates a new instance of InvalidAttributeFormatException without detail message.
InvalidAttributeFormatException(String) - Constructor for class org.ggf.drmaa.InvalidAttributeFormatException
Constructs an instance of InvalidAttributeFormatException with the specified detail message.
InvalidAttributeValueException - exception org.ggf.drmaa.InvalidAttributeValueException.
The value for the attribute is invalid.
InvalidAttributeValueException() - Constructor for class org.ggf.drmaa.InvalidAttributeValueException
Creates a new instance of InvalidAttributeValueException without detail message.
InvalidAttributeValueException(String) - Constructor for class org.ggf.drmaa.InvalidAttributeValueException
Constructs an instance of InvalidAttributeValueException with the specified detail message.
InvalidContactStringException - exception org.ggf.drmaa.InvalidContactStringException.
Initialization failed due to an invalid contact string.
InvalidContactStringException() - Constructor for class org.ggf.drmaa.InvalidContactStringException
Creates a new instance of InvalidContextStringException without detail message.
InvalidContactStringException(String) - Constructor for class org.ggf.drmaa.InvalidContactStringException
Constructs an instance of InvalidContextStringException with the specified detail message.
InvalidJobException - exception org.ggf.drmaa.InvalidJobException.
The job specified by the given id does not exist.
InvalidJobException() - Constructor for class org.ggf.drmaa.InvalidJobException
Creates a new instance of InvalidJobException without detail message.
InvalidJobException(String) - Constructor for class org.ggf.drmaa.InvalidJobException
Constructs an instance of InvalidJobException with the specified detail message.
InvalidJobTemplateException - exception org.ggf.drmaa.InvalidJobTemplateException.
The JobTemplate object is no longer valid.
InvalidJobTemplateException() - Constructor for class org.ggf.drmaa.InvalidJobTemplateException
Creates a new instance of InvalidJobException without detail message.
InvalidJobTemplateException(String) - Constructor for class org.ggf.drmaa.InvalidJobTemplateException
Constructs an instance of InvalidJobException 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.
inputPath - Variable in class org.ggf.drmaa.JobTemplate
The job's standard input stream

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 - class org.ggf.drmaa.JobInfo.
The class represents the status and usage information for a finished job.
JobInfo(String, int, Map) - Constructor for class org.ggf.drmaa.JobInfo
Creates a new instance of JobInfo
JobInfoImpl - class com.sun.grid.drmaa.JobInfoImpl.
This class provides information about a completed Grid Engine job.
JobTemplate - class org.ggf.drmaa.JobTemplate.
This class represents a template to be used for the creation of a job.
JobTemplate() - Constructor for class org.ggf.drmaa.JobTemplate
 
JobTemplateImpl - class com.sun.grid.drmaa.JobTemplateImpl.
This class represents a remote job and its attributes.
jobId - Variable in class org.ggf.drmaa.JobInfo
the id of the job this class describes
join - Variable in class org.ggf.drmaa.JobTemplate
Whether the error stream should be intermixed with the output stream

M

myInternalSet(int, int) - Method in class org.ggf.drmaa.PartialTimestamp
Sets the value of the given field.

N

NoActiveSessionException - exception org.ggf.drmaa.NoActiveSessionException.
Requested action failed because there is no active session.
NoActiveSessionException() - Constructor for class org.ggf.drmaa.NoActiveSessionException
Creates a new instance of NoActiveSessionException without detail message.
NoActiveSessionException(String) - Constructor for class org.ggf.drmaa.NoActiveSessionException
Constructs an instance of NoActiveSessionException with the specified detail message.
NoDefaultContactStringException - exception org.ggf.drmaa.NoDefaultContactStringException.
No default contact string was given to use to connect to the DRM system.
NoDefaultContactStringException() - Constructor for class org.ggf.drmaa.NoDefaultContactStringException
Creates a new instance of DefaultContactStringException without detail message.
NoDefaultContactStringException(String) - Constructor for class org.ggf.drmaa.NoDefaultContactStringException
Constructs an instance of DefaultContactStringException with the specified detail message.
NoResourceUsageException - exception org.ggf.drmaa.NoResourceUsageException.
Thrown by Session.wait() when a job has finished but no resource usage information and exit status data could be provided.
NoResourceUsageException() - Constructor for class org.ggf.drmaa.NoResourceUsageException
Creates a new instance of NoResourceUsageInformationException without detail message.
NoResourceUsageException(String) - Constructor for class org.ggf.drmaa.NoResourceUsageException
Constructs an instance of NoResourceUsageInformationException with the specified detail message.
name - Variable in class org.ggf.drmaa.JobTemplate
Job name

O

org.ggf.drmaa - package org.ggf.drmaa
Provides an implementation of the Distributed Resource Management Application API (DRMAA).
outputPath - Variable in class org.ggf.drmaa.JobTemplate
The job's standard output stream

P

PARAMETRIC_INDEX - Static variable in class org.ggf.drmaa.JobTemplate
Placeholder which represents the task id for a task in a parametric job in the workingDirectory, inputPath, outputPath, and errorPath properties
PartialTimestamp - class org.ggf.drmaa.PartialTimestamp.
The PartialTimestamp is a subclass of java.util.Calendar which allows for a partially specified time that is resolved as the soonest matching time that is in the future as the time of resolution.
PartialTimestamp() - Constructor for class org.ggf.drmaa.PartialTimestamp
Constructs a default GregorianCalendar using the current time in the default time zone with the default locale.
PartialTimestamp(TimeZone) - Constructor for class org.ggf.drmaa.PartialTimestamp
Constructs a GregorianCalendar 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 GregorianCalendar 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 GregorianCalendar 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 GregorianCalendar 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 GregorianCalendar 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 GregorianCalendar with the given date and time set for the default time zone with the default locale.
PartialTimestampFormat - class org.ggf.drmaa.PartialTimestampFormat.
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
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.

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
RESUME - Static variable in interface org.ggf.drmaa.Session
Resume the job
RUNNING - Static variable in interface org.ggf.drmaa.Session
Job is running
ReleaseInconsistentStateException - exception org.ggf.drmaa.ReleaseInconsistentStateException.
The job is not in a state where it can be released.
ReleaseInconsistentStateException() - Constructor for class org.ggf.drmaa.ReleaseInconsistentStateException
Creates a new instance of ReleaseInconsistentStateException without detail message.
ReleaseInconsistentStateException(String) - Constructor for class org.ggf.drmaa.ReleaseInconsistentStateException
Constructs an instance of ReleaseInconsistentStateException with the specified detail message.
ResumeInconsistentStateException - exception org.ggf.drmaa.ResumeInconsistentStateException.
The job is not in a state where it can be resumed.
ResumeInconsistentStateException() - Constructor for class org.ggf.drmaa.ResumeInconsistentStateException
Creates a new instance of ResumeInconsistentStateException without detail message.
ResumeInconsistentStateException(String) - Constructor for class org.ggf.drmaa.ResumeInconsistentStateException
Constructs an instance of ResumeInconsistentStateException with the specified detail message.
remoteCommand - Variable in class org.ggf.drmaa.JobTemplate
Remote command to execute
resourceUsage - Variable in class org.ggf.drmaa.JobInfo
a Map of resource usage data
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 set of parametric jobs, dependent on the implied loop index, 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.

S

SUSPEND - Static variable in interface org.ggf.drmaa.Session
Suspend the job
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
Session - interface org.ggf.drmaa.Session.
This interface represents a the operations available for interacting with the DRM.
SessionException - exception org.ggf.drmaa.SessionException.
A problem occured with the DRM session preventing the routine from completing.
SessionException() - Constructor for class org.ggf.drmaa.SessionException
Creates a new instance of SessionException without detail message.
SessionException(String) - Constructor for class org.ggf.drmaa.SessionException
Constructs an instance of SessionException with the specified detail message.
SessionFactory - class org.ggf.drmaa.SessionFactory.
This class is used to retrieve a Session object tailored to the DRM in use.
SessionFactory() - Constructor for class org.ggf.drmaa.SessionFactory
Creates a new instance of SessionFactory
SessionFactoryImpl - class com.sun.grid.drmaa.SessionFactoryImpl.
This class is used to create a SessionImpl object.
SessionFactoryImpl() - Constructor for class com.sun.grid.drmaa.SessionFactoryImpl
Creates a new instance of SessionFactoryImpl.
SessionImpl - class com.sun.grid.drmaa.SessionImpl.
The SessionImpl provides a DRMAA interface to Grid Engine.
SuspendInconsistentStateException - exception org.ggf.drmaa.SuspendInconsistentStateException.
The job is not in a state where it can be suspended.
SuspendInconsistentStateException() - Constructor for class org.ggf.drmaa.SuspendInconsistentStateException
Creates a new instance of SuspendInconsistentStateException without detail message.
SuspendInconsistentStateException(String) - Constructor for class org.ggf.drmaa.SuspendInconsistentStateException
Constructs an instance of SuspendInconsistentStateException with the specified detail message.
set(int, int) - Method in class org.ggf.drmaa.PartialTimestamp
Sets the value of the given field<.
setArgs(String[]) - Method in class com.sun.grid.drmaa.JobTemplateImpl
Set the parameters passed as arguments to the job.
setArgs(String[]) - Method in class org.ggf.drmaa.JobTemplate
Set the parameters passed as arguments to the job.
setBlockEmail(boolean) - Method in class com.sun.grid.drmaa.JobTemplateImpl
Specifies whether e-mail sending shall blocked or not.
setBlockEmail(boolean) - Method in class org.ggf.drmaa.JobTemplate
Set whether to block sending e-mail by default, regardless of the DRMS settings.
setDeadlineTime(PartialTimestamp) - Method in class org.ggf.drmaa.JobTemplate
Sets a deadline after which the DRMS will terminate the job.
setEmail(String[]) - Method in class org.ggf.drmaa.JobTemplate
Set the list of email addresses used to report the job completion and status.
setEmailAddresses(String[]) - Method in class com.sun.grid.drmaa.JobTemplateImpl
Set the list of email addresses used to report the job completion and status.
setErrorPath(String) - Method in class com.sun.grid.drmaa.JobTemplateImpl
Sets how to direct the job's standard error.
setErrorPath(String) - Method in class org.ggf.drmaa.JobTemplate
Sets how to direct the job's standard error.
setErrorStream(boolean) - Method in class org.ggf.drmaa.FileTransferMode
Set whether to transfer error stream files.
setHardRunDurationLimit(long) - Method in class 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.
setHardWallclockTimeLimit(long) - Method in class org.ggf.drmaa.JobTemplate
Sets when the job's wall clock time limit has been exceeded.
setInputPath(String) - Method in class com.sun.grid.drmaa.JobTemplateImpl
Set the job's standard input path.
setInputPath(String) - Method in class org.ggf.drmaa.JobTemplate
Set the job's standard input path.
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 class org.ggf.drmaa.JobTemplate
Set an opaque string specifying how to resolve site-specific resources and/or policies.
setJobEnvironment(Properties) - Method in class com.sun.grid.drmaa.JobTemplateImpl
Set the environment values that define the remote environment.
setJobEnvironment(Properties) - Method in class org.ggf.drmaa.JobTemplate
Set the environment values that define the remote environment.
setJobName(String) - Method in class com.sun.grid.drmaa.JobTemplateImpl
Set the name of the job.
setJobName(String) - Method in class org.ggf.drmaa.JobTemplate
Set the name of the job.
setJobSubmissionState(int) - Method in class com.sun.grid.drmaa.JobTemplateImpl
Specifies the job state at submission.
setJobSubmissionState(int) - Method in class org.ggf.drmaa.JobTemplate
Set the job state at submission.
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 class org.ggf.drmaa.JobTemplate
Sets whether the error stream should be intermixed with the output stream.
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 class 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.
setOutputPath(String) - Method in class com.sun.grid.drmaa.JobTemplateImpl
Sets how to direct the job's standard output.
setOutputPath(String) - Method in class org.ggf.drmaa.JobTemplate
Sets how to direct the job's standard output.
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 class org.ggf.drmaa.JobTemplate
Set the command string to execute as the job.
setSoftRunDurationLimit(long) - Method in class org.ggf.drmaa.JobTemplate
Sets an estimate as to how long the job will need to remain in a running state to complete.
setSoftWallclockTimeLimit(long) - Method in class org.ggf.drmaa.JobTemplate
Sets an estimate as to how much wall clock time job will need to complete.
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 class org.ggf.drmaa.JobTemplate
Set the earliest time when the job may be eligible to be run.
setTransferFiles(FileTransferMode) - Method in class com.sun.grid.drmaa.JobTemplateImpl
Sets how to transfer files between hosts.
setTransferFiles(FileTransferMode) - Method in class org.ggf.drmaa.JobTemplate
Sets how to transfer files between hosts.
setWorkingDirectory(String) - Method in class com.sun.grid.drmaa.JobTemplateImpl
Specifies the directory name where the job will be executed.
setWorkingDirectory(String) - Method in class org.ggf.drmaa.JobTemplate
Set the directory where the job is executed.
spec - Variable in class org.ggf.drmaa.JobTemplate
An implementation-defined string that is passed by the end user to DRMAA to specify site-specific resources and/or policies
startTime - Variable in class org.ggf.drmaa.JobTemplate
The earliest time when the job may be eligible to be run
state - Variable in class org.ggf.drmaa.JobTemplate
Job state at submission, either HOLD or ACTIVE
status - Variable in class org.ggf.drmaa.JobInfo
the exit status code for the job
synchronize(List, long, boolean) - Method in class com.sun.grid.drmaa.SessionImpl
The synchronize() method blocks the calling thread until all jobs specified in jobIds have failed or finished execution.
synchronize(List, long, boolean) - Method in interface org.ggf.drmaa.Session
Wait until all jobs specified by jobIds have finished execution.

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
TryLaterException - exception org.ggf.drmaa.TryLaterException.
Could not submit the job to DRM system at this time.
TryLaterException() - Constructor for class org.ggf.drmaa.TryLaterException
Creates a new instance of TryLaterException without detail message.
TryLaterException(String) - Constructor for class org.ggf.drmaa.TryLaterException
Constructs an instance of TryLaterException with the specified detail message.
toString() - Method in class org.ggf.drmaa.FileTransferMode
Returns a string containing the stream settings.
toString() - Method in class org.ggf.drmaa.JobTemplate
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.

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.
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
UnsupportedAttributeException - exception org.ggf.drmaa.UnsupportedAttributeException.
This exception is thrown when a setter or getter is called for an unsupported optional attribute.
UnsupportedAttributeException() - Constructor for class org.ggf.drmaa.UnsupportedAttributeException
Creates a new instance of UnsupportedAttributeException without detail message.
UnsupportedAttributeException(String) - Constructor for class org.ggf.drmaa.UnsupportedAttributeException
Constructs an instance of UnsupportedAttributeException with the specified detail message.

V

Version - class org.ggf.drmaa.Version.
Class used to represent the DRM version info
Version(int, int) - Constructor for class org.ggf.drmaa.Version
Create a new Version object

W

WORKING_DIRECTORY - Static variable in class org.ggf.drmaa.JobTemplate
Placeholder which represents the working directory in the workingDirectory, inputPath, outputPath, and errorPath properties
wait(String, long) - Method in class com.sun.grid.drmaa.SessionImpl
The wait() function blocks the calling thread until a job fails or finishes execution.
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
Returns true if the job ended before entering the running state.
wasAborted() - Method in class org.ggf.drmaa.JobInfo
Returns true if the job ended before entering the running state.
wd - Variable in class org.ggf.drmaa.JobTemplate
The directory where the job is executed.

A B C D E F G H I J M N O P Q R S T U V W