- getAbsolutePath() - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Return a String
representation of this RelativePath interpreted as an absolute path.
- getAdaptorName() - Method in interface nl.esciencecenter.xenon.credentials.Credential
-
Get the name of the adaptor that created this Credential.
- getAdaptorName() - Method in interface nl.esciencecenter.xenon.files.FileSystem
-
Get the name of the adaptor that created this FileSystem.
- getAdaptorName() - Method in interface nl.esciencecenter.xenon.jobs.Scheduler
-
Get the name of the adaptor that created this Scheduler.
- getAdaptorSpecificInformation() - Method in interface nl.esciencecenter.xenon.AdaptorStatus
-
Returns a map containing adaptor specific status information.
- getAdaptorStatus(String) - Method in interface nl.esciencecenter.xenon.Xenon
-
Returns information about the specified adaptor.
- getAdaptorStatuses() - Method in interface nl.esciencecenter.xenon.Xenon
-
Returns information on all adaptors available to this Xenon.
- getArguments() - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Get the command line arguments of the executable.
- getArguments() - Method in class nl.esciencecenter.xenon.util.JavaJobDescription
-
Constructs the command line arguments from the class path, the JVM options, the system properties, the main and the java
arguments.
- getArguments(char) - Method in class nl.esciencecenter.xenon.util.JavaJobDescription
-
Constructs the command line arguments from the class path, the JVM options, the system properties, the main and the java
arguments.
- getAttributes(Path) - Method in interface nl.esciencecenter.xenon.files.Files
-
- getCopy() - Method in interface nl.esciencecenter.xenon.files.CopyStatus
-
Get the Copy for which this CopyStatus was created.
- getCopyStatus(Copy) - Method in interface nl.esciencecenter.xenon.files.Files
-
Retrieve the status of an asynchronous copy.
- getCWD() - Static method in class nl.esciencecenter.xenon.util.Utils
-
Return the current working directory as a String.
- getDefaultCredential(String) - Method in interface nl.esciencecenter.xenon.credentials.Credentials
-
Creates a default credential for the given scheme.
- getDefaultQueueName(Scheduler) - Method in interface nl.esciencecenter.xenon.jobs.Jobs
-
Get the name of the default queue for the scheduler
.
- getDefaultValue() - Method in interface nl.esciencecenter.xenon.XenonPropertyDescription
-
Returns the default value for this property.
- getDescription() - Method in interface nl.esciencecenter.xenon.AdaptorStatus
-
Get the description of the adaptor.
- getDescription() - Method in interface nl.esciencecenter.xenon.XenonPropertyDescription
-
Returns a human readable description of this property.
- getDestination() - Method in class nl.esciencecenter.xenon.util.Sandbox.Pair
-
- getDownloadFiles() - Method in class nl.esciencecenter.xenon.util.Sandbox
-
Returns the list of files that will be downloaded when calling
download
.
- getEntryPath() - Method in interface nl.esciencecenter.xenon.files.FileSystem
-
Get the entry path of this file system.
- getEnvironment() - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Get the environment of the executable.
- getException() - Method in interface nl.esciencecenter.xenon.files.CopyStatus
-
Get the exception produced by the Copy or while retrieving the status.
- getException() - Method in interface nl.esciencecenter.xenon.jobs.JobStatus
-
Get the exception produced by the Job or while retrieving the status.
- getException() - Method in interface nl.esciencecenter.xenon.jobs.QueueStatus
-
Get the exception produced by the queue, or null
if hasException()
returns false
.
- getExecutable() - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Get the path to the executable.
- getExecutable() - Method in class nl.esciencecenter.xenon.util.JavaJobDescription
-
Returns the executable.
- getExitCode() - Method in interface nl.esciencecenter.xenon.jobs.JobStatus
-
Get the exit code for the Job.
- getFileName() - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Get the file name, or null
if the RelativePath is empty.
- getFileNameAsString() - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Get the file name as a String
, or null
if the RelativePath is empty.
- getFileSystem() - Method in interface nl.esciencecenter.xenon.files.Path
-
Get the FileSystem to which this Path refers.
- getHome() - Static method in class nl.esciencecenter.xenon.util.Utils
-
Return the home directory of the current user as a String.
- getIdentifier() - Method in interface nl.esciencecenter.xenon.jobs.Job
-
Returns the identifier that was assigned to this job by the scheduler.
- getJavaArguments() - Method in class nl.esciencecenter.xenon.util.JavaJobDescription
-
Returns the arguments for the main class.
- getJavaClasspath() - Method in class nl.esciencecenter.xenon.util.JavaJobDescription
-
Returns the java class path.
- getJavaMain() - Method in class nl.esciencecenter.xenon.util.JavaJobDescription
-
Returns the main class of the java application.
- getJavaOptions() - Method in class nl.esciencecenter.xenon.util.JavaJobDescription
-
Returns the JVM options.
- getJavaSystemProperties() - Method in class nl.esciencecenter.xenon.util.JavaJobDescription
-
Returns the java system properties.
- getJob() - Method in interface nl.esciencecenter.xenon.jobs.JobStatus
-
Get the job for which this JobStatus was created.
- getJob() - Method in interface nl.esciencecenter.xenon.jobs.Streams
-
Get the job for which this Streams was created.
- getJobDescription() - Method in interface nl.esciencecenter.xenon.jobs.Job
-
- getJobOptions() - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Get a copy of the job options of this job.
- getJobs(Scheduler, String...) - Method in interface nl.esciencecenter.xenon.jobs.Jobs
-
Get all jobs currently in (one ore more) queues of scheduler
.
- getJobStatus(Job) - Method in interface nl.esciencecenter.xenon.jobs.Jobs
-
Get the status of a Job.
- getJobStatuses(Job...) - Method in interface nl.esciencecenter.xenon.jobs.Jobs
-
Get the status of all specified jobs
.
- getLevels() - Method in interface nl.esciencecenter.xenon.XenonPropertyDescription
-
Return a set containing all components that accept this property.
- getLocalCWD(Files) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Returns a Path
that represents the current working directory.
- getLocalFileSystems(Files) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Returns all local FileSystems.
- getLocalHome(Files) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Returns a Path
that represents the home directory of the current user.
- getLocalRoot(String) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Return the locally valid root element of an String
representation of an absolute path.
- getLocalScheduler(Jobs) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Returns a Scheduler
that can be used to run jobs locally.
- getLocalSeparator() - Static method in class nl.esciencecenter.xenon.util.Utils
-
Returns the local file system path separator character.
- getLocation() - Method in interface nl.esciencecenter.xenon.files.FileSystem
-
Get the location of the FileSystem.
- getLocation() - Method in interface nl.esciencecenter.xenon.jobs.Scheduler
-
Get the location of this Scheduler.
- getMaxTime() - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Get the maximum job time (in minutes).
- getMessage() - Method in exception nl.esciencecenter.xenon.XenonException
-
- getMessage() - Method in exception nl.esciencecenter.xenon.XenonRuntimeException
-
- getName() - Method in interface nl.esciencecenter.xenon.AdaptorStatus
-
Get the name of the adaptor.
- getName(int) - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Get a name element of this RelativePath.
- getName() - Method in interface nl.esciencecenter.xenon.XenonPropertyDescription
-
Returns the name of the property.
- getNameCount() - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Get the number of name elements in the RelativePath.
- getNodeCount() - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Get the number of nodes.
- getParent() - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Get the parent RelativePath, or null
if this RelativePath does not have a parent.
- getPath() - Method in class nl.esciencecenter.xenon.util.Sandbox
-
The sandbox directory.
- getProcessesPerNode() - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Get the number of processes to start on each node.
- getProperties() - Method in interface nl.esciencecenter.xenon.credentials.Credential
-
Get the properties used to create this Credential.
- getProperties() - Method in interface nl.esciencecenter.xenon.files.FileSystem
-
Get the properties used to create this FileSystem.
- getProperties() - Method in interface nl.esciencecenter.xenon.jobs.Scheduler
-
Get the properties used to create this Scheduler.
- getProperties() - Method in interface nl.esciencecenter.xenon.Xenon
-
Returns the properties that where used to create this Xenon.
- getQueueName() - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Get the queue name;
- getQueueName() - Method in interface nl.esciencecenter.xenon.jobs.QueueStatus
-
Get the queue name.
- getQueueNames() - Method in interface nl.esciencecenter.xenon.jobs.Scheduler
-
Get the queue names supported by this Scheduler.
- getQueueStatus(Scheduler, String) - Method in interface nl.esciencecenter.xenon.jobs.Jobs
-
Get the status of the queue
of scheduler
.
- getQueueStatuses(Scheduler, String...) - Method in interface nl.esciencecenter.xenon.jobs.Jobs
-
Get the status of all queues
of scheduler
.
- getRelativePath() - Method in interface nl.esciencecenter.xenon.files.Path
-
Get the location relative to the root of the FileSystem.
- getRelativePath() - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Return a String
representation of this RelativePath interpreted as a relative path.
- getRelativePath(String, String) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Provided with an absolute path
and a root
, this method returns a RelativePath
that
represents the part of path
that is realtive to the root
.
- getScheduler() - Method in interface nl.esciencecenter.xenon.jobs.Job
-
Returns the
Scheduler
that was used to create this Job.
- getScheduler() - Method in interface nl.esciencecenter.xenon.jobs.QueueStatus
-
Get the Scheduler that produced this QueueStatus.
- getSchedulerSpecficInformation() - Method in interface nl.esciencecenter.xenon.jobs.JobStatus
-
Get scheduler specific information on the Job.
- getSchedulerSpecficInformation() - Method in interface nl.esciencecenter.xenon.jobs.QueueStatus
-
Get scheduler specific information on the queue.
- getScheme() - Method in interface nl.esciencecenter.xenon.files.FileSystem
-
Get the scheme used to access the FileSystem.
- getScheme() - Method in interface nl.esciencecenter.xenon.jobs.Scheduler
-
Get the scheme used to access the Scheduler.
- getSeparator() - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Get the separator.
- getSource() - Method in interface nl.esciencecenter.xenon.files.Copy
-
Retrieve the source of the copy.
- getSource() - Method in class nl.esciencecenter.xenon.util.Sandbox.Pair
-
- getState() - Method in interface nl.esciencecenter.xenon.files.CopyStatus
-
Get the state of the Copy operation.
- getState() - Method in interface nl.esciencecenter.xenon.jobs.JobStatus
-
Get the state of the Job.
- getStderr() - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Gets the path to the file to which the executable must redirect stderr.
- getStderr() - Method in interface nl.esciencecenter.xenon.jobs.Streams
-
Returns the standard error stream of job.
- getStdin() - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Gets the path to the file from which the executable must redirect stdin.
- getStdin() - Method in interface nl.esciencecenter.xenon.jobs.Streams
-
Returns the standard input stream of job.
- getStdout() - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Gets the path to the file to which the executable must redirect stdout.
- getStdout() - Method in interface nl.esciencecenter.xenon.jobs.Streams
-
Returns the standard output stream of job.
- getStreams(Job) - Method in interface nl.esciencecenter.xenon.jobs.Jobs
-
Returns the standard streams of a job.
- getSupportedLocations() - Method in interface nl.esciencecenter.xenon.AdaptorStatus
-
Get the supported locations for this adaptor.
- getSupportedProperties() - Method in interface nl.esciencecenter.xenon.AdaptorStatus
-
Returns an array containing all properties this adaptor supports.
- getSupportedSchemes() - Method in interface nl.esciencecenter.xenon.AdaptorStatus
-
Get the supported schemes for this adaptor.
- getTarget() - Method in interface nl.esciencecenter.xenon.files.Copy
-
Retrieve the target of the copy.
- getType() - Method in interface nl.esciencecenter.xenon.XenonPropertyDescription
-
Returns the type of the property.
- getUploadFiles() - Method in class nl.esciencecenter.xenon.util.Sandbox
-
Returns the list of files that will be uploaded when calling
upload
.
- getWorkingDirectory() - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Gets the path of the working directory for the executable.
- group() - Method in interface nl.esciencecenter.xenon.files.FileAttributes
-
Get the group of this file.