nl.esciencecenter.xenon.adaptors.schedulers.ssh

Class SshSchedulerAdaptor

java.lang.Object

nl.esciencecenter.xenon.adaptors.Adaptor

nl.esciencecenter.xenon.adaptors.schedulers.SchedulerAdaptor

nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor

All Implemented Interfaces:

AdaptorDescription, SchedulerAdaptorDescription

public class SshSchedulerAdaptor
extends SchedulerAdaptor

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADAPTOR_DESCRIPTION A description of this adaptor
private static java.lang.String[]	ADAPTOR_LOCATIONS The locations supported by this adaptor
static java.lang.String	ADAPTOR_NAME The name of this adaptor
static java.lang.String	AGENT Enable the use of an ssh-agent
static java.lang.String	AGENT_FORWARDING Enable the use of ssh-agent-forwarding
static java.lang.String	AUTOMATICALLY_ADD_HOST_KEY Enable strict host key checking.
static int	DEFAULT_PORT The default SSH port
static java.lang.String	GATEWAY Add gateway to access machine.
static java.lang.String	INFO Ssh adaptor information start with this prefix.
static java.lang.String	JOBS Ssh job information start with this prefix.
static java.lang.String	LOAD_SSH_CONFIG Load the OpenSSH config file by default.
static java.lang.String	LOAD_STANDARD_KNOWN_HOSTS Load the known_hosts file by default.
private static org.slf4j.Logger	LOGGER
static java.lang.String	MAX_HISTORY Maximum history length for finished jobs
static java.lang.String	MULTIQ Local multi queue properties start with this prefix.
static java.lang.String	MULTIQ_MAX_CONCURRENT Property for the maximum number of concurrent jobs in the multi queue.
static java.lang.String	POLLING_DELAY Property for maximum history length for finished jobs
static java.lang.String	PREFIX All our own properties start with this prefix.
static java.lang.String	QUEUE All our own queue properties start with this prefix.
static java.lang.String	SSH_CONFIG_FILE OpenSSH config filename.
static java.lang.String	STRICT_HOST_KEY_CHECKING Enable strict host key checking.
static java.lang.String	SUBMITTED How many jobs have been submitted using this adaptor.
static java.lang.String	TIMEOUT Add gateway to access machine.
private static XenonPropertyDescription[]	VALID_PROPERTIES List of properties supported by this SSH adaptor

Fields inherited from class nl.esciencecenter.xenon.adaptors.schedulers.SchedulerAdaptor

ADAPTORS_PREFIX

Constructor Summary

Constructors

Constructor and Description
SshSchedulerAdaptor()

Method Summary

Modifier and Type	Method and Description
Scheduler	createScheduler(java.lang.String location, Credential credential, java.util.Map<java.lang.String,java.lang.String> properties)
java.lang.Class[]	getSupportedCredentials() Get the supported credential types for this adaptor.
boolean	isEmbedded() Is this an embedded scheduler ? Embedded schedulers are implemented inside the Xenon process itself.
boolean	supportsInteractive() 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.

Methods inherited from class nl.esciencecenter.xenon.adaptors.schedulers.SchedulerAdaptor

supportsBatch, usesFileSystem

Methods inherited from class nl.esciencecenter.xenon.adaptors.Adaptor

getDescription, getName, getNewUniqueID, getSupportedLocations, getSupportedProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nl.esciencecenter.xenon.AdaptorDescription

getDescription, getName, getSupportedLocations, getSupportedProperties

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

ADAPTOR_NAME

public static final java.lang.String ADAPTOR_NAME

The name of this adaptor

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

The default SSH port

See Also:

Constant Field Values

ADAPTOR_DESCRIPTION

public static final java.lang.String ADAPTOR_DESCRIPTION

A description of this adaptor

See Also:

Constant Field Values

PREFIX

public static final java.lang.String PREFIX

All our own properties start with this prefix.

See Also:

Constant Field Values

STRICT_HOST_KEY_CHECKING

public static final java.lang.String STRICT_HOST_KEY_CHECKING

Enable strict host key checking.

See Also:

Constant Field Values

AGENT

public static final java.lang.String AGENT

Enable the use of an ssh-agent

See Also:

Constant Field Values

AGENT_FORWARDING

public static final java.lang.String AGENT_FORWARDING

Enable the use of ssh-agent-forwarding

See Also:

Constant Field Values

LOAD_STANDARD_KNOWN_HOSTS

public static final java.lang.String LOAD_STANDARD_KNOWN_HOSTS

Load the known_hosts file by default.

See Also:

Constant Field Values

LOAD_SSH_CONFIG

public static final java.lang.String LOAD_SSH_CONFIG

Load the OpenSSH config file by default.

See Also:

Constant Field Values

SSH_CONFIG_FILE

public static final java.lang.String SSH_CONFIG_FILE

OpenSSH config filename.

See Also:

Constant Field Values

AUTOMATICALLY_ADD_HOST_KEY

public static final java.lang.String AUTOMATICALLY_ADD_HOST_KEY

Enable strict host key checking.

See Also:

Constant Field Values

GATEWAY

public static final java.lang.String GATEWAY

Add gateway to access machine.

See Also:

Constant Field Values

TIMEOUT

public static final java.lang.String TIMEOUT

Add gateway to access machine.

See Also:

Constant Field Values

QUEUE

public static final java.lang.String QUEUE

All our own queue properties start with this prefix.

See Also:

Constant Field Values

MAX_HISTORY

public static final java.lang.String MAX_HISTORY

Maximum history length for finished jobs

See Also:

Constant Field Values

POLLING_DELAY

public static final java.lang.String POLLING_DELAY

Property for maximum history length for finished jobs

See Also:

Constant Field Values

MULTIQ

public static final java.lang.String MULTIQ

Local multi queue properties start with this prefix.

See Also:

Constant Field Values

MULTIQ_MAX_CONCURRENT

public static final java.lang.String MULTIQ_MAX_CONCURRENT

Property for the maximum number of concurrent jobs in the multi queue.

See Also:

Constant Field Values

INFO

public static final java.lang.String INFO

Ssh adaptor information start with this prefix.

See Also:

Constant Field Values

JOBS

public static final java.lang.String JOBS

Ssh job information start with this prefix.

See Also:

Constant Field Values

SUBMITTED

public static final java.lang.String SUBMITTED

How many jobs have been submitted using this adaptor.

See Also:

Constant Field Values

ADAPTOR_LOCATIONS

private static final java.lang.String[] ADAPTOR_LOCATIONS

The locations supported by this adaptor

VALID_PROPERTIES

private static final XenonPropertyDescription[] VALID_PROPERTIES

List of properties supported by this SSH adaptor

Constructor Detail

SshSchedulerAdaptor

public SshSchedulerAdaptor()

Method Detail

isEmbedded

public boolean isEmbedded()

Description copied from interface: SchedulerAdaptorDescription

Is this an embedded scheduler ? Embedded schedulers are implemented inside the Xenon process itself. Therefore this process needs to remain active for its jobs to run. Ending an online scheduler will typically orphan or kill all jobs that were submitted to it. Non-embedded schedulers do not need to remain active for their jobs to run. A submitted job will typically be handed over to some external server that will manage the job for the rest of its lifetime.

Specified by:

isEmbedded in interface SchedulerAdaptorDescription

Overrides:

isEmbedded in class SchedulerAdaptor

Returns:

if this scheduler is embedded.

supportsInteractive

public boolean supportsInteractive()

Description copied from interface: SchedulerAdaptorDescription

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. Failing to do so may cause the job to hang indefinitely.

Specified by:

supportsInteractive in interface SchedulerAdaptorDescription

Overrides:

supportsInteractive in class SchedulerAdaptor

Returns:

if this scheduler supports the submission of interactive jobs ?

getSupportedCredentials

public java.lang.Class[] getSupportedCredentials()

Description copied from interface: AdaptorDescription

Get the supported credential types for this adaptor.

Returns:

the credential types supported by this adaptor.

createScheduler

public Scheduler createScheduler(java.lang.String location,
                                 Credential credential,
                                 java.util.Map<java.lang.String,java.lang.String> properties)
                          throws XenonException

Specified by:

createScheduler in class SchedulerAdaptor

Throws:

XenonException