- generate(PrintWriter) - Method in class nl.esciencecenter.xenon.util.AdaptorDocGenerator
-
- 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.
- IllegalSourcePathException - Exception in nl.esciencecenter.xenon.files
-
Signals that the source path of an operation is invalid.
- IllegalSourcePathException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.files.IllegalSourcePathException
-
- IllegalSourcePathException(String, String) - Constructor for exception nl.esciencecenter.xenon.files.IllegalSourcePathException
-
- IllegalTargetPathException - Exception in nl.esciencecenter.xenon.files
-
Signals that the target path of an operation is invalid.
- IllegalTargetPathException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.files.IllegalTargetPathException
-
- IllegalTargetPathException(String, String) - Constructor for exception nl.esciencecenter.xenon.files.IllegalTargetPathException
-
- IncompatibleVersionException - Exception in nl.esciencecenter.xenon
-
Signals that an adaptor is unable to connect to a resource due to version problems.
- IncompatibleVersionException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.IncompatibleVersionException
-
- IncompatibleVersionException(String, String) - Constructor for exception nl.esciencecenter.xenon.IncompatibleVersionException
-
- IncompleteJobDescriptionException - Exception in nl.esciencecenter.xenon.jobs
-
Signals that a JobDescription is missing required options.
- IncompleteJobDescriptionException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.jobs.IncompleteJobDescriptionException
-
- IncompleteJobDescriptionException(String, String) - Constructor for exception nl.esciencecenter.xenon.jobs.IncompleteJobDescriptionException
-
- InvalidCopyOptionsException - Exception in nl.esciencecenter.xenon.files
-
Signals that an invalid combination of CopyOptions have been specified.
- InvalidCopyOptionsException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.files.InvalidCopyOptionsException
-
- InvalidCopyOptionsException(String, String) - Constructor for exception nl.esciencecenter.xenon.files.InvalidCopyOptionsException
-
- InvalidCredentialException - Exception in nl.esciencecenter.xenon
-
Signals that an invalid credential was used to access a resource.
- InvalidCredentialException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.InvalidCredentialException
-
- InvalidCredentialException(String, String) - Constructor for exception nl.esciencecenter.xenon.InvalidCredentialException
-
- InvalidJobDescriptionException - Exception in nl.esciencecenter.xenon.jobs
-
Signals that a JobDescription contains invalid values for certain options.
- InvalidJobDescriptionException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.jobs.InvalidJobDescriptionException
-
- InvalidJobDescriptionException(String, String) - Constructor for exception nl.esciencecenter.xenon.jobs.InvalidJobDescriptionException
-
- InvalidLocationException - Exception in nl.esciencecenter.xenon
-
Signals that an invalid location was provided.
- InvalidLocationException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.InvalidLocationException
-
- InvalidLocationException(String, String) - Constructor for exception nl.esciencecenter.xenon.InvalidLocationException
-
- InvalidOpenOptionsException - Exception in nl.esciencecenter.xenon.files
-
Signals that an invalid combination of OpenOptions have been specified.
- InvalidOpenOptionsException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.files.InvalidOpenOptionsException
-
- InvalidOpenOptionsException(String, String) - Constructor for exception nl.esciencecenter.xenon.files.InvalidOpenOptionsException
-
- InvalidPropertyException - Exception in nl.esciencecenter.xenon
-
Signals that a property has an invalid value.
- InvalidPropertyException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.InvalidPropertyException
-
- InvalidPropertyException(String, String) - Constructor for exception nl.esciencecenter.xenon.InvalidPropertyException
-
- InvalidResumeTargetException - Exception in nl.esciencecenter.xenon.files
-
Signals that the data in the target of a resume does not match the data in the source.
- InvalidResumeTargetException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.files.InvalidResumeTargetException
-
- InvalidResumeTargetException(String, String) - Constructor for exception nl.esciencecenter.xenon.files.InvalidResumeTargetException
-
- InvalidSchemeException - Exception in nl.esciencecenter.xenon
-
Signals that an invalid scheme was provided.
- InvalidSchemeException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.InvalidSchemeException
-
- InvalidSchemeException(String, String) - Constructor for exception nl.esciencecenter.xenon.InvalidSchemeException
-
- isDirectory() - Method in interface nl.esciencecenter.xenon.files.FileAttributes
-
Does the path refer to a directory ?
- isDone() - Method in interface nl.esciencecenter.xenon.files.CopyStatus
-
Is the Copy done?
- isDone() - Method in interface nl.esciencecenter.xenon.jobs.JobStatus
-
Is the Job done.
- isEmpty() - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Is this RelativePath empty ?
- isExecutable() - Method in interface nl.esciencecenter.xenon.files.FileAttributes
-
Does the path refer to an executable file ?
- isHidden() - Method in interface nl.esciencecenter.xenon.files.FileAttributes
-
Does the path refer to an hidden file ?
- isInteractive() - Method in interface nl.esciencecenter.xenon.jobs.Job
-
Returns if this is an interactive job.
- isInteractive() - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Is this an interactive job ?
- isLinux() - Static method in class nl.esciencecenter.xenon.util.Utils
-
Returns if we are currently running on Linux.
- isLinuxRoot(String) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Check if root
only contains a valid Linux root element, which is "/".
- isLocalRoot(String) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Check if root
contains a locally valid root element, such as "C:" on Windows or "/" on Linux and OSX.
- isOnline() - Method in interface nl.esciencecenter.xenon.jobs.Job
-
Returns if this is an online job.
- isOnline() - Method in interface nl.esciencecenter.xenon.jobs.Scheduler
-
Is this an online scheduler ?
Online schedulers need to remain active for their jobs to run.
- isOpen(Credential) - Method in interface nl.esciencecenter.xenon.credentials.Credentials
-
Test if a Credential is open.
- isOpen(FileSystem) - Method in interface nl.esciencecenter.xenon.files.Files
-
Test is a FileSystem is open.
- isOpen(Scheduler) - Method in interface nl.esciencecenter.xenon.jobs.Jobs
-
Test if a Scheduler is open.
- isOSX() - Static method in class nl.esciencecenter.xenon.util.Utils
-
Returns if we are currently running on OSX.
- isOSXRoot(String) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Check if root
contains a valid OSX root element, which is "/".
- isOther() - Method in interface nl.esciencecenter.xenon.files.FileAttributes
-
Is the path not a file, link or directory ?
- isReadable() - Method in interface nl.esciencecenter.xenon.files.FileAttributes
-
Does the path refer to an readable file ?
- isRegularFile() - Method in interface nl.esciencecenter.xenon.files.FileAttributes
-
Does the path refer to a regular file ?
- isRunning() - Method in interface nl.esciencecenter.xenon.files.CopyStatus
-
Is the Copy still running?
- isRunning() - Method in interface nl.esciencecenter.xenon.jobs.JobStatus
-
Is the Job running.
- isStartSingleProcess() - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Is only a single process started?
- isSymbolicLink() - Method in interface nl.esciencecenter.xenon.files.FileAttributes
-
Does the path refer to a symbolic link ?
- isWindows() - Static method in class nl.esciencecenter.xenon.util.Utils
-
Returns if we are currently running on Windows.
- isWindowsRoot(String) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Check if root
only contains a valid Windows root element such as "C:".
- isWritable() - Method in interface nl.esciencecenter.xenon.files.FileAttributes
-
Does the path refer to a writable file ?
- iterator() - Method in interface nl.esciencecenter.xenon.files.DirectoryStream
-
- iterator() - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Create an Iterator
that returns all possible sub RelativePaths of this RelativePath, in order of increasing length.
- newAttributesDirectoryStream(Path) - Method in interface nl.esciencecenter.xenon.files.Files
-
Create a DirectoryStream that iterates over all PathAttributePair entries in the directory dir
.
- newAttributesDirectoryStream(Path, DirectoryStream.Filter) - Method in interface nl.esciencecenter.xenon.files.Files
-
Create a DirectoryStream that iterates over all PathAttributePair entries in the directory dir
that are
accepted by the filter.
- newBufferedReader(Files, Path, Charset) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Opens a file for reading, returning a BufferedReader
that may be used to read text from the file in an
efficient manner.
- newBufferedWriter(Files, Path, Charset, boolean) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Opens or creates a file for writing, returning a BufferedWriter that may be used to write text to the file in an efficient
manner.
- newCertificateCredential(String, String, String, char[], Map<String, String>) - Method in interface nl.esciencecenter.xenon.credentials.Credentials
-
Constructs a certificate Credential.
- newDirectoryStream(Path) - Method in interface nl.esciencecenter.xenon.files.Files
-
Create a DirectoryStream that iterates over all entries in the directory dir
.
- newDirectoryStream(Path, DirectoryStream.Filter) - Method in interface nl.esciencecenter.xenon.files.Files
-
Create a DirectoryStream that iterates over all entries in the directory dir
that are accepted by the filter.
- newFileSystem(String, String, Credential, Map<String, String>) - Method in interface nl.esciencecenter.xenon.files.Files
-
Create a new FileSystem that represents a (possibly remote) data store
at the location
, using the scheme
and
credentials
to get access.
- newInputStream(Path) - Method in interface nl.esciencecenter.xenon.files.Files
-
Open an existing file and return an InputStream
to read from this file.
- newOutputStream(Path, OpenOption...) - Method in interface nl.esciencecenter.xenon.files.Files
-
Open an file and return an OutputStream
to write to this file.
- newPasswordCredential(String, String, char[], Map<String, String>) - Method in interface nl.esciencecenter.xenon.credentials.Credentials
-
Constructs a password credential out of a username
and a
password
.
- newPath(FileSystem, RelativePath) - Method in interface nl.esciencecenter.xenon.files.Files
-
Create a new Path that represents a (possibly non existing) location on filesystem.
- newScheduler(String, String, Credential, Map<String, String>) - Method in interface nl.esciencecenter.xenon.jobs.Jobs
-
Create a new Scheduler that represents a (possibly remote) job
scheduler at the location
, using the scheme
and credentials
to get access.
- newScheduler(Jobs, String) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Create a Scheduler
for the given scheme, but without using a location, credential, or properties.
- newXenon(Map<String, String>) - Static method in class nl.esciencecenter.xenon.XenonFactory
-
Create a new Xenon instance using the given properties.
- nl.esciencecenter.xenon - package nl.esciencecenter.xenon
-
This package is the main entry point into the Xenon API.
- nl.esciencecenter.xenon.credentials - package nl.esciencecenter.xenon.credentials
-
This package contains classes and interfaces for managing credentials.
- nl.esciencecenter.xenon.files - package nl.esciencecenter.xenon.files
-
This package contains classes and interfaces for manipulating files.
- nl.esciencecenter.xenon.jobs - package nl.esciencecenter.xenon.jobs
-
This package contains the classes and interfaces used to run jobs.
- nl.esciencecenter.xenon.util - package nl.esciencecenter.xenon.util
-
This package is contains several utility classes.
- normalize() - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Normalize this RelativePath by removing as many redundant path elements as possible.
- NoSuchCopyException - Exception in nl.esciencecenter.xenon.files
-
Signals that a unknown Copy handle was provided.
- NoSuchCopyException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.files.NoSuchCopyException
-
- NoSuchCopyException(String, String) - Constructor for exception nl.esciencecenter.xenon.files.NoSuchCopyException
-
- NoSuchJobException - Exception in nl.esciencecenter.xenon.jobs
-
Signals that a Job was not found.
- NoSuchJobException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.jobs.NoSuchJobException
-
- NoSuchJobException(String, String) - Constructor for exception nl.esciencecenter.xenon.jobs.NoSuchJobException
-
- NoSuchPathException - Exception in nl.esciencecenter.xenon.files
-
Signals that a path does not exists.
- NoSuchPathException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.files.NoSuchPathException
-
- NoSuchPathException(String, String) - Constructor for exception nl.esciencecenter.xenon.files.NoSuchPathException
-
- NoSuchQueueException - Exception in nl.esciencecenter.xenon.jobs
-
Signals that a unknown queue was provided.
- NoSuchQueueException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.jobs.NoSuchQueueException
-
- NoSuchQueueException(String, String) - Constructor for exception nl.esciencecenter.xenon.jobs.NoSuchQueueException
-
- NoSuchSchedulerException - Exception in nl.esciencecenter.xenon.jobs
-
Signals that a unknown scheduler was provided.
- NoSuchSchedulerException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.jobs.NoSuchSchedulerException
-
- NoSuchSchedulerException(String, String) - Constructor for exception nl.esciencecenter.xenon.jobs.NoSuchSchedulerException
-
- NoSuchXenonException - Exception in nl.esciencecenter.xenon
-
Signals that a unknown Xenon instance was provided.
- NoSuchXenonException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.NoSuchXenonException
-
- NoSuchXenonException(String, String) - Constructor for exception nl.esciencecenter.xenon.NoSuchXenonException
-
- readAllBytes(InputStream) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Read all bytes from the input stream and return them in a byte array.
- readAllBytes(Files, Path) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Read all the bytes from a file and return them as a byte[]
.
- readAllLines(Files, Path, Charset) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Read all lines from a file and return them in a List
.
- readLines(InputStream, Charset) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Read all lines from a InputStream and return them in a List
.
- readSymbolicLink(Path) - Method in interface nl.esciencecenter.xenon.files.Files
-
Reads the target of a symbolic link (optional operation).
- readToString(InputStream, Charset) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Read all bytes from the input stream and return them in as a single String.
- readToString(InputStream) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Read all bytes from the input stream and return them in as a single String.
- readToString(Files, Path, Charset) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Read all the bytes from a file and return them as a String
using the Charset
for conversion.
- recursiveCopy(Files, Path, Path, CopyOption...) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Recursively copies directories, files and symbolic links from source to target.
- recursiveDelete(Files, Path) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Recursively removes all directories, files and symbolic links in path.
- RelativePath - Class in nl.esciencecenter.xenon.files
-
RelativePath contains a sequence of path elements separated by a separator.
- RelativePath() - Constructor for class nl.esciencecenter.xenon.files.RelativePath
-
Create a new empty RelativePath using the default separator.
- RelativePath(String) - Constructor for class nl.esciencecenter.xenon.files.RelativePath
-
Create a new RelativePath using the path and the default separator.
- RelativePath(String...) - Constructor for class nl.esciencecenter.xenon.files.RelativePath
-
Create a new RelativePath using the given path elements and the default separator.
- RelativePath(RelativePath...) - Constructor for class nl.esciencecenter.xenon.files.RelativePath
-
Create a new RelativePath by appending the provided paths
.
- RelativePath(char, String...) - Constructor for class nl.esciencecenter.xenon.files.RelativePath
-
Create a new RelativePath using the given path elements and the separator.
- RelativePath(char, List<String>) - Constructor for class nl.esciencecenter.xenon.files.RelativePath
-
Create a new RelativePath using the given path elements and the separator.
- relativize(RelativePath) - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Create a relative RelativePath between the given RelativePath and this RelativePath.
- resolve(RelativePath) - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Resolve a RelativePath against this RelativePath.
- resolve(String) - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Resolve a String containing a RelativePath against this path.
- resolveSibling(RelativePath) - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Resolves the given RelativePath to this paths parent RelativePath, thereby creating a sibling to this RelativePath.
- resolveWithEntryPath(Files, FileSystem, String...) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Resolve a relative
path
with the entry path of the
fileSystem
and return a new
Path
that
represents this location.
- resolveWithRoot(Files, Path, String...) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Resolve a relative
path
against
root
and return a new
Path
that represents this location.
- Sandbox - Class in nl.esciencecenter.xenon.util
-
Sandbox represents a (possibly remote and usually temporary) directory used for running jobs.
- Sandbox(Files, Path, String) - Constructor for class nl.esciencecenter.xenon.util.Sandbox
-
Creates a sandbox.
- Sandbox.Pair - Class in nl.esciencecenter.xenon.util
-
Pair represents the combination of a source and destination path
- Sandbox.Pair(Path, Path) - Constructor for class nl.esciencecenter.xenon.util.Sandbox.Pair
-
- Scheduler - Interface in nl.esciencecenter.xenon.jobs
-
Scheduler represents a (possibly remote) scheduler that can be used to submit jobs and retrieve queue information.
- setArguments(String...) - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Sets the command line arguments of the executable.
- setArguments(String...) - Method in class nl.esciencecenter.xenon.util.JavaJobDescription
-
This method should not be used.
- setEnvironment(Map<String, String>) - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Sets the environment of the executable.
- setExecutable(String) - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Sets the path to the executable.
- setInteractive(boolean) - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Set if this is an interactive job.
- setJavaArguments(String...) - Method in class nl.esciencecenter.xenon.util.JavaJobDescription
-
Sets the arguments of the java main class.
- setJavaClasspath(String...) - Method in class nl.esciencecenter.xenon.util.JavaJobDescription
-
Sets the java class path.
- setJavaMain(String) - Method in class nl.esciencecenter.xenon.util.JavaJobDescription
-
Sets the main class.
- setJavaOptions(String...) - Method in class nl.esciencecenter.xenon.util.JavaJobDescription
-
Sets the JVM options.
- setJavaSystemProperties(Map<String, String>) - Method in class nl.esciencecenter.xenon.util.JavaJobDescription
-
Sets the system properties.
- setJobOptions(Map<String, String>) - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Sets the job options of the job.
- setMaxTime(int) - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Set the maximum job time (in minutes).
- setNodeCount(int) - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Set the number of nodes.
- setPosixFilePermissions(Path, Set<PosixFilePermission>) - Method in interface nl.esciencecenter.xenon.files.Files
-
Sets the POSIX permissions of a path.
- setProcessesPerNode(int) - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Set the number of processes started on each node.
- setQueueName(String) - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Set the queue name;
- setStartSingleProcess(boolean) - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Set if only a single process is started, instead of nodeCount * processesPerNode.
- setStderr(String) - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Sets the path to the file to which the executable must redirect stderr.
- setStdin(String) - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Sets the path to the file from which the executable must redirect stdin.
- setStdout(String) - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Sets the path to the file to which the executable must redirect stdout.
- setUploadFiles(Path...) - Method in class nl.esciencecenter.xenon.util.Sandbox
-
Sets the list of files that will be uploaded to files
.
- setWorkingDirectory(String) - Method in class nl.esciencecenter.xenon.jobs.JobDescription
-
Sets the path of the working directory for the executable.
- size() - Method in interface nl.esciencecenter.xenon.files.FileAttributes
-
Get the size of this file.
- startsWith(RelativePath) - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Tests if this RelativePath starts with the given RelativePath.
- startsWith(String) - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Tests if this RelativePath starts with the given RelativePath.
- startsWithLinuxRoot(String) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Checks if the provide path starts with a valid Linux root, that is "/".
- startWithRoot(String) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Checks if the provide path starts with a valid root, such as "/" or "C:".
- startWithWindowsRoot(String) - Static method in class nl.esciencecenter.xenon.util.Utils
-
Checks if the provide path starts with a valid Windows root, for example "C:".
- Streams - Interface in nl.esciencecenter.xenon.jobs
-
Streams is a container for the standard input, output and error streams of a
Job
.
- submitJob(Scheduler, JobDescription) - Method in interface nl.esciencecenter.xenon.jobs.Jobs
-
Submit a job to a Scheduler.
- subpath(int, int) - Method in class nl.esciencecenter.xenon.files.RelativePath
-
Returns a RelativePath that is a subsequence of the name elements of this path.
- supportsBatch() - Method in interface nl.esciencecenter.xenon.jobs.Scheduler
-
Does this Scheduler support the submission of batch jobs ?
For batch jobs the standard streams of the jobs are redirected from / to files.
- supportsInteractive() - Method in interface nl.esciencecenter.xenon.jobs.Scheduler
-
Does this Scheduler supports the submission of interactive jobs ?
For interactive jobs the standard streams of the job must be handled by the submitting process.