Skip navigation links

Xenon-release 1.2.0 API for Xenon developers

A middleware abstraction library that provides a simple programming interface to various compute and storage resources.

See: Description

Packages 
Package Description
nl.esciencecenter.xenon
This package is the main entry point into the Xenon API.
nl.esciencecenter.xenon.adaptors.ftp  
nl.esciencecenter.xenon.adaptors.generic  
nl.esciencecenter.xenon.adaptors.gridengine  
nl.esciencecenter.xenon.adaptors.local  
nl.esciencecenter.xenon.adaptors.scripting  
nl.esciencecenter.xenon.adaptors.slurm  
nl.esciencecenter.xenon.adaptors.ssh  
nl.esciencecenter.xenon.adaptors.torque  
nl.esciencecenter.xenon.adaptors.webdav  
nl.esciencecenter.xenon.credentials
This package contains classes and interfaces for managing credentials.
nl.esciencecenter.xenon.engine  
nl.esciencecenter.xenon.engine.credentials  
nl.esciencecenter.xenon.engine.files  
nl.esciencecenter.xenon.engine.jobs  
nl.esciencecenter.xenon.engine.util  
nl.esciencecenter.xenon.files
This package contains classes and interfaces for manipulating files.
nl.esciencecenter.xenon.jobs
This package contains the classes and interfaces used to run jobs.
nl.esciencecenter.xenon.util
This package is contains several utility classes.
A middleware abstraction library that provides a simple programming interface to various compute and storage resources.

Adaptor Documentation

This section contains the adaptor documentation which is generated from the information provided by the adaptors themselves.

Xenon currently supports 7 adaptors:

Adaptor: local

The local adaptor implements all functionality with standard java classes such as java.lang.Process and java.nio.file.Files.

Supported schemes:

Supported locations:

Supported properties:

NameDescriptionExpected typeDefaultValid for
xenon.adaptors.local.queue.pollingDelay
The polling delay for monitoring running jobs (in milliseconds). INTEGER 1000

XENON

xenon.adaptors.local.queue.multi.maxConcurrentJobs
The maximum number of concurrent jobs in the multiq.. INTEGER 4

XENON

Adaptor: ssh

The SSH adaptor implements all functionality with remote ssh servers.

Supported schemes:

Supported locations:

Supported properties:

NameDescriptionExpected typeDefaultValid for
xenon.adaptors.ssh.autoAddHostKey
Automatically add unknown host keys to known_hosts. BOOLEAN true

SCHEDULER

FILESYSTEM

xenon.adaptors.ssh.strictHostKeyChecking
Enable strict host key checking. BOOLEAN true

SCHEDULER

FILESYSTEM

xenon.adaptors.ssh.loadKnownHosts
Load the standard known_hosts file. BOOLEAN true

XENON

xenon.adaptors.ssh.loadSshConfig
Load the OpenSSH config file. BOOLEAN true

XENON

xenon.adaptors.ssh.sshConfigFile
OpenSSH config filename. STRING null

XENON

xenon.adaptors.ssh.agent
Use a (local) ssh-agent. BOOLEAN false

XENON

xenon.adaptors.ssh.agentForwarding
Use ssh-agent forwarding BOOLEAN false

XENON

xenon.adaptors.ssh.queue.pollingDelay
The polling delay for monitoring running jobs (in milliseconds). LONG 1000

SCHEDULER

xenon.adaptors.ssh.queue.multi.maxConcurrentJobs
The maximum number of concurrent jobs in the multiq.. INTEGER 4

SCHEDULER

xenon.adaptors.ssh.gateway
The gateway machine used to create an SSH tunnel to the target. STRING null

SCHEDULER

FILESYSTEM

Adaptor: ftp

The FTP adaptor implements all functionality with remote ftp servers.

Supported schemes:

Supported locations:

Supported properties:

NameDescriptionExpected typeDefaultValid for
xenon.adaptors.ftp.autoAddHostKey
Automatically add unknown host keys to known_hosts. BOOLEAN true

FILESYSTEM

xenon.adaptors.ftp.strictHostKeyChecking
Enable strict host key checking. BOOLEAN true

SCHEDULER

FILESYSTEM

xenon.adaptors.ftp.loadKnownHosts
Load the standard known_hosts file. BOOLEAN true

XENON

xenon.adaptors.ftp.queue.pollingDelay
The polling delay for monitoring running jobs (in milliseconds). LONG 1000

SCHEDULER

xenon.adaptors.ftp.queue.multi.maxConcurrentJobs
The maximum number of concurrent jobs in the multiq.. INTEGER 4

SCHEDULER

xenon.adaptors.ftp.gateway
The gateway machine used to create an SSH tunnel to the target. STRING null

SCHEDULER

FILESYSTEM

Adaptor: gridengine

The SGE Adaptor submits jobs to a (Sun/Ocacle/Univa) Grid Engine scheduler. This adaptor uses either the local or the ssh adaptor to gain access to the scheduler machine.

Supported schemes:

Supported locations:

Supported properties:

NameDescriptionExpected typeDefaultValid for
xenon.adaptors.gridengine.ignore.version
Skip version check is skipped when connecting to remote machines. WARNING: it is not recommended to use this setting in production environments! BOOLEAN false

SCHEDULER

xenon.adaptors.gridengine.accounting.grace.time
Number of milliseconds a job is allowed to take going from the queue to the qacct output. LONG 60000

SCHEDULER

xenon.adaptors.gridengine.poll.delay
Number of milliseconds between polling the status of a job. LONG 1000

SCHEDULER

Adaptor: slurm

The Slurm Adaptor submits jobs to a Slurm scheduler. This adaptor uses either the local or the ssh adaptor to gain access to the scheduler machine.

Supported schemes:

Supported locations:

Supported properties:

NameDescriptionExpected typeDefaultValid for
xenon.adaptors.slurm.ignore.version
Skip version check is skipped when connecting to remote machines. WARNING: it is not recommended to use this setting in production environments! BOOLEAN false

SCHEDULER

xenon.adaptors.slurm.disable.accounting.usage
Do not use accounting info of slurm, even when available. Mostly for testing purposes BOOLEAN false

SCHEDULER

xenon.adaptors.slurm.poll.delay
Number of milliseconds between polling the status of a job. LONG 1000

SCHEDULER

Adaptor: torque

The Torque Adaptor submits jobs to a TORQUE batch system. This adaptor uses either the local or the ssh adaptor to gain access to the scheduler machine.

Supported schemes:

Supported locations:

Supported properties:

NameDescriptionExpected typeDefaultValid for
xenon.adaptors.torque.ignore.version
Skip version check is skipped when connecting to remote machines. WARNING: it is not recommended to use this setting in production environments! BOOLEAN false

SCHEDULER

xenon.adaptors.torque.accounting.grace.time
Number of milliseconds a job is allowed to take going from the queue to the accinfo output. LONG 60000

SCHEDULER

xenon.adaptors.torque.poll.delay
Number of milliseconds between polling the status of a job. LONG 1000

SCHEDULER

Adaptor: webdav

The webdav adaptor implements all functionality with remote webdav servers.

Supported schemes:

Supported locations:

Supported properties:

NameDescriptionExpected typeDefaultValid for
xenon.adaptors.webdav.autoAddHostKey
Automatically add unknown host keys to known_hosts. BOOLEAN true

FILESYSTEM

xenon.adaptors.webdav.strictHostKeyChecking
Enable strict host key checking. BOOLEAN true

SCHEDULER

FILESYSTEM

xenon.adaptors.webdav.loadKnownHosts
Load the standard known_hosts file. BOOLEAN true

XENON

xenon.adaptors.webdav.queue.pollingDelay
The polling delay for monitoring running jobs (in milliseconds). LONG 1000

SCHEDULER

xenon.adaptors.webdav.queue.multi.maxConcurrentJobs
The maximum number of concurrent jobs in the multiq.. INTEGER 4

SCHEDULER

xenon.adaptors.webdav.gateway
The gateway machine used to create an SSH tunnel to the target. STRING null

SCHEDULER

FILESYSTEM

Skip navigation links