diff --git a/CHANGELOG.md b/CHANGELOG.md index a981c118b..255dde7a1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,12 @@ -Xenon 2.6.0 +Xenon 2.6.1 ----------- -This is release 2.6.0 of Xenon. +This is release 2.6.1 of Xenon. + +Notable changes compared to v2.6.0: +----------------------------------- + +- fixed hashCode and equals of JobDescription Notable changes compared to v2.5.0: ----------------------------------- diff --git a/README.md b/README.md index ea3e213bf..94f3982a6 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ and ```gradle dependencies { - compile 'nl.esciencecenter.xenon:xenon:2.6.0' + compile 'nl.esciencecenter.xenon:xenon:2.6.1' } ``` @@ -110,7 +110,7 @@ and nl.esciencecenter.xenon xenon - 2.6.0 + 2.6.1 ``` @@ -220,7 +220,7 @@ For more examples, see the tutorial at [Read The Docs](http://xenonrse2017.readt ## Documentation -Xenon's JavaDoc is available online at . +Xenon's JavaDoc is available online at . ## Legal diff --git a/docs/_data/version.yml b/docs/_data/version.yml index 03fa0f0bd..a04c85005 100644 --- a/docs/_data/version.yml +++ b/docs/_data/version.yml @@ -1 +1 @@ -current: 2.6.0 +current: 2.6.1 diff --git a/docs/versions/2.6.1/javadoc-devel/allclasses-frame.html b/docs/versions/2.6.1/javadoc-devel/allclasses-frame.html new file mode 100644 index 000000000..ab6d4f725 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/allclasses-frame.html @@ -0,0 +1,146 @@ + + + + + +All Classes (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

All Classes

+
+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/allclasses-noframe.html b/docs/versions/2.6.1/javadoc-devel/allclasses-noframe.html new file mode 100644 index 000000000..a32de92e5 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/allclasses-noframe.html @@ -0,0 +1,146 @@ + + + + + +All Classes (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

All Classes

+
+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/constant-values.html b/docs/versions/2.6.1/javadoc-devel/constant-values.html new file mode 100644 index 000000000..28b5edb35 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/constant-values.html @@ -0,0 +1,2233 @@ + + + + + +Constant Field Values (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+ +
+
+ + +

nl.esciencecenter.*

+ +
    +
  • + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.NotConnectedException 
    Modifier and TypeConstant FieldValue
    + +private static final longserialVersionUID1L
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.XenonProperties 
    Modifier and TypeConstant FieldValue
    + +private static final intGIGA1073741824
    + +private static final intKILO1024
    + +private static final intMEGA1048576
    + +private static final java.lang.StringNAME"XenonProperties"
    +
    • +
+ +
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor 
    Modifier and TypeConstant FieldValue
    + +private static final java.lang.StringADAPTOR_DESCRIPTION"The FTP adaptor implements file access on remote ftp servers."
    + +public static final java.lang.StringADAPTOR_NAME"ftp"
    + +public static final java.lang.StringBUFFER_SIZE"xenon.adaptors.filesystems.ftp.bufferSize"
    + +protected static final intDEFAULT_PORT21
    + +public static final java.lang.StringPREFIX"xenon.adaptors.filesystems.ftp."
    +
    • +
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileAdaptor 
    Modifier and TypeConstant FieldValue
    + +private static final java.lang.StringADAPTOR_DESCRIPTION"Adaptor for the Apache Hadoop file system"
    + +public static final java.lang.StringADAPTOR_NAME"hdfs"
    + +public static final java.lang.StringBUFFER_SIZE"xenon.adaptors.filesystems.hdfs.bufferSize"
    + +protected static final intDEFAULT_PORT21
    + +public static final java.lang.StringHADOOP_SETTINGS_FILE"xenon.adaptors.filesystems.hdfs.hadoopSettingsFile"
    + +public static final java.lang.StringPREFIX"xenon.adaptors.filesystems.hdfs."
    +
    • +
+
    +
  • + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem 
    Modifier and TypeConstant FieldValue
    + +private static final java.lang.StringNOT_EMPTY"___not__empty___"
    +
    • +
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileAdaptor 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringADAPTOR_DESCRIPTION"This is the local file adaptor that implements file functionality for local access."
    + +public static final java.lang.StringADAPTOR_NAME"file"
    + +public static final java.lang.StringBUFFER_SIZE"xenon.adaptors.filesystems.file.bufferSize"
    + +public static final java.lang.StringPREFIX"xenon.adaptors.filesystems.file."
    +
    • +
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor 
    Modifier and TypeConstant FieldValue
    + +private static final java.lang.StringADAPTOR_DESCRIPTION"The JClouds adaptor uses Apache JClouds to talk to s3 and others"
    + +public static final java.lang.StringADAPTOR_NAME"s3"
    + +public static final java.lang.StringBUFFER_SIZE"xenon.adaptors.filesystems.s3.bufferSize"
    + +public static final java.lang.StringPREFIX"xenon.adaptors.filesystems.s3."
    +
    • +
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringADAPTOR_DESCRIPTION"The SFTP adaptor implements all file access functionality to remote SFTP servers"
    + +public static final java.lang.StringADAPTOR_NAME"sftp"
    + +public static final java.lang.StringAGENT"xenon.adaptors.filesystems.sftp.agent"
    + +public static final java.lang.StringAGENT_FORWARDING"xenon.adaptors.filesystems.sftp.agentForwarding"
    + +public static final java.lang.StringAUTOMATICALLY_ADD_HOST_KEY"xenon.adaptors.filesystems.sftp.autoAddHostKey"
    + +public static final java.lang.StringBUFFER_SIZE"xenon.adaptors.filesystems.sftp.bufferSize"
    + +public static final java.lang.StringCONNECTION_TIMEOUT"xenon.adaptors.filesystems.sftp.connection.timeout"
    + +public static final intDEFAULT_PORT22
    + +public static final java.lang.StringGATEWAY"xenon.adaptors.filesystems.sftp.gateway"
    + +public static final java.lang.StringLOAD_SSH_CONFIG"xenon.adaptors.filesystems.sftp.loadSshConfig"
    + +public static final java.lang.StringLOAD_STANDARD_KNOWN_HOSTS"xenon.adaptors.filesystems.sftp.loadKnownHosts"
    + +public static final java.lang.StringPREFIX"xenon.adaptors.filesystems.sftp."
    + +public static final java.lang.StringSSH_CONFIG_FILE"xenon.adaptors.filesystems.sftp.sshConfigFile"
    + +public static final java.lang.StringSTRICT_HOST_KEY_CHECKING"xenon.adaptors.filesystems.sftp.strictHostKeyChecking"
    +
    • +
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileAdaptor 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringADAPTOR_DESCRIPTION"The webdav file adaptor implements file access to remote webdav servers."
    + +public static final java.lang.StringADAPTOR_NAME"webdav"
    + +public static final java.lang.StringBUFFER_SIZE"xenon.adaptors.filesystems.webdav.bufferSize"
    + +public static final intOK_CODE200
    + +public static final java.lang.StringPREFIX"xenon.adaptors.filesystems.webdav."
    +
    • +
+ +
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSchedulerAdaptor 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringACCOUNTING_GRACE_TIME_PROPERTY"xenon.adaptors.schedulers.gridengine.accounting.grace.time"
    + +public static final java.lang.StringADAPTOR_DESCRIPTION"The SGE Adaptor submits jobs to a (Sun/Oracle/Univa) Grid Engine scheduler. This adaptor uses either the local or the ssh scheduler adaptor to run commands on the machine running Grid Engine, and the file or the stfp filesystem adaptor to gain access to the filesystem of that machine."
    + +public static final java.lang.StringADAPTOR_NAME"gridengine"
    + +public static final java.lang.StringIGNORE_VERSION_PROPERTY"xenon.adaptors.schedulers.gridengine.ignore.version"
    + +public static final java.lang.StringPOLL_DELAY_PROPERTY"xenon.adaptors.schedulers.gridengine.poll.delay"
    + +public static final java.lang.StringPREFIX"xenon.adaptors.schedulers.gridengine."
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.schedulers.gridengine.nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringJOB_OPTION_JOB_SCRIPT"job.script"
    + +public static final java.lang.StringJOB_OPTION_PARALLEL_ENVIRONMENT"parallel.environment"
    + +public static final java.lang.StringJOB_OPTION_PARALLEL_SLOTS"parallel.slots"
    + +public static final java.lang.StringJOB_OPTION_RESOURCES"resources"
    + +private static final intMINUTES_PER_HOUR60
    + +public static final java.lang.StringQACCT_HEADER"=============================================================="
    +
    • +
  • + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineXmlParser 
    Modifier and TypeConstant FieldValue
    + +private static final java.lang.StringSGE62_SCHEMA_ATTRIBUTE"xmlns:xsd"
    + +private static final java.lang.StringSGE62_SCHEMA_VALUE"http://gridengine.sunsource.net/source/browse/*checkout*/gridengine/source/dist/util/resources/schemas/qstat/qstat.xsd?revision=1.11"
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.schedulers.gridengine.nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo 
    Modifier and TypeConstant FieldValue
    + +private static final java.lang.StringALLOCATION_FILL_UP"$fill_up"
    + +private static final java.lang.StringALLOCATION_PE_SLOTS"$pe_slots"
    + +private static final java.lang.StringALLOCATION_ROUND_ROBIN"$round_robin"
    +
    • +
+
    +
  • + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.schedulers.local.CommandNotFoundException 
    Modifier and TypeConstant FieldValue
    + +private static final longserialVersionUID1L
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringADAPTOR_DESCRIPTION"The local jobs adaptor implements all functionality by emulating a local queue."
    + +public static final java.lang.StringADAPTOR_NAME"local"
    + +public static final java.lang.StringINFO"xenon.adaptors.schedulers.local.info."
    + +public static final java.lang.StringJOBS"xenon.adaptors.schedulers.local.info.jobs."
    + +public static final java.lang.StringMAX_HISTORY"xenon.adaptors.schedulers.local.queue.historySize"
    + +public static final java.lang.StringMULTIQ"xenon.adaptors.schedulers.local.queue.multi."
    + +public static final java.lang.StringMULTIQ_MAX_CONCURRENT"xenon.adaptors.schedulers.local.queue.multi.maxConcurrentJobs"
    + +public static final java.lang.StringPOLLING_DELAY"xenon.adaptors.schedulers.local.queue.pollingDelay"
    + +public static final java.lang.StringPREFIX"xenon.adaptors.schedulers.local."
    + +public static final java.lang.StringQUEUE"xenon.adaptors.schedulers.local.queue."
    + +public static final java.lang.StringSUBMITTED"xenon.adaptors.schedulers.local.info.jobs.submitted"
    +
    • +
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSchedulerAdaptor 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringADAPTOR_DESCRIPTION"The Slurm Adaptor submits jobs to a Slurm scheduler. This adaptor uses either the local or the ssh scheduler adaptor to run commands on the machine running Slurm, and the file or the stfp filesystem adaptor to gain access to the filesystem of that machine."
    + +public static final java.lang.StringADAPTOR_NAME"slurm"
    + +public static final java.lang.StringDISABLE_ACCOUNTING_USAGE"xenon.adaptors.schedulers.slurm.disable.accounting.usage"
    + +public static final java.lang.StringPOLL_DELAY_PROPERTY"xenon.adaptors.schedulers.slurm.poll.delay"
    + +public static final java.lang.StringPREFIX"xenon.adaptors.schedulers.slurm."
    + +public static final longSLURM_UPDATE_SLEEP1000L
    + +public static final longSLURM_UPDATE_TIMEOUT60000L
    +
    • +
  • + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils 
    Modifier and TypeConstant FieldValue
    + +private static final java.lang.StringDONE_STATE"COMPLETED"
    + +public static final java.lang.StringJOB_OPTION_JOB_SCRIPT"job.script"
    +
    • +
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringADAPTOR_DESCRIPTION"The SSH job adaptor implements all functionality to start jobs on ssh servers."
    + +public static final java.lang.StringADAPTOR_NAME"ssh"
    + +public static final java.lang.StringAGENT"xenon.adaptors.schedulers.ssh.agent"
    + +public static final java.lang.StringAGENT_FORWARDING"xenon.adaptors.schedulers.ssh.agentForwarding"
    + +public static final java.lang.StringAUTOMATICALLY_ADD_HOST_KEY"xenon.adaptors.schedulers.ssh.autoAddHostKey"
    + +public static final intDEFAULT_PORT22
    + +public static final java.lang.StringGATEWAY"xenon.adaptors.schedulers.ssh.gateway"
    + +public static final java.lang.StringINFO"xenon.adaptors.schedulers.ssh.info."
    + +public static final java.lang.StringJOBS"xenon.adaptors.schedulers.ssh.info.jobs."
    + +public static final java.lang.StringLOAD_SSH_CONFIG"xenon.adaptors.schedulers.ssh.loadSshConfig"
    + +public static final java.lang.StringLOAD_STANDARD_KNOWN_HOSTS"xenon.adaptors.schedulers.ssh.loadKnownHosts"
    + +public static final java.lang.StringMAX_HISTORY"xenon.adaptors.schedulers.ssh.queue.historySize"
    + +public static final java.lang.StringMULTIQ"xenon.adaptors.schedulers.ssh.queue.multi."
    + +public static final java.lang.StringMULTIQ_MAX_CONCURRENT"xenon.adaptors.schedulers.ssh.queue.multi.maxConcurrentJobs"
    + +public static final java.lang.StringPOLLING_DELAY"xenon.adaptors.schedulers.ssh.queue.pollingDelay"
    + +public static final java.lang.StringPREFIX"xenon.adaptors.schedulers.ssh."
    + +public static final java.lang.StringQUEUE"xenon.adaptors.schedulers.ssh.queue."
    + +public static final java.lang.StringSSH_CONFIG_FILE"xenon.adaptors.schedulers.ssh.sshConfigFile"
    + +public static final java.lang.StringSTRICT_HOST_KEY_CHECKING"xenon.adaptors.schedulers.ssh.strictHostKeyChecking"
    + +public static final java.lang.StringSUBMITTED"xenon.adaptors.schedulers.ssh.info.jobs.submitted"
    + +public static final java.lang.StringTIMEOUT"xenon.adaptors.schedulers.ssh.timeout"
    +
    • +
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueSchedulerAdaptor 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringACCOUNTING_GRACE_TIME_PROPERTY"xenon.adaptors.schedulers.torque.accounting.grace.time"
    + +public static final java.lang.StringADAPTOR_DESCRIPTION"The Torque Adaptor submits jobs to a TORQUE batch system. This adaptor uses either the local or the ssh scheduler adaptor to run commands on the machine running TORQUE, and the file or the stfp filesystem adaptor to gain access to the filesystem of that machine."
    + +public static final java.lang.StringADAPTOR_NAME"torque"
    + +public static final java.lang.StringIGNORE_VERSION_PROPERTY"xenon.adaptors.schedulers.torque.ignore.version"
    + +public static final java.lang.StringPOLL_DELAY_PROPERTY"xenon.adaptors.schedulers.torque.poll.delay"
    + +public static final java.lang.StringPREFIX"xenon.adaptors.schedulers.torque."
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.schedulers.torque.nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueUtils 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringJOB_OPTION_JOB_CONTENTS"job.contents"
    + +public static final java.lang.StringJOB_OPTION_JOB_SCRIPT"job.script"
    + +public static final java.lang.StringJOB_OPTION_RESOURCES"job.resources"
    + +private static final intMINUTES_PER_HOUR60
    +
    • +
+ + + +
    +
  • + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.utils.LocalFileSystemUtils 
    Modifier and TypeConstant FieldValue
    + +private static final java.lang.StringOS_PROPERTY"os.name"
    +
    • +
  • + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.utils.OutputReader 
    Modifier and TypeConstant FieldValue
    + +private static final intBUFFER_SIZE1024
    +
    • +
  • + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.utils.StreamForwarder 
    Modifier and TypeConstant FieldValue
    + +private static final intDEFAULT_BUFFER_SIZE1024
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/deprecated-list.html b/docs/versions/2.6.1/javadoc-devel/deprecated-list.html new file mode 100644 index 000000000..fdf502a3f --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/deprecated-list.html @@ -0,0 +1,121 @@ + + + + + +Deprecated List (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/help-doc.html b/docs/versions/2.6.1/javadoc-devel/help-doc.html new file mode 100644 index 000000000..462e6556d --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/help-doc.html @@ -0,0 +1,222 @@ + + + + + +API Help (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
    +
  • +

    Overview

    +

    The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

    +
    • +
  • +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

    +
      +
    • Interfaces (italic)
      • +
    • Classes
      • +
    • Enums
      • +
    • Exceptions
      • +
    • Errors
      • +
    • Annotation Types
      • +
    +
    • +
  • +

    Class/Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
      +
    • Class inheritance diagram
      • +
    • Direct Subclasses
      • +
    • All Known Subinterfaces
      • +
    • All Known Implementing Classes
      • +
    • Class/interface declaration
      • +
    • Class/interface description
      • +
    +
      +
    • Nested Class Summary
      • +
    • Field Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    +
      +
    • Field Detail
      • +
    • Constructor Detail
      • +
    • Method Detail
      • +
    +

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
    • +
  • +

    Annotation Type

    +

    Each annotation type has its own separate page with the following sections:

    +
      +
    • Annotation Type declaration
      • +
    • Annotation Type description
      • +
    • Required Element Summary
      • +
    • Optional Element Summary
      • +
    • Element Detail
      • +
    +
    • +
  • +

    Enum

    +

    Each enum has its own separate page with the following sections:

    +
      +
    • Enum declaration
      • +
    • Enum description
      • +
    • Enum Constant Summary
      • +
    • Enum Constant Detail
      • +
    +
    • +
  • +

    Tree (Class Hierarchy)

    +

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • +
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
      • +
    +
    • +
  • +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +
    • +
  • +

    Index

    +

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    +
    • +
  • +

    Prev/Next

    +

    These links take you to the next or previous class, interface, package, or related page.

    +
    • +
  • +

    Frames/No Frames

    +

    These links show and hide the HTML frames. All pages are available with or without frames.

    +
    • +
  • +

    All Classes

    +

    The All Classes link shows all classes and interfaces except non-static nested types.

    +
    • +
  • +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    +
    • +
  • +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
    • +
+This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/index-all.html b/docs/versions/2.6.1/javadoc-devel/index-all.html new file mode 100644 index 000000000..845bc58be --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/index-all.html @@ -0,0 +1,5049 @@ + + + + + +Index (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
A B C D E F G H I J K L M N O P Q R S T U V W X  + + +

A

+
+
ACCOUNTING_GRACE_TIME_PROPERTY - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSchedulerAdaptor
+
+
Timeout for waiting for the accounting info of a job to appear
+
+
ACCOUNTING_GRACE_TIME_PROPERTY - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueSchedulerAdaptor
+
+
Timeout for waiting for the accounting info of a job to appear
+
+
accountingAvailable - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSetup
+
 
+
accountingAvailable() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSetup
+
 
+
accountingGraceTime - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
accountingGraceTime - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
Adaptor - Class in nl.esciencecenter.xenon.adaptors
+
 
+
Adaptor(String, String, String[], XenonPropertyDescription[]) - Constructor for class nl.esciencecenter.xenon.adaptors.Adaptor
+
 
+
adaptor - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
adaptor - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
adaptor - Variable in class nl.esciencecenter.xenon.schedulers.Scheduler
+
 
+
ADAPTOR_DESCRIPTION - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
+
A description of this adaptor
+
+
ADAPTOR_DESCRIPTION - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileAdaptor
+
+
A description of this adaptor
+
+
ADAPTOR_DESCRIPTION - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileAdaptor
+
+
Description of the adaptor
+
+
ADAPTOR_DESCRIPTION - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor
+
+
A description of this adaptor
+
+
ADAPTOR_DESCRIPTION - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
+
A description of this adaptor
+
+
ADAPTOR_DESCRIPTION - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileAdaptor
+
+
A description of this adaptor
+
+
ADAPTOR_DESCRIPTION - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSchedulerAdaptor
+
+
Human readable description of this adaptor
+
+
ADAPTOR_DESCRIPTION - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
+
Description of the adaptor
+
+
ADAPTOR_DESCRIPTION - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSchedulerAdaptor
+
+
Human readable description of this adaptor
+
+
ADAPTOR_DESCRIPTION - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
A description of this adaptor
+
+
ADAPTOR_DESCRIPTION - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueSchedulerAdaptor
+
+
Human readable description of this adaptor
+
+
ADAPTOR_LOCATIONS - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
+
The locations supported by this adaptor
+
+
ADAPTOR_LOCATIONS - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileAdaptor
+
+
The locations supported by this adaptor
+
+
ADAPTOR_LOCATIONS - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileAdaptor
+
+
The locations supported by the adaptor
+
+
ADAPTOR_LOCATIONS - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor
+
+
The locations supported by this adaptor
+
+
ADAPTOR_LOCATIONS - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
+
The locations supported by this adaptor
+
+
ADAPTOR_LOCATIONS - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileAdaptor
+
+
The locations supported by this adaptor
+
+
ADAPTOR_LOCATIONS - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSchedulerAdaptor
+
+
The locations supported by this adaptor
+
+
ADAPTOR_LOCATIONS - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
+
The locations supported by the adaptor
+
+
ADAPTOR_LOCATIONS - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSchedulerAdaptor
+
+
The locations supported by this adaptor
+
+
ADAPTOR_LOCATIONS - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
The locations supported by this adaptor
+
+
ADAPTOR_LOCATIONS - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueSchedulerAdaptor
+
+
The locations supported by this adaptor
+
+
ADAPTOR_NAME - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
+
The name of this adaptor
+
+
ADAPTOR_NAME - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileAdaptor
+
+
The name of this adaptor
+
+
ADAPTOR_NAME - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileAdaptor
+
+
Name of the local adaptor is defined in the engine.
+
+
ADAPTOR_NAME - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor
+
+
The name of this adaptor
+
+
ADAPTOR_NAME - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
+
The name of this adaptor
+
+
ADAPTOR_NAME - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileAdaptor
+
+
The name of this adaptor
+
+
ADAPTOR_NAME - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSchedulerAdaptor
+
+
The name of this adaptor
+
+
ADAPTOR_NAME - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
+
Name of the local adaptor is defined in the engine.
+
+
ADAPTOR_NAME - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSchedulerAdaptor
+
+
The name of this adaptor
+
+
ADAPTOR_NAME - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
The name of this adaptor
+
+
ADAPTOR_NAME - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueSchedulerAdaptor
+
+
The name of this adaptor
+
+
AdaptorDescription - Interface in nl.esciencecenter.xenon
+
+
AdaptorStatus contains information on a specific adaptor.
+
+
adaptorName - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
adaptorName - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
adaptorName - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
adaptorName - Variable in exception nl.esciencecenter.xenon.XenonException
+
 
+
adaptorName - Variable in exception nl.esciencecenter.xenon.XenonRuntimeException
+
 
+
adaptors - Static variable in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
adaptors - Static variable in class nl.esciencecenter.xenon.schedulers.Scheduler
+
 
+
ADAPTORS_PREFIX - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor
+
 
+
ADAPTORS_PREFIX - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.SchedulerAdaptor
+
 
+
addAdaptor(FileAdaptor) - Static method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
addAdaptor(SchedulerAdaptor) - Static method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
 
+
addArgument(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Add a command line argument for the executable.
+
+
addBytesCopied(long) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyCallback
+
 
+
addDeletedJob(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
addDeletedJob(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
addEnvironment(String, String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Add a variable to the environment of the executable.
+
+
addHop(int, ClientSession, SSHUtil.Tunnel) - Method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHConnection
+
 
+
addJavaArgument(String) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
 
+
addJavaClasspathElement(String) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
 
+
addJavaOption(String) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
+
Adds a JVM option.
+
+
addJavaSystemProperty(String, String) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
+
Adds a system property to the current set of system properties.
+
+
addJobOption(String, String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Add a job option to the job.
+
+
addProperties(Map<String, String>) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Adds the specified properties to the current ones and checks if their names and types are correct.
+
+
addSchedulerArgument(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Add a scheduler specific argument.
+
+
addToBuffer(byte[], int) - Method in class nl.esciencecenter.xenon.utils.OutputReader
+
 
+
AGENT - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
+
Enable the use of an ssh-agent
+
+
AGENT - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
Enable the use of an ssh-agent
+
+
AGENT_FORWARDING - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
+
Enable the use of ssh-agent-forwarding
+
+
AGENT_FORWARDING - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
Enable the use of ssh-agent-forwarding
+
+
ALLOCATION_FILL_UP - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
+
 
+
ALLOCATION_PE_SLOTS - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
+
 
+
ALLOCATION_ROUND_ROBIN - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
+
 
+
allocationRule - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
+
 
+
AllocationRule() - Constructor for enum nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo.AllocationRule
+
 
+
appendToFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
appendToFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
appendToFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
appendToFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
appendToFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
appendToFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
appendToFile(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Open an existing file and return an OutputStream to append data to this file.
+
+
areSamePaths(Path, Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
arguments - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The arguments to pass to the executable.
+
+
asCSList(String[]) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.CommandLineUtils
+
+
Create a single comma separated string out of a list of strings.
+
+
assertDirectoryExists(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
assertFileExists(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
assertFileIsSymbolicLink(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
assertIsOpen() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
assertNonNullOrEmpty(String, String) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
 
+
assertNotNull(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
assertParentDirectoryExists(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
assertPathExists(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
assertPathIsDirectory(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
assertPathIsFile(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
assertPathIsNotDirectory(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
assertPathNotExists(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
assertPositive(long, String) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
 
+
AttributeNotSupportedException - Exception in nl.esciencecenter.xenon.filesystems
+
+
Signals that a requested file attribute is not supported by the underlying file system implementation.
+
+
AttributeNotSupportedException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.AttributeNotSupportedException
+
 
+
AttributeNotSupportedException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.AttributeNotSupportedException
+
 
+
AUTOMATICALLY_ADD_HOST_KEY - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
+
Enable strict host key checking.
+
+
AUTOMATICALLY_ADD_HOST_KEY - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
Enable strict host key checking.
+
+
available() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpInputStream
+
 
+
+ + + +

B

+
+
BadParameterException - Exception in nl.esciencecenter.xenon.adaptors.schedulers
+
+
Signals that a parameter has an invalid value.
+
+
BadParameterException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.adaptors.schedulers.BadParameterException
+
 
+
BadParameterException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.schedulers.BadParameterException
+
 
+
BAR_REGEX - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingParser
+
 
+
BatchProcess - Class in nl.esciencecenter.xenon.adaptors.schedulers
+
+
BatchProcess wraps an InteractiveProcess to emulate a batch process.
+
+
BatchProcess(FileSystem, Path, JobDescription, String, InteractiveProcessFactory, long) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.BatchProcess
+
 
+
bitsToPermissions(int) - Static method in class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
 
+
bucket - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
buffer - Variable in class nl.esciencecenter.xenon.utils.OutputReader
+
 
+
BUFFER_SIZE - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
+
The buffer size to use when copying data.
+
+
BUFFER_SIZE - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileAdaptor
+
+
The buffer size to use when copying data.
+
+
BUFFER_SIZE - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileAdaptor
+
+
The buffer size to use when copying data.
+
+
BUFFER_SIZE - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor
+
+
The buffer size to use when copying data.
+
+
BUFFER_SIZE - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
+
The buffer size to use when copying data.
+
+
BUFFER_SIZE - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileAdaptor
+
+
The buffer size to use when copying data.
+
+
BUFFER_SIZE - Static variable in class nl.esciencecenter.xenon.utils.OutputReader
+
 
+
bufferSize - Variable in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil.Tunnel
+
 
+
bufferSize - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
bufferSize - Variable in class nl.esciencecenter.xenon.utils.StreamForwarder
+
 
+
buildCommand(JobDescription) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcess
+
 
+
bytesCopied() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
+
+
Get the number of bytes that have been copied.
+
+
bytesCopied - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyCallback
+
 
+
bytesCopied - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
bytesCopied() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
bytesToCopy() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
+
+
Get the number of bytes that need to be copied for the entire copy operation.
+
+
bytesToCopy - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyCallback
+
 
+
bytesToCopy - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
bytesToCopy() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
+ + + +

C

+
+
calculateSlots(String, String, int) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
 
+
callback - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem.PendingCopy
+
 
+
canAppend() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor
+
 
+
canAppend() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
 
+
canAppend() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor
+
 
+
canAppend() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileAdaptor
+
 
+
canAppend() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
+
 
+
cancel(String) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Cancel a copy operation.
+
+
cancel() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyCallback
+
 
+
cancelJob(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
cancelJob(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
cancelJob(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
cancelJob(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
cancelJob(String) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Cancel a job.
+
+
cancelled - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyCallback
+
 
+
canCreateSymboliclinks() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor
+
 
+
canCreateSymboliclinks() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileAdaptor
+
 
+
canCreateSymboliclinks() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileAdaptor
+
 
+
canCreateSymboliclinks() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor
+
 
+
canCreateSymboliclinks() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
 
+
canCreateSymboliclinks() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
+
+
Can this adaptor create symbolic links ? + + In third party copy, a file is copied between two remote locations, without passing through the local machine first.
+
+
canReadSymboliclinks() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor
+
 
+
canReadSymboliclinks() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileAdaptor
+
 
+
canReadSymboliclinks() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor
+
 
+
canReadSymboliclinks() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileAdaptor
+
 
+
canReadSymboliclinks() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
+
+
Can this adaptor read symbolic links ?
+
+
certfile - Variable in class nl.esciencecenter.xenon.credentials.CertificateCredential
+
+
This member variables holds the URI of the file containing the certificate.
+
+
CertificateCredential - Class in nl.esciencecenter.xenon.credentials
+
+
A container for security Information based upon certificates.
+
+
CertificateCredential(String, String, char[]) - Constructor for class nl.esciencecenter.xenon.credentials.CertificateCredential
+
+
Constructs a CertificateCredential out of a username, a certificate file containing a private key, and an optional passphrase.
+
+
CertificateNotFoundException - Exception in nl.esciencecenter.xenon.adaptors.shared.ssh
+
+
Signals that a certificate file could not be found.
+
+
CertificateNotFoundException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.adaptors.shared.ssh.CertificateNotFoundException
+
 
+
CertificateNotFoundException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.shared.ssh.CertificateNotFoundException
+
 
+
channel - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcess
+
 
+
channel - Variable in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil.Tunnel
+
 
+
checkClientReply(FTPClient, String) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
checkClientReply(String) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
checkClosed() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
checkClosed() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
checkForNullAndSeparator(char, List<String>) - Static method in class nl.esciencecenter.xenon.filesystems.Path
+
 
+
checkIfContains(String, String, String...) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingParser
+
+
Checks if the given text contains any of the given options.
+
+
checkQueue(String[], String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
+
Check if the given queueName is presents in queueNames.
+
+
checkQueueNames(String[]) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
+
Checks if the queue names given are valid, and throw an exception otherwise.
+
+
checkType(XenonPropertyDescription, String, String) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
 
+
checkVersion(Document) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineXmlParser
+
 
+
checkVersion() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSetup
+
 
+
checkWorkingDirectory(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
+
Check if the given working directory exists.
+
+
cleanup() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcess
+
 
+
cleanupJob(List<JobExecutor>, String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
cleanupJob(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
cleanValue(String, String...) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingParser
+
+
Remove suffix from a string if present.
+
+
clear(String) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Returns a copy of this XenonProperties that contains all properties but clears the properties that start with the given prefix.
+
+
clearUpdateRequest() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
+
Clear the update signal and wake up any waiting threads
+
+
client - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
client - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
close() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
close() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpInputStream
+
 
+
close() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpOutputStream
+
 
+
close() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
close() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
close() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
close() - Method in interface nl.esciencecenter.xenon.adaptors.schedulers.InteractiveProcessFactory
+
 
+
close() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
close() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcessFactory
+
 
+
close() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
 
+
close() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcessFactory
+
 
+
close() - Method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHConnection
+
 
+
close() - Method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil.Tunnel
+
 
+
close() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Close this FileSystem.
+
+
close() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Close this Scheduler.
+
+
close(Closeable, String) - Method in class nl.esciencecenter.xenon.utils.StreamForwarder
+
+
Closes the input stream, thereby stopping the stream forwarder, and closing the output stream.
+
+
closed - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
closed - Variable in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHConnection
+
 
+
closeServer() - Method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil.Tunnel
+
 
+
closeStreams() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.BatchProcess
+
 
+
CommandLineUtils - Class in nl.esciencecenter.xenon.adaptors.schedulers
+
+
Some simple utilities for handling and creating scripts and command lines.
+
+
CommandLineUtils() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.CommandLineUtils
+
 
+
CommandNotFoundException - Exception in nl.esciencecenter.xenon.adaptors.schedulers.local
+
+
Signals that a command could not be found.
+
+
CommandNotFoundException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.adaptors.schedulers.local.CommandNotFoundException
+
 
+
CommandNotFoundException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.schedulers.local.CommandNotFoundException
+
 
+
CommandRunner - Class in nl.esciencecenter.xenon.adaptors.schedulers.local
+
+
Runs a command.
+
+
CommandRunner(String...) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.local.CommandRunner
+
 
+
CommandRunner(String, File, String...) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.local.CommandRunner
+
 
+
completedPendingFtpCommand - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpInputStream
+
 
+
completedPendingFtpCommand - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpOutputStream
+
 
+
COMPONENT_NAME - Static variable in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
The name of this component, for use in exceptions
+
+
COMPONENT_NAME - Static variable in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
The name of this component, for use in exceptions
+
+
concat(String...) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.CommandLineUtils
+
+
Concatinate a series of Strings using a StringBuilder.
+
+
connect(String, Credential) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
 
+
connect(String, SshClient, String, Credential, int, long) - Static method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
+
+
Connect an existing SshClient to the server at location and authenticate using the given credential.
+
+
connectAndAuthenticate(String, SshClient, String, int, UserCredential, long) - Static method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
+
 
+
connection - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
connection - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcessFactory
+
 
+
CONNECTION_TIMEOUT - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
+
Property for maximum history length for finished jobs
+
+
ConnectionLostException - Exception in nl.esciencecenter.xenon.adaptors.filesystems
+
+
Signals that a connection was lost.
+
+
ConnectionLostException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.adaptors.filesystems.ConnectionLostException
+
 
+
ConnectionLostException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.filesystems.ConnectionLostException
+
 
+
connectToServer(String, int, FTPClient) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
 
+
contains(PosixFilePermission, PosixFilePermission...) - Static method in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
+
Check if a sequence of PosixFilePermissions contains a specific option.
+
+
containsAny(String, String...) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingParser
+
+
Returns if the given input String contains any of the option Strings given.
+
+
containsCredential(String) - Method in class nl.esciencecenter.xenon.credentials.CredentialMap
+
+
Check if the key is stored in this CredentialMap.
+
+
content - Variable in class nl.esciencecenter.xenon.utils.InputWriter
+
 
+
context - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
convertAttributes(Path, FTPFile) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
convertAttributes(Path, SftpClient.Attributes) - Static method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
convertTime(FileTime) - Static method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
copy(Path, FileSystem, Path, CopyMode, boolean) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Asynchronously Copy an existing source path to a target path on a different file system.
+
+
CopyCallback() - Constructor for class nl.esciencecenter.xenon.filesystems.FileSystem.CopyCallback
+
 
+
CopyCancelledException - Exception in nl.esciencecenter.xenon.filesystems
+
 
+
CopyCancelledException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.CopyCancelledException
+
 
+
copyFile(Path, FileSystem, Path, CopyMode, FileSystem.CopyCallback) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Copy a single file to another file system.
+
+
copyIdentifier - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
CopyMode - Enum in nl.esciencecenter.xenon.filesystems
+
+
CopyOption is an enumeration containing all possible options for copying a file.
+
+
CopyMode() - Constructor for enum nl.esciencecenter.xenon.filesystems.CopyMode
+
 
+
copyRecursive(Path, FileSystem, Path, CopyMode, FileSystem.CopyCallback) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
CopyStatus - Interface in nl.esciencecenter.xenon.filesystems
+
+
CopyStatus contains status information for a specific copy operation.
+
+
CopyStatusImplementation(String, String, long, long, XenonException) - Constructor for class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
copySymbolicLink(Path, FileSystem, Path, CopyMode, FileSystem.CopyCallback) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Copy a symbolic link to another file system (optional operation).
+
+
create(String, String, Credential, Map<String, String>) - Static method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Create a new FileSystem using the adaptor that connects to a data store at location using the credentials to get + access.
+
+
create(String, String, Credential) - Static method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Create a new FileSystem using the adaptor that connects to a data store at location using the credentials to get + access.
+
+
create(String, String) - Static method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Create a new FileSystem using the adaptor that connects to a data store at location using the default credentials to get + access.
+
+
create(String) - Static method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Create a new FileSystem using the adaptor that connects to a data store at the default location using the default credentials to get access.
+
+
create(String, String, Credential, Map<String, String>) - Static method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Create a new Scheduler using the adaptor connecting to the location using credentials to get access.
+
+
create(String, String, Credential) - Static method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Create a new Scheduler using the adaptor connecting to the location using credentials to get access.
+
+
create(String, String) - Static method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Create a new Scheduler using the adaptor connecting to the location using the default credentials to get access.
+
+
create(String) - Static method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Create a new Scheduler using the adaptor connecting to the default location and using the default credentials to get access.
+
+
createDirectories(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Creates a new directory, failing if the directory already exists.
+
+
createDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
createDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
createDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
createDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
createDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
createDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
createDirectory(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Creates a new directory, failing if the directory already exists.
+
+
createFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
createFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
createFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
createFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
createFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
createFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
createFile(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Creates a new empty file, failing if the file already exists.
+
+
createFileSystem(String, Credential, Map<String, String>) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor
+
 
+
createFileSystem(String, Credential, Map<String, String>) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
 
+
createFileSystem(String, Credential, Map<String, String>) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileAdaptor
+
 
+
createFileSystem(String, Credential, Map<String, String>) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileAdaptor
+
 
+
createFileSystem(String, Credential, Map<String, String>) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor
+
 
+
createFileSystem(String, Credential, Map<String, String>) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
 
+
createFileSystem(String, Credential, Map<String, String>) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileAdaptor
+
 
+
createInteractiveProcess(JobDescription, String, String, long) - Method in interface nl.esciencecenter.xenon.adaptors.schedulers.InteractiveProcessFactory
+
 
+
createInteractiveProcess(JobDescription, String, String, long) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcessFactory
+
 
+
createInteractiveProcess(JobDescription, String, String, long) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcessFactory
+
 
+
createOutputStream(FileSystem, Path, String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.BatchProcess
+
 
+
createScheduler(String, Credential, Map<String, String>) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSchedulerAdaptor
+
 
+
createScheduler(String, Credential, Map<String, String>) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
 
+
createScheduler(String, Credential, Map<String, String>) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.SchedulerAdaptor
+
 
+
createScheduler(String, Credential, Map<String, String>) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSchedulerAdaptor
+
 
+
createScheduler(String, Credential, Map<String, String>) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
 
+
createScheduler(String, Credential, Map<String, String>) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueSchedulerAdaptor
+
 
+
createSftpClient() - Method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHConnection
+
 
+
createSSHClient() - Static method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
+
+
Create a new SshClient with a default configuration similar to a stand-alone SSH client.
+
+
createSSHClient(boolean, boolean, boolean, boolean, boolean) - Static method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
+
+
Create a new SshClient with the desired configuration.
+
+
createSymbolicLink(Path, Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
createSymbolicLink(Path, Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
createSymbolicLink(Path, Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
createSymbolicLink(Path, Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
createSymbolicLink(Path, Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
createSymbolicLink(Path, Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
createSymbolicLink(Path, Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Creates a new symbolic link, failing if the link already exists (optional operation).
+
+
creationTime - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
The creation time of this file
+
+
credential - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
Credential - Interface in nl.esciencecenter.xenon.credentials
+
+
Credential represents a user credential uses to gain access to a resource.
+
+
credential - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
credential - Variable in class nl.esciencecenter.xenon.schedulers.Scheduler
+
 
+
CredentialMap - Class in nl.esciencecenter.xenon.credentials
+
+
A Credential consisting of a collection of Credentials each uniquely identified by a String (typically a host name or host alias).
+
+
CredentialMap() - Constructor for class nl.esciencecenter.xenon.credentials.CredentialMap
+
+
Create a new CredentialMap using null as the default credential.
+
+
CredentialMap(UserCredential) - Constructor for class nl.esciencecenter.xenon.credentials.CredentialMap
+
+
Creates a new CredentialMap and set the default credential to defaultCredential.
+
+
CredentialNotFoundException - Exception in nl.esciencecenter.xenon.adaptors.shared.ssh
+
+
Signals that a credential could not be found.
+
+
CredentialNotFoundException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.adaptors.shared.ssh.CredentialNotFoundException
+
 
+
CredentialNotFoundException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.shared.ssh.CredentialNotFoundException
+
 
+
curIterator - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem.ListingIterator
+
 
+
curPageSet - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem.ListingIterator
+
 
+
currentID - Static variable in class nl.esciencecenter.xenon.adaptors.Adaptor
+
 
+
+ + + +

D

+
+
DaemonThreadFactory() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler.DaemonThreadFactory
+
 
+
Deadline - Class in nl.esciencecenter.xenon.adaptors.schedulers
+
 
+
Deadline() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.Deadline
+
+
No need to use this constructor, use static methods instead.
+
+
DEFAULT_BUFFER_SIZE - Static variable in class nl.esciencecenter.xenon.utils.StreamForwarder
+
 
+
DEFAULT_MAX_RUN_TIME_IN_MINUTES - Static variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The default maximum run time
+
+
DEFAULT_PORT - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
+
The default SSH port
+
+
DEFAULT_PORT - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileAdaptor
+
+
The default SSH port
+
+
DEFAULT_PORT - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
+
The default SSH port
+
+
DEFAULT_PORT - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
The default SSH port
+
+
DEFAULT_SEPARATOR - Static variable in class nl.esciencecenter.xenon.filesystems.Path
+
+
The default separator to use.
+
+
DEFAULT_SSH_PORT - Static variable in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
+
 
+
defaultCredential - Variable in class nl.esciencecenter.xenon.credentials.CredentialMap
+
 
+
DefaultCredential - Class in nl.esciencecenter.xenon.credentials
+
+
This class represents the default credential that may be used by the various adaptors.
+
+
DefaultCredential() - Constructor for class nl.esciencecenter.xenon.credentials.DefaultCredential
+
 
+
DefaultCredential(String) - Constructor for class nl.esciencecenter.xenon.credentials.DefaultCredential
+
 
+
defaultQueueName - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
defaultValue - Variable in class nl.esciencecenter.xenon.XenonPropertyDescription
+
 
+
delete(Path, boolean) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
delete(Path, boolean) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Deletes an existing path.
+
+
deleteDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
deleteDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
deleteDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
deleteDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
deleteDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
deleteDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
deleteDirectory(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Delete an empty directory.
+
+
deletedJobs - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
deletedJobs - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
deleteFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
deleteFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
deleteFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
deleteFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
deleteFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
deleteFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
deleteFile(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Delete a file.
+
+
deleteLocal(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
description - Variable in class nl.esciencecenter.xenon.adaptors.Adaptor
+
 
+
description - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
description - Variable in class nl.esciencecenter.xenon.XenonPropertyDescription
+
 
+
destination - Variable in class nl.esciencecenter.xenon.utils.InputWriter
+
 
+
destroy() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.BatchProcess
+
 
+
destroy() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcess
+
+
Destroy (stop) process.
+
+
destroy() - Method in interface nl.esciencecenter.xenon.adaptors.schedulers.Process
+
 
+
destroy() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcess
+
 
+
DirectoryNotEmptyException - Exception in nl.esciencecenter.xenon.filesystems
+
+
Signals that directory is not empty.
+
+
DirectoryNotEmptyException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.DirectoryNotEmptyException
+
 
+
DirectoryNotEmptyException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.DirectoryNotEmptyException
+
 
+
dirExists(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
DISABLE_ACCOUNTING_USAGE - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSchedulerAdaptor
+
+
Should the accounting usage be disabled?
+
+
documentBuilder - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineXmlParser
+
 
+
documentBuilder - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueXmlParser
+
 
+
done - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
done - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
 
+
done - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcess
+
 
+
done - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcess
+
 
+
done - Variable in class nl.esciencecenter.xenon.utils.StreamForwarder
+
 
+
done() - Method in class nl.esciencecenter.xenon.utils.StreamForwarder
+
+
Tell the daemon thread that we are done.
+
+
DONE_STATE - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
DONE_STATE - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
+
In completed state, the job has terminated and all processes have returned exit code 0.
+
+
+ + + +

E

+
+
elements - Variable in class nl.esciencecenter.xenon.filesystems.Path
+
+
The path elements in this path
+
+
emptyMap(int) - Static method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Creates empty mutable Map with sufficient initial capacity.
+
+
end() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
EndOfFileException - Exception in nl.esciencecenter.xenon.adaptors.filesystems
+
+
Signals that an end-of-file was encountered.
+
+
EndOfFileException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.adaptors.filesystems.EndOfFileException
+
 
+
EndOfFileException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.filesystems.EndOfFileException
+
 
+
endsWith(Path) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Tests if this Path ends with the given Path.
+
+
endsWith(String) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Tests if this Path ends with the given Path represented as a String.
+
+
ensureDirectoryExists(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
environment - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The environment variables and their values
+
+
equals(Object) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
equals(Object) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
 
+
equals(Object) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.StreamsImplementation
+
 
+
equals(Object) - Method in class nl.esciencecenter.xenon.credentials.CertificateCredential
+
 
+
equals(Object) - Method in class nl.esciencecenter.xenon.credentials.CredentialMap
+
 
+
equals(Object) - Method in class nl.esciencecenter.xenon.credentials.DefaultCredential
+
 
+
equals(Object) - Method in class nl.esciencecenter.xenon.credentials.KeytabCredential
+
 
+
equals(Object) - Method in class nl.esciencecenter.xenon.credentials.PasswordCredential
+
 
+
equals(Object) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
equals(Object) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
equals(Object) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
 
+
equals(Object) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
 
+
equals(Object) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
 
+
equals(Object) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
 
+
EQUALS_REGEX - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingParser
+
 
+
err - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.CommandRunner
+
 
+
error - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
error - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.RemoteCommandRunner
+
 
+
ERROR_STATE - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
ex - Variable in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil.Tunnel
+
 
+
exception - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
 
+
exception - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.QueueStatusImplementation
+
 
+
exception - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
exclude(String) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Returns a copy of this XenonProperties that contains all properties except the properties that start with the given prefix.
+
+
EXEC_GROUP - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
+
execute/search by group
+
+
EXEC_OTHERS - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
+
execute/search by others
+
+
EXEC_OWNER - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
+
execute/search by owner
+
+
executable - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Is the file executable ?
+
+
executable - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The executable to run.
+
+
exists(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
exists(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
exists(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
exists(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
exists(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
exists(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
exists(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Tests if a path exists.
+
+
exitCode - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
 
+
exitCode - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.CommandRunner
+
 
+
exitCode - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcess
+
 
+
exitCode - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.RemoteCommandRunner
+
 
+
exitcodeFromString(String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
 
+
exitStatus - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
expandTilde(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
+
Expand the tilde in a String representation of a path by the users home directory, as provided by the user.home property.
+
+
extractCredential(SshdSocketAddress, Credential) - Static method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
+
 
+
extractCredentials(String, SshdSocketAddress[], Credential) - Static method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
+
 
+
extractLocations(String, String) - Static method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
+
+
Extract a series of locations from a location string.
+
+
extractSocketAddress(String, String) - Static method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
+
 
+
+ + + +

F

+
+
factory - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
factory - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
FAILED_STATES - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
+
These are the states a job can be in when it has failed: FAILED: the job terminated with non-zero exit code or other failure condition.
+
+
FileAdaptor - Class in nl.esciencecenter.xenon.adaptors.filesystems
+
 
+
FileAdaptor(String, String, String[], XenonPropertyDescription[]) - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor
+
 
+
fileExists(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
filesystem - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
filesystem - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
FileSystem - Class in nl.esciencecenter.xenon.filesystems
+
+
FileSystem represent a (possibly remote) file system that can be used to access data.
+
+
FileSystem(String, String, String, Credential, Path, int, XenonProperties) - Constructor for class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
FileSystem.CopyCallback - Class in nl.esciencecenter.xenon.filesystems
+
 
+
FileSystem.CopyStatusImplementation - Class in nl.esciencecenter.xenon.filesystems
+
+
CopyStatus contains status information for a specific copy operation.
+
+
FileSystem.PendingCopy - Class in nl.esciencecenter.xenon.filesystems
+
 
+
FileSystemAdaptorDescription - Interface in nl.esciencecenter.xenon.filesystems
+
 
+
FileSystemClosedException - Exception in nl.esciencecenter.xenon.filesystems
+
+
Signals that a unknown Copy handle was provided.
+
+
FileSystemClosedException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.FileSystemClosedException
+
 
+
FileSystemClosedException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.FileSystemClosedException
+
 
+
filter(String) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Returns a new XenonProperties that contains only the properties whose key start with a certain prefix.
+
+
filterOnKey(Map<K, V>, Predicate<K>) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
 
+
filterUsingPredicate(Predicate<String>) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
 
+
findFTPFile(FTPFile[], Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
findInteractiveJob(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
findInteractiveJobInMap(Map<String, Map<String, String>>, String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
findJob(List<JobExecutor>, String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
findJob(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
finished - Variable in class nl.esciencecenter.xenon.utils.InputWriter
+
 
+
finished - Variable in class nl.esciencecenter.xenon.utils.OutputReader
+
 
+
flush() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpOutputStream
+
 
+
fromHDFSPath(Path) - Static method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
fs - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
ftpClient - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
ftpClient - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpInputStream
+
 
+
ftpClient - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpOutputStream
+
 
+
FtpFileAdaptor - Class in nl.esciencecenter.xenon.adaptors.filesystems.ftp
+
 
+
FtpFileAdaptor() - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
 
+
FtpFileSystem - Class in nl.esciencecenter.xenon.adaptors.filesystems.ftp
+
 
+
FtpFileSystem(String, String, String, Path, int, FTPClient, Credential, FtpFileAdaptor, XenonProperties) - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
FtpInputStream - Class in nl.esciencecenter.xenon.adaptors.filesystems.ftp
+
+
Wraps an InputStream instance.
+
+
FtpInputStream(InputStream, FTPClient) - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpInputStream
+
 
+
FtpOutputStream - Class in nl.esciencecenter.xenon.adaptors.filesystems.ftp
+
+
Wraps an OutputStream instance.
+
+
FtpOutputStream(OutputStream, FTPClient) - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpOutputStream
+
 
+
future - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem.PendingCopy
+
 
+
+ + + +

G

+
+
GATEWAY - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
+
Add gateway to access machine.
+
+
GATEWAY - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
Add gateway to access machine.
+
+
generate(JobDescription, Path, GridEngineSetup) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
generate(JobDescription, Path) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
 
+
generate(JobDescription, Path) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueUtils
+
 
+
generateInteractiveArguments(JobDescription, Path, UUID) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
 
+
generateParallelEnvironmentSpecification(JobDescription, GridEngineSetup, Formatter) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
generateParallelScriptContent(JobDescription, Formatter) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
generateScriptContent(JobDescription, Formatter) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueUtils
+
 
+
generateSerialScriptContent(JobDescription, Formatter) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
get(String) - Method in class nl.esciencecenter.xenon.credentials.CredentialMap
+
+
Retrieve the UserCredential stored using the key.
+
+
getAbsolutePath() - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Return a String representation of this Path interpreted as an absolute path.
+
+
getAdaptorByName(String) - Static method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
getAdaptorByName(String) - Static method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
 
+
getAdaptorDescription(String) - Static method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Gives the description of the adaptor with the given name.
+
+
getAdaptorDescription(String) - Static method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Gives the description of the adaptor with the given name.
+
+
getAdaptorDescriptions() - Static method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Gives a list of the descriptions of the available adaptors.
+
+
getAdaptorDescriptions() - Static method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Gives a list of the descriptions of the available adaptors.
+
+
getAdaptorName() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Get the name of the adaptor that created this FileSystem.
+
+
getAdaptorName() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Get the name of the adaptor that created this Scheduler.
+
+
getAdaptorNames() - Static method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Gives a list names of the available adaptors.
+
+
getAdaptorNames() - Static method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Gives a list names of the available adaptors.
+
+
getAllocationRule() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
+
 
+
getArguments() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Get the command line arguments of the executable.
+
+
getArguments() - Method in class nl.esciencecenter.xenon.utils.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.utils.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 class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
getAttributes(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
getAttributes(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
getAttributes(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
getAttributes(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
getAttributes(Path, DavResource) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
getAttributes(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
getAttributes(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Get the PathAttributes of an existing path.
+
+
getBooleanProperty(String) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Retrieves the value of a boolean property with the given name.
+
+
getCertificateFile() - Method in class nl.esciencecenter.xenon.credentials.CertificateCredential
+
+
Returns the certificate file.
+
+
getCopyIdentifier() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
+
+
Get the copy identifier for which this CopyStatus was created.
+
+
getCopyIdentifier() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
getCreationTime() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Get the creation time for this file.
+
+
getCreationTime() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Get the creation time for this file.
+
+
getCredential() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Get the credential that this FileSystem is using.
+
+
getCredential() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Get the credential that this Scheduler is using.
+
+
getCurrentJobID() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
getCurrentWorkingDirectory(FTPClient, String) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
 
+
getCurrentWorkingDirectory(SftpClient, String) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
 
+
getDeadline(long) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.Deadline
+
+
Calculate the epoch timestamp when a timeout will expire.
+
+
getDefault() - Method in class nl.esciencecenter.xenon.credentials.CredentialMap
+
+
Returns the default UserCredential.
+
+
getDefaultQueueName() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
getDefaultQueueName() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
getDefaultQueueName() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
getDefaultQueueName() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
getDefaultQueueName() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Get the name of the default queue.
+
+
getDefaultValue() - Method in class nl.esciencecenter.xenon.XenonPropertyDescription
+
+
Returns the default value for this property.
+
+
getDescription() - Method in interface nl.esciencecenter.xenon.AdaptorDescription
+
+
Get the description of the adaptor.
+
+
getDescription() - Method in class nl.esciencecenter.xenon.adaptors.Adaptor
+
 
+
getDescription() - Method in class nl.esciencecenter.xenon.XenonPropertyDescription
+
+
Returns a human readable description of this property.
+
+
getDirectoryPath(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
getDoubleProperty(String) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Retrieves the value of an double property with the given name.
+
+
getEnvironment() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Get the environment of the executable.
+
+
getError() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
getException() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
+
Get the exception produced by the Job or while retrieving the status.
+
+
getException() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.QueueStatusImplementation
+
+
Get the exception produced by the queue, or null if hasException() returns false.
+
+
getException() - Method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil.Tunnel
+
 
+
getException() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
+
+
Get the exception produced by the Copy or while retrieving the status.
+
+
getException() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
getException() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
+
+
Get the exception produced by the Job or while retrieving the status.
+
+
getException() - Method in interface nl.esciencecenter.xenon.schedulers.QueueStatus
+
+
Get the exception produced by the queue, or null if hasException() returns false.
+
+
getExecutable() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Get the path to the executable.
+
+
getExecutable() - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
+
Returns the executable.
+
+
getExeFile(String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.local.CommandRunner
+
 
+
getExitCode() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
+
Get the exit code for the Job.
+
+
getExitCode() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.local.CommandRunner
+
 
+
getExitCode() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.RemoteCommandRunner
+
 
+
getExitCode() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
+
+
Get the exit code for the Job.
+
+
getExitStatus() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.BatchProcess
+
 
+
getExitStatus() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcess
+
 
+
getExitStatus() - Method in interface nl.esciencecenter.xenon.adaptors.schedulers.Process
+
 
+
getExitStatus() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcess
+
 
+
getFileName() - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Get the file name or null if the Path is empty.
+
+
getFileNameAsString() - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Get the file name as a String, or null if the Path is empty.
+
+
getFilePath(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
getFileSystem() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
getFileSystem() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
 
+
getFileSystem() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Retrieve the FileSystem used internally by this Scheduler.
+
+
getFTPFileInfo(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
getGroup() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Get the group of this file.
+
+
getGroup() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Get the group of this file (optional operation).
+
+
getHost(String, String) - Static method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
+
 
+
getIntegerProperty(String) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Retrieves the value of an integer property with the given name.
+
+
getIntegerProperty(String, int) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Retrieves the value of an integer property with the given name.
+
+
getJavaArguments() - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
+
Returns the arguments for the main class.
+
+
getJavaClasspath() - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
+
Returns the java class path.
+
+
getJavaMain() - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
+
Returns the main class of the java application.
+
+
getJavaOptions() - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
+
Returns the JVM options.
+
+
getJavaSystemProperties() - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
+
Returns the java system properties.
+
+
getJobDescription() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
getJobIdentifier() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
getJobIdentifier() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
+
Get the job identifier of the Job for which this JobStatus was created.
+
+
getJobIdentifier() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.StreamsImplementation
+
+
Get the identifier of the job for which this Streams was created.
+
+
getJobIdentifier() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
+
+
Get the job identifier of the Job for which this JobStatus was created.
+
+
getJobIdentifier() - Method in interface nl.esciencecenter.xenon.schedulers.Streams
+
+
Get the identifier of the job for which this Streams was created.
+
+
getJobOptions() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Get a copy of the job options of this job.
+
+
getJobs(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
getJobs(List<JobExecutor>, List<String>) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
getJobs(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
getJobs(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
getJobs(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
getJobs(String...) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Get all job identifier of jobs currently in (one ore more) queues.
+
+
getJobStatus(Map<String, Map<String, String>>, String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
+
Get job status.
+
+
getJobStatus(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
getJobStatus(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
getJobStatus(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
getJobStatus(Map<String, Map<String, String>>, String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
+
Get job status.
+
+
getJobStatus(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
getJobStatus(String) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Get the status of a Job.
+
+
getJobStatuses(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
getJobStatuses(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
getJobStatuses(String...) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Get the status of all specified jobs.
+
+
getJobStatusFromQacctInfo(Map<String, String>, String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
getJobStatusFromQstatInfo(Map<String, Map<String, String>>, String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
getJobStatusFromQstatInfo(Map<String, Map<String, String>>, String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueUtils
+
 
+
getJobStatusFromSacctInfo(Map<String, Map<String, String>>, String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
 
+
getJobStatusFromScontrolInfo(Map<String, String>, String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
 
+
getJobStatusFromSqueueInfo(Map<String, Map<String, String>>, String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
 
+
getKeytabFile() - Method in class nl.esciencecenter.xenon.credentials.KeytabCredential
+
 
+
getKilled() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
getLastAccessTime() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Get the last access time for this file.
+
+
getLastAccessTime() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Get the last access time for this file.
+
+
getLastModifiedTime() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Get the last modified time for this file.
+
+
getLastModifiedTime() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Get the last modified time for this file.
+
+
getLocalFileAttributes(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
getLocalFileAttributes(Path, Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
getLocalFileSystems() - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
+
Returns all local FileSystems.
+
+
getLocalRoot(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
+
Return the locally valid root element of an String representation of an absolute path.
+
+
getLocalRootlessPath(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
+
Return the local root less path of an absolute path.
+
+
getLocalSeparator() - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
+
Returns the local file system path separator character.
+
+
getLocation() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Get the location of the FileSystem.
+
+
getLocation() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Get the location that this Scheduler is connected to.
+
+
getLongProperty(String) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Retrieves the value of an long property with the given name.
+
+
getMaxMemory() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Get the amount of memory needed for process (in MBytes).
+
+
getMaxRuntime() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Get the maximum job duration 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.AdaptorDescription
+
+
Get the name of the adaptor.
+
+
getName() - Method in class nl.esciencecenter.xenon.adaptors.Adaptor
+
 
+
getName() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
+
 
+
getName() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.QueueInfo
+
 
+
getName() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
+
Get the name of the Job for which this JobStatus was created.
+
+
getName(int) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Get an element of this Path.
+
+
getName() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Get the job name.
+
+
getName() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
+
+
Get the name of the Job for which this JobStatus was created.
+
+
getName() - Method in class nl.esciencecenter.xenon.XenonPropertyDescription
+
+
Returns the name of the property.
+
+
getNameCount() - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Get the number of elements in the Path.
+
+
getNaturalProperty(String) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Retrieves the value of an natural number property (e.g.
+
+
getNewUniqueID() - Method in class nl.esciencecenter.xenon.adaptors.Adaptor
+
 
+
getNext() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem.ListingIterator
+
 
+
getNextCopyID() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
getNodeCount() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Get the number of nodes.
+
+
getOwner() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Get the owner of this file.
+
+
getOwner() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Get the owner of this file (optional operation).
+
+
getParallelEnvironments(GridEngineScheduler) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
 
+
getParallelEnvironments() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.QueueInfo
+
 
+
getParent() - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Get the parent Path, or null if this Path does not have a parent.
+
+
getPassword(String) - Method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil.PasswordProvider
+
 
+
getPassword() - Method in class nl.esciencecenter.xenon.credentials.PasswordCredential
+
+
Gets the password.
+
+
getPath() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Get the path these attributes belong to.
+
+
getPath() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Get the path these attributes belong to.
+
+
getPathSeparator() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Get the path separator used by this file system.
+
+
getPermissions(FTPFile) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
getPermissions() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Get the permissions of this file.
+
+
getPermissions() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Get the permissions of this file (optional operation).
+
+
getPort(String, String) - Static method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
+
 
+
getPosixFilePermission(int, int) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
getPpn() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
+
 
+
getProcessesPerNode() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Get the number of processes to start on each node.
+
+
getProperties(XenonPropertyDescription[], String, Map<String, String>) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingUtils
+
 
+
getProperties() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Get the properties used to create this FileSystem.
+
+
getProperties() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Get the properties used to create this Scheduler.
+
+
getProperty(String) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Retrieves the value of a property with the given name without checking its type.
+
+
getProperty(String, XenonPropertyDescription.Type) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
 
+
getPropertyNames() - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Returns a sorted list of all supported property names.
+
+
getQacctInfo(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
getQstatInfo() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
getQstatInfo() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
getQueueName() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.QueueStatusImplementation
+
+
Get the queue name.
+
+
getQueueName() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Get the queue name;
+
+
getQueueName() - Method in interface nl.esciencecenter.xenon.schedulers.QueueStatus
+
+
Get the queue name.
+
+
getQueueNames() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
getQueueNames(GridEngineScheduler) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
 
+
getQueueNames() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
 
+
getQueueNames() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
getQueueNames() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
getQueueNames() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
getQueueNames() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Get the queue names supported by this Scheduler.
+
+
getQueues(String[], GridEngineScheduler) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
 
+
getQueueStatus(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
getQueueStatus(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
getQueueStatus(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
getQueueStatus(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
getQueueStatus(String) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Get the status of the queue.
+
+
getQueueStatuses(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
getQueueStatuses(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
getQueueStatuses(Map<String, Map<String, String>>, String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
 
+
getQueueStatuses(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
getQueueStatuses(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
getQueueStatuses(String...) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Get the status of all queues.
+
+
getQueueStatusFromSInfo(Map<String, Map<String, String>>, String, Scheduler) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
 
+
getRelativePath() - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Return a String representation of this Path interpreted as a relative path.
+
+
getResult() - Method in class nl.esciencecenter.xenon.utils.OutputReader
+
+
Returns the data that has been read from the InputStream as a byte array.
+
+
getResultAsString() - Method in class nl.esciencecenter.xenon.utils.OutputReader
+
+
Returns the data that has been read from the InputStream as a String.
+
+
getSacctInfo(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
getScheduler() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.QueueStatusImplementation
+
+
Get the Scheduler that produced this QueueStatus.
+
+
getScheduler() - Method in interface nl.esciencecenter.xenon.schedulers.QueueStatus
+
+
Get the Scheduler that produced this QueueStatus.
+
+
getSchedulerArguments() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Get the scheduler specific arguments.
+
+
getSchedulerSpecificInformation() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
+
Get scheduler specific information on the Job.
+
+
getSchedulerSpecificInformation() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.QueueStatusImplementation
+
+
Get scheduler specific information on the queue.
+
+
getSchedulerSpecificInformation() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
+
+
Get scheduler specific information on the Job.
+
+
getSchedulerSpecificInformation() - Method in interface nl.esciencecenter.xenon.schedulers.QueueStatus
+
+
Get scheduler specific information on the queue.
+
+
getSControlInfo(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
getSeparator() - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Get the separator.
+
+
getSession() - Method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHConnection
+
 
+
getSinfoInfo(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
getSize() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Get the size of this file in bytes.
+
+
getSize() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Get the size of this file in bytes.
+
+
getSizeProperty(String) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Retrieves the value of a size property with the given name.
+
+
getSlots() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
+
 
+
getSlots() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.QueueInfo
+
 
+
getSqueueInfo(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
getState() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
getState() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
+
Get the state of the Job.
+
+
getState() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
+
+
Get the state of the Copy operation.
+
+
getState() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
getState() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
+
+
Get the state of the Job.
+
+
getStatus() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
getStatus(String) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Retrieve the status of an copy.
+
+
getStderr() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.local.CommandRunner
+
 
+
getStderr() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.RemoteCommandRunner
+
 
+
getStderr() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.StreamsImplementation
+
+
Returns the standard error stream of job.
+
+
getStderr() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Gets the path to the file to which the executable must redirect stderr.
+
+
getStderr() - Method in interface nl.esciencecenter.xenon.schedulers.Streams
+
+
Returns the standard error stream of job.
+
+
getStdin() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.StreamsImplementation
+
+
Returns the standard input stream of job.
+
+
getStdin() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Gets the path to the file from which the executable must redirect stdin.
+
+
getStdin() - Method in interface nl.esciencecenter.xenon.schedulers.Streams
+
+
Returns the standard input stream of job.
+
+
getStdout() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.local.CommandRunner
+
 
+
getStdout() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.RemoteCommandRunner
+
 
+
getStdout() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.StreamsImplementation
+
+
Returns the standard output stream of job.
+
+
getStdout() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Gets the path to the file to which the executable must redirect stdout.
+
+
getStdout() - Method in interface nl.esciencecenter.xenon.schedulers.Streams
+
+
Returns the standard output stream of job.
+
+
getStreams() - Method in interface nl.esciencecenter.xenon.adaptors.schedulers.InteractiveProcess
+
 
+
getStreams() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
getStreams() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcess
+
 
+
getStreams() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcess
+
 
+
getStringProperty(String) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Retrieves the value of a string property with the given name.
+
+
getSupportedCredentials() - Method in interface nl.esciencecenter.xenon.AdaptorDescription
+
+
Get the supported credential types for this adaptor.
+
+
getSupportedCredentials() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
 
+
getSupportedCredentials() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileAdaptor
+
 
+
getSupportedCredentials() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileAdaptor
+
 
+
getSupportedCredentials() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor
+
 
+
getSupportedCredentials() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
 
+
getSupportedCredentials() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileAdaptor
+
 
+
getSupportedCredentials() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
 
+
getSupportedCredentials() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingSchedulerAdaptor
+
 
+
getSupportedCredentials() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
 
+
getSupportedLocations() - Method in interface nl.esciencecenter.xenon.AdaptorDescription
+
+
Get the supported locations for this adaptor.
+
+
getSupportedLocations() - Method in class nl.esciencecenter.xenon.adaptors.Adaptor
+
 
+
getSupportedProperties() - Method in interface nl.esciencecenter.xenon.AdaptorDescription
+
+
Returns an array containing all properties this adaptor supports.
+
+
getSupportedProperties() - Method in class nl.esciencecenter.xenon.adaptors.Adaptor
+
 
+
getSupportedProperties() - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Returns the descriptions of all supported properties.
+
+
getThreadsPerProcess() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Get the number of threads needed per process.
+
+
getType() - Method in class nl.esciencecenter.xenon.XenonPropertyDescription
+
+
Returns the type of the property.
+
+
getUsername() - Method in class nl.esciencecenter.xenon.credentials.DefaultCredential
+
 
+
getUsername() - Method in class nl.esciencecenter.xenon.credentials.KeytabCredential
+
 
+
getUsername() - Method in class nl.esciencecenter.xenon.credentials.PasswordCredential
+
 
+
getUsername() - Method in interface nl.esciencecenter.xenon.credentials.UserCredential
+
+
Returns the user name associated with this credential.
+
+
getWorkingDirectory() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
 
+
getWorkingDirectory() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Get the current working directory of this file system.
+
+
getWorkingDirectory() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Gets the path of the working directory for the executable.
+
+
getWorkingDirPath(JobDescription, Path) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
 
+
GIGA - Static variable in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
One giga is a kilo*kilo*kilo
+
+
GridEngineScheduler - Class in nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+
+
Interface to the GridEngine command line tools.
+
+
GridEngineScheduler(String, String, Credential, XenonPropertyDescription[], Map<String, String>) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
GridEngineSchedulerAdaptor - Class in nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+
 
+
GridEngineSchedulerAdaptor() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSchedulerAdaptor
+
 
+
GridEngineSetup - Class in nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+
+
Holds some info on the specifics of the machine we are connected to, such as queues and parallel environments.
+
+
GridEngineSetup(GridEngineScheduler) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
 
+
GridEngineSetup(String[], Map<String, QueueInfo>, Map<String, ParallelEnvironmentInfo>) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
+
Testing constructor.
+
+
GridEngineUtils - Class in nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+
+
Generator for GridEngine job script.
+
+
GridEngineUtils() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
GridEngineXmlParser - Class in nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+
+
Parses xml output from various grid engine command line tools.
+
+
GridEngineXmlParser(boolean) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineXmlParser
+
 
+
group - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
The group of this file
+
+
+ + + +

H

+
+
HADOOP_SETTINGS_FILE - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileAdaptor
+
 
+
hasException() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
+
Has the Job or job retrieval produced a exception ?
+
+
hasException() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.QueueStatusImplementation
+
+
Did the queue produce an exception ?
+
+
hasException() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
+
+
Has the Copy or status retrieval produced a exception ?
+
+
hasException() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
hasException() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
+
+
Has the Job or job retrieval produced a exception ?
+
+
hasException() - Method in interface nl.esciencecenter.xenon.schedulers.QueueStatus
+
+
Did the queue produce an exception ?
+
+
hashCode() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
hashCode() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
 
+
hashCode() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.StreamsImplementation
+
 
+
hashCode() - Method in class nl.esciencecenter.xenon.credentials.CertificateCredential
+
 
+
hashCode() - Method in class nl.esciencecenter.xenon.credentials.CredentialMap
+
 
+
hashCode() - Method in class nl.esciencecenter.xenon.credentials.DefaultCredential
+
 
+
hashCode() - Method in class nl.esciencecenter.xenon.credentials.KeytabCredential
+
 
+
hashCode() - Method in class nl.esciencecenter.xenon.credentials.PasswordCredential
+
 
+
hashCode() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
hashCode() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
hashCode() - Method in class nl.esciencecenter.xenon.filesystems.Path
+
 
+
hashCode() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
 
+
hashCode() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
 
+
hashCode() - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
 
+
hasNext() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem.ListingIterator
+
 
+
hasNext() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem.RecursiveListIterator
+
 
+
hasNext() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.RecursiveListIterator
+
 
+
hasNext() - Method in class nl.esciencecenter.xenon.filesystems.Path.PathIterator
+
 
+
hasRun - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
hasRun() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
haveRecentlySeen(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
haveRecentlySeen(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
HDFSFileAdaptor - Class in nl.esciencecenter.xenon.adaptors.filesystems.hdfs
+
+
Created by atze on 3-7-17.
+
+
HDFSFileAdaptor() - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileAdaptor
+
 
+
HDFSFileSystem - Class in nl.esciencecenter.xenon.adaptors.filesystems.hdfs
+
 
+
HDFSFileSystem(String, String, Credential, FileSystem, int, XenonProperties) - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
hidden - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Is the file hidden ?
+
+
hops - Variable in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHConnection
+
 
+
HORIZONTAL_LINE_REGEX - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingParser
+
 
+
+ + + +

I

+
+
identifiersAsCSList(String[]) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
 
+
IGNORE_VERSION_PROPERTY - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSchedulerAdaptor
+
+
Should the grid engine version on the target machine be ignored ?
+
+
IGNORE_VERSION_PROPERTY - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueSchedulerAdaptor
+
+
Should the grid engine version on the target machine be ignored ?
+
+
ignoreVersion - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineXmlParser
+
 
+
in - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem.StreamToFileWriter
+
 
+
in - Variable in class nl.esciencecenter.xenon.utils.StreamForwarder
+
 
+
IncompatibleVersionException - Exception in nl.esciencecenter.xenon.adaptors.schedulers
+
+
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.adaptors.schedulers.IncompatibleVersionException
+
 
+
IncompatibleVersionException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.schedulers.IncompatibleVersionException
+
 
+
IncompleteJobDescriptionException - Exception in nl.esciencecenter.xenon.schedulers
+
+
Signals that a JobDescription is missing required options.
+
+
IncompleteJobDescriptionException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.schedulers.IncompleteJobDescriptionException
+
 
+
IncompleteJobDescriptionException(String, String) - Constructor for exception nl.esciencecenter.xenon.schedulers.IncompleteJobDescriptionException
+
 
+
index - Variable in class nl.esciencecenter.xenon.filesystems.Path.PathIterator
+
 
+
INFO - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
+
Local queue information start with this prefix.
+
+
INFO - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
Ssh adaptor information start with this prefix.
+
+
inputStream - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpInputStream
+
 
+
InputWriter - Class in nl.esciencecenter.xenon.utils
+
+
A simple input writer that uses a daemon thread to write from an String to an OutputStream.
+
+
InputWriter(String, OutputStream) - Constructor for class nl.esciencecenter.xenon.utils.InputWriter
+
+
Create a new InputWriter that writes content to the destination.
+
+
interactive - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
InteractiveProcess - Interface in nl.esciencecenter.xenon.adaptors.schedulers
+
 
+
InteractiveProcessFactory - Interface in nl.esciencecenter.xenon.adaptors.schedulers
+
 
+
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.schedulers
+
+
Signals that a JobDescription contains invalid values for certain options.
+
+
InvalidJobDescriptionException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.schedulers.InvalidJobDescriptionException
+
 
+
InvalidJobDescriptionException(String, String) - Constructor for exception nl.esciencecenter.xenon.schedulers.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
+
 
+
InvalidOptionsException - Exception in nl.esciencecenter.xenon.filesystems
+
+
Signals that an invalid combination of OpenOptions have been specified.
+
+
InvalidOptionsException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.InvalidOptionsException
+
 
+
InvalidOptionsException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.InvalidOptionsException
+
 
+
InvalidPathException - Exception in nl.esciencecenter.xenon.filesystems
+
+
Signals that an end-of-file was encountered.
+
+
InvalidPathException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.InvalidPathException
+
 
+
InvalidPathException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.InvalidPathException
+
 
+
InvalidPropertyException - Exception in nl.esciencecenter.xenon
+
+
Signals that a property has a different type than the get method it was retrieved with.
+
+
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.filesystems
+
+
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.filesystems.InvalidResumeTargetException
+
 
+
InvalidResumeTargetException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.InvalidResumeTargetException
+
 
+
isAbsolute - Variable in class nl.esciencecenter.xenon.filesystems.Path
+
+
Does path start with / ?
+
+
isAbsolute() - Method in class nl.esciencecenter.xenon.filesystems.Path
+
 
+
isCancelled() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyCallback
+
 
+
isClosed() - Method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHConnection
+
 
+
isConnectionless() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor
+
 
+
isConnectionless() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileAdaptor
+
 
+
isConnectionless() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor
+
 
+
isConnectionless() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileAdaptor
+
 
+
isConnectionless() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
+
 
+
isDirectory - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Is this a directory ?
+
+
isDirectory() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Does the path refer to a directory ?
+
+
isDirectory() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Does the path refer to a directory ?
+
+
isDone() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.BatchProcess
+
 
+
isDone() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
isDone() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
+
Is the Job done.
+
+
isDone() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcess
+
 
+
isDone() - Method in interface nl.esciencecenter.xenon.adaptors.schedulers.Process
+
 
+
isDone() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcess
+
 
+
isDone() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
+
+
Is the Copy done?
+
+
isDone() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
isDone() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
+
+
Is the Job done.
+
+
isDoneOrFailedState(String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
+
Is the given state a done or failed state ?
+
+
isDoneState(String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
+
Is the given state a done state ?
+
+
isDotDot(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
isEmbedded() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
 
+
isEmbedded() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.SchedulerAdaptor
+
 
+
isEmbedded() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
 
+
isEmbedded() - Method in interface nl.esciencecenter.xenon.schedulers.SchedulerAdaptorDescription
+
+
Is this an embedded scheduler ? + + Embedded schedulers are implemented inside the Xenon process itself.
+
+
isEmpty() - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Is this Path empty ?
+
+
isExecutable() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Does the path refer to an executable file ?
+
+
isExecutable(int) - Static method in class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
 
+
isExecutable() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Does the path refer to an executable file ?
+
+
isFailedState(String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
+
Is the given state a failed state ?
+
+
isFinished() - Method in class nl.esciencecenter.xenon.utils.InputWriter
+
+
Poll if the InputWriter has finished writing.
+
+
isFinished() - Method in class nl.esciencecenter.xenon.utils.OutputReader
+
+
Returns if the OutputReader has finished (i.e., has reached the end-of-stream on the input).
+
+
isHidden() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Does the path refer to an hidden file ?
+
+
isHidden() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Does the path refer to an hidden file ?
+
+
isLinux() - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
+
Returns if we are currently running on Linux.
+
+
isLinuxRoot(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
+
Check if root only contains a valid Linux root element, which is "/".
+
+
isLocal(String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingUtils
+
 
+
isLocalRoot(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
+
Check if root contains a locally valid root element, such as "C:" on Windows or "/" on Linux and OSX.
+
+
isOpen() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
isOpen() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
isOpen() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
isOpen() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
isOpen() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
isOpen() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
isOpen() - Method in interface nl.esciencecenter.xenon.adaptors.schedulers.InteractiveProcessFactory
+
 
+
isOpen() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
isOpen() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcessFactory
+
 
+
isOpen() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
 
+
isOpen() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcessFactory
+
 
+
isOpen() - Method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHConnection
+
 
+
isOpen() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Return if the connection to the FileSystem is open.
+
+
isOpen() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Test if the connection of this Scheduler is open.
+
+
isOSX() - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
+
Returns if we are currently running on OSX.
+
+
isOSXRoot(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
+
Check if root contains a valid OSX root element, which is "/".
+
+
isOther - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Is this an other type of file ?
+
+
isOther() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Is the path not a file, link or directory ?
+
+
isOther() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Is the path not a file, link or directory ?
+
+
isPendingState(String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
+
Is the given state a pending state ?
+
+
isReadable() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Does the path refer to an readable file ?
+
+
isReadable(int) - Static method in class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
 
+
isReadable() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Does the path refer to an readable file ?
+
+
isRegular - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Is this a regular file ?
+
+
isRegular() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Does the path refer to a regular file ?
+
+
isRegular() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Does the path refer to a regular file ?
+
+
isRunning - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
isRunning() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
+
Is the Job running.
+
+
isRunning() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
+
+
Is the Copy still running?
+
+
isRunning() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
isRunning() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
+
+
Is the Job running.
+
+
isRunningState(String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
+
Is the given state a running state ?
+
+
isSSH(String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingUtils
+
 
+
isStarted() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyCallback
+
 
+
isStartSingleProcess() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Is only a single process started?
+
+
isSymbolicLink - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Is this a symbolic link ?
+
+
isSymbolicLink() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Does the path refer to a symbolic link ?
+
+
isSymbolicLink() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Does the path refer to a symbolic link ?
+
+
isWindows() - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
+
Returns if we are currently running on Windows.
+
+
isWindowsRoot(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
+
Check if root only contains a valid Windows root element such as "C:".
+
+
isWritable() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Does the path refer to a writable file ?
+
+
isWritable(int) - Static method in class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
 
+
isWritable() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Does the path refer to a writable file ?
+
+
iterator() - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Create an Iterator that returns all possible sub Paths of this Path, in order of increasing length.
+
+
+ + + +

J

+
+
javaArguments - Variable in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
 
+
javaClasspath - Variable in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
 
+
JavaJobDescription - Class in nl.esciencecenter.xenon.utils
+
+
A JobDescription specialized in Java applications.
+
+
JavaJobDescription() - Constructor for class nl.esciencecenter.xenon.utils.JavaJobDescription
+
 
+
javaMain - Variable in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
 
+
javaOptions - Variable in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
 
+
javaPath(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
javaPermissions(Set<PosixFilePermission>) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
javaSystemProperties - Variable in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
 
+
JCloudsFileSytem - Class in nl.esciencecenter.xenon.adaptors.filesystems.jclouds
+
 
+
JCloudsFileSytem(String, String, String, Credential, Path, BlobStoreContext, String, int, XenonProperties) - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
JCloudsFileSytem.ListingIterator - Class in nl.esciencecenter.xenon.adaptors.filesystems.jclouds
+
 
+
JCloudsFileSytem.RecursiveListIterator - Class in nl.esciencecenter.xenon.adaptors.filesystems.jclouds
+
 
+
JOB_OPTION_JOB_CONTENTS - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueUtils
+
 
+
JOB_OPTION_JOB_SCRIPT - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
JOB_OPTION_JOB_SCRIPT - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
 
+
JOB_OPTION_JOB_SCRIPT - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueUtils
+
 
+
JOB_OPTION_PARALLEL_ENVIRONMENT - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
JOB_OPTION_PARALLEL_SLOTS - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
JOB_OPTION_RESOURCES - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
JOB_OPTION_RESOURCES - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueUtils
+
 
+
JobCanceledException - Exception in nl.esciencecenter.xenon.adaptors.schedulers
+
+
Signals that a jobs has been canceled by the user.
+
+
JobCanceledException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.adaptors.schedulers.JobCanceledException
+
 
+
JobCanceledException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.schedulers.JobCanceledException
+
 
+
JobDescription - Class in nl.esciencecenter.xenon.schedulers
+
+
JobDescription contains a description of a job that can be submitted to a Scheduler.
+
+
JobDescription() - Constructor for class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Create a JobDescription.
+
+
JobDescription(JobDescription) - Constructor for class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Create a JobDescription by copying an existing one.
+
+
JobExecutor - Class in nl.esciencecenter.xenon.adaptors.schedulers
+
 
+
JobExecutor(String, FileSystem, Path, InteractiveProcessFactory, JobDescription, String, boolean, long, long) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
jobID - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
jobIdentifier - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
jobIdentifier - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
 
+
jobIdentifier - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.StreamsImplementation
+
 
+
jobOptions - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The job options of this job
+
+
JobQueueScheduler - Class in nl.esciencecenter.xenon.adaptors.schedulers
+
 
+
JobQueueScheduler(String, String, String, Credential, InteractiveProcessFactory, FileSystem, Path, int, long, long, XenonProperties) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
JobQueueScheduler.DaemonThreadFactory - Class in nl.esciencecenter.xenon.adaptors.schedulers
+
+
Simple thread factory which returns daemon threads instead of normal threads
+
+
JOBS - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
+
Local job information start with this prefix.
+
+
JOBS - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
Ssh job information start with this prefix.
+
+
jobsFromStatus(String, List<String>) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
jobsFromStatus(String, List<String>) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
JobStatus - Interface in nl.esciencecenter.xenon.schedulers
+
+
JobStatus contains status information for a specific job.
+
+
JobStatusImplementation - Class in nl.esciencecenter.xenon.adaptors.schedulers
+
+
JobStatus contains status information for a specific job.
+
+
JobStatusImplementation(String, String, String, Integer, XenonException, boolean, boolean, Map<String, String>) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
+
Create a JobStatus.
+
+
jobWasDeleted(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
jobWasDeleted(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
+ + + +

K

+
+
keySet() - Method in class nl.esciencecenter.xenon.credentials.CredentialMap
+
+
Returns a Set view of the keys contained in this map.
+
+
KeytabCredential - Class in nl.esciencecenter.xenon.credentials
+
 
+
KeytabCredential(String, String) - Constructor for class nl.esciencecenter.xenon.credentials.KeytabCredential
+
 
+
keytabFile - Variable in class nl.esciencecenter.xenon.credentials.KeytabCredential
+
 
+
kill() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
killed - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
KILLED_STATE - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
KILO - Static variable in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
One kilo is 1024
+
+
+ + + +

L

+
+
lastAccessTime - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
The last access time of this file
+
+
lastModifiedTime - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
The last modified time of this file
+
+
lastSeenMap - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
+
Map with the last seen time of jobs.
+
+
lastSeenMap - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
+
Map with the last seen time of jobs.
+
+
list(Path, boolean) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
list(Path, boolean) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
list - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.RecursiveListIterator
+
 
+
list(Path, boolean) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
List all entries in the directory dir.
+
+
list(Path, ArrayList<PathAttributes>, boolean) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Returns an (optionally recursive) listing of the entries in a directory dir.
+
+
listDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
listDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
listDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
listDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
listDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
listDirectory(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
listDirectory(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Return the list of entries in a directory.
+
+
ListingIterator(ListContainerOptions, PageSet<? extends StorageMetadata>) - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem.ListingIterator
+
 
+
listIterator(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
listIteratorNoException(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
listNonRecursiveIterator(String) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
listPrefix(String, boolean) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
LOAD_SSH_CONFIG - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
+
Load the OpenSSH config file by default.
+
+
LOAD_SSH_CONFIG - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
Load the OpenSSH config file by default.
+
+
LOAD_STANDARD_KNOWN_HOSTS - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
+
Load the known_hosts file by default.
+
+
LOAD_STANDARD_KNOWN_HOSTS - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
Load the known_hosts file by default.
+
+
LocalFileAdaptor - Class in nl.esciencecenter.xenon.adaptors.filesystems.local
+
+
LocalFiles implements an Xenon Files adaptor for local file operations.
+
+
LocalFileAdaptor() - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileAdaptor
+
 
+
LocalFileSystem - Class in nl.esciencecenter.xenon.adaptors.filesystems.local
+
 
+
LocalFileSystem(String, String, Credential, String, Path, int, XenonProperties) - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
LocalFileSystemUtils - Class in nl.esciencecenter.xenon.utils
+
 
+
LocalFileSystemUtils() - Constructor for class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
 
+
LocalInteractiveProcess - Class in nl.esciencecenter.xenon.adaptors.schedulers.local
+
+
LocalInteractiveProcess implements a InteractiveProcess for local interactive processes.
+
+
LocalInteractiveProcess(JobDescription, String, String) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcess
+
 
+
LocalInteractiveProcessFactory - Class in nl.esciencecenter.xenon.adaptors.schedulers.local
+
 
+
LocalInteractiveProcessFactory() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcessFactory
+
 
+
LocalSchedulerAdaptor - Class in nl.esciencecenter.xenon.adaptors.schedulers.local
+
+
LocalFiles implements an Xenon Jobs adaptor for local job operations.
+
+
LocalSchedulerAdaptor() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
 
+
location - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
location - Variable in class nl.esciencecenter.xenon.schedulers.Scheduler
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileAdaptor
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineXmlParser
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.CommandRunner
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.RemoteCommandRunner
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSetup
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcess
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueUtils
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueXmlParser
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.utils.InputWriter
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.utils.StreamForwarder
+
 
+
login(Credential, FTPClient) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
 
+
loginWithCredentialOrDefault(FTPClient, Credential) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
 
+
+ + + +

M

+
+
makeBlobAttributes(String) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
makeDirAttributes(StorageMetadata) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
makeDirectoryPlaceholder(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
map - Variable in class nl.esciencecenter.xenon.credentials.CredentialMap
+
 
+
mapFromElement(Element) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineXmlParser
+
 
+
mark(int) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpInputStream
+
 
+
markSupported() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpInputStream
+
 
+
MAX_HISTORY - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
+
Property for maximum history length for finished jobs
+
+
MAX_HISTORY - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
Maximum history length for finished jobs
+
+
MAX_POLLING_DELAY - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
+
The maximum allowed value for the polling delay
+
+
maxMemory - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The maximum amount of memory needed (in MB) on each node/process.
+
+
maxRuntime - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The maximum run time in minutes.
+
+
maybeThrowException() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
 
+
maybeThrowException() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.QueueStatusImplementation
+
 
+
maybeThrowException() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
+
+
Throws the exception that occured during copying, if it exists.
+
+
maybeThrowException() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
maybeThrowException() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
+
+
Throws the exception produced by the Job or while retrieving the status, if it exists.
+
+
maybeThrowException() - Method in interface nl.esciencecenter.xenon.schedulers.QueueStatus
+
+
Throws the exception produced by the queue if it exists.
+
+
MEGA - Static variable in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
One mega is a kilo*kilo
+
+
mergeTuples(String[]) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingParser
+
 
+
mergeValidProperties(XenonPropertyDescription[]...) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingUtils
+
 
+
MILLISECONDS_PER_MINUTE - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
+
Number of ms.
+
+
MIN_POLLING_DELAY - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
+
The minimal allowed value for the polling delay
+
+
MINUTES_PER_HOUR - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
MINUTES_PER_HOUR - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueUtils
+
 
+
MULTI_QUEUE_NAME - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
multiExecutor - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
multiQ - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
MULTIQ - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
+
Local multi queue properties start with this prefix.
+
+
MULTIQ - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
Local multi queue properties start with this prefix.
+
+
MULTIQ_MAX_CONCURRENT - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
+
Property for the maximum number of concurrent jobs in the multi queue.
+
+
MULTIQ_MAX_CONCURRENT - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
Property for the maximum number of concurrent jobs in the multi queue.
+
+
+ + + +

N

+
+
name - Variable in class nl.esciencecenter.xenon.adaptors.Adaptor
+
 
+
name - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
+
 
+
name - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.QueueInfo
+
 
+
name - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
 
+
NAME - Static variable in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
 
+
name - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The name of the job.
+
+
name - Variable in class nl.esciencecenter.xenon.XenonPropertyDescription
+
 
+
needsSizeBeforehand() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor
+
 
+
needsSizeBeforehand() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor
+
 
+
needsSizeBeforehand() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
+
 
+
NEWLINE_REGEX - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingParser
+
 
+
newThread(Runnable) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler.DaemonThreadFactory
+
 
+
next() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem.ListingIterator
+
 
+
next() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem.RecursiveListIterator
+
 
+
next() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.RecursiveListIterator
+
 
+
next() - Method in class nl.esciencecenter.xenon.filesystems.Path.PathIterator
+
 
+
nextCopyID - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
nl.esciencecenter.xenon - package nl.esciencecenter.xenon
+
+
This package is the main entry point into the Xenon API.
+
+
nl.esciencecenter.xenon.adaptors - package nl.esciencecenter.xenon.adaptors
+
 
+
nl.esciencecenter.xenon.adaptors.filesystems - package nl.esciencecenter.xenon.adaptors.filesystems
+
 
+
nl.esciencecenter.xenon.adaptors.filesystems.ftp - package nl.esciencecenter.xenon.adaptors.filesystems.ftp
+
 
+
nl.esciencecenter.xenon.adaptors.filesystems.hdfs - package nl.esciencecenter.xenon.adaptors.filesystems.hdfs
+
 
+
nl.esciencecenter.xenon.adaptors.filesystems.jclouds - package nl.esciencecenter.xenon.adaptors.filesystems.jclouds
+
 
+
nl.esciencecenter.xenon.adaptors.filesystems.local - package nl.esciencecenter.xenon.adaptors.filesystems.local
+
 
+
nl.esciencecenter.xenon.adaptors.filesystems.s3 - package nl.esciencecenter.xenon.adaptors.filesystems.s3
+
 
+
nl.esciencecenter.xenon.adaptors.filesystems.sftp - package nl.esciencecenter.xenon.adaptors.filesystems.sftp
+
 
+
nl.esciencecenter.xenon.adaptors.filesystems.webdav - package nl.esciencecenter.xenon.adaptors.filesystems.webdav
+
 
+
nl.esciencecenter.xenon.adaptors.schedulers - package nl.esciencecenter.xenon.adaptors.schedulers
+
 
+
nl.esciencecenter.xenon.adaptors.schedulers.gridengine - package nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+
 
+
nl.esciencecenter.xenon.adaptors.schedulers.local - package nl.esciencecenter.xenon.adaptors.schedulers.local
+
 
+
nl.esciencecenter.xenon.adaptors.schedulers.slurm - package nl.esciencecenter.xenon.adaptors.schedulers.slurm
+
 
+
nl.esciencecenter.xenon.adaptors.schedulers.ssh - package nl.esciencecenter.xenon.adaptors.schedulers.ssh
+
 
+
nl.esciencecenter.xenon.adaptors.schedulers.torque - package nl.esciencecenter.xenon.adaptors.schedulers.torque
+
 
+
nl.esciencecenter.xenon.adaptors.shared.ssh - package nl.esciencecenter.xenon.adaptors.shared.ssh
+
 
+
nl.esciencecenter.xenon.credentials - package nl.esciencecenter.xenon.credentials
+
+
This package contains classes and interfaces for managing credentials.
+
+
nl.esciencecenter.xenon.filesystems - package nl.esciencecenter.xenon.filesystems
+
+
This package contains classes and interfaces for manipulating files.
+
+
nl.esciencecenter.xenon.schedulers - package nl.esciencecenter.xenon.schedulers
+
+
This package contains the classes and interfaces used to run jobs.
+
+
nl.esciencecenter.xenon.utils - package nl.esciencecenter.xenon.utils
+
+
This package is contains several utility classes.
+
+
nodeCount - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The number of nodes to run the job on.
+
+
normalize() - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Normalize this Path by removing as many redundant path elements as possible.
+
+
NoSpaceException - Exception in nl.esciencecenter.xenon.adaptors.filesystems
+
+
Signals that an end-of-file was encountered.
+
+
NoSpaceException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.adaptors.filesystems.NoSpaceException
+
 
+
NoSpaceException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.filesystems.NoSpaceException
+
 
+
NoSuchCopyException - Exception in nl.esciencecenter.xenon.filesystems
+
+
Signals that a unknown Copy handle was provided.
+
+
NoSuchCopyException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.NoSuchCopyException
+
 
+
NoSuchCopyException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.NoSuchCopyException
+
 
+
NoSuchJobException - Exception in nl.esciencecenter.xenon.schedulers
+
+
Signals that a Job was not found.
+
+
NoSuchJobException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.schedulers.NoSuchJobException
+
 
+
NoSuchJobException(String, String) - Constructor for exception nl.esciencecenter.xenon.schedulers.NoSuchJobException
+
 
+
NoSuchPathException - Exception in nl.esciencecenter.xenon.filesystems
+
+
Signals that a path does not exists.
+
+
NoSuchPathException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.NoSuchPathException
+
 
+
NoSuchPathException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.NoSuchPathException
+
 
+
NoSuchQueueException - Exception in nl.esciencecenter.xenon.schedulers
+
+
Signals that a unknown queue was provided.
+
+
NoSuchQueueException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.schedulers.NoSuchQueueException
+
 
+
NoSuchQueueException(String, String) - Constructor for exception nl.esciencecenter.xenon.schedulers.NoSuchQueueException
+
 
+
NOT_EMPTY - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
NotConnectedException - Exception in nl.esciencecenter.xenon.adaptors
+
+
Signals that there was no connection.
+
+
NotConnectedException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.adaptors.NotConnectedException
+
 
+
NotConnectedException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.NotConnectedException
+
 
+
nxt - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem.ListingIterator
+
 
+
+ + + +

O

+
+
OK_CODE - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileAdaptor
+
 
+
open - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
open - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcessFactory
+
 
+
options - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem.ListingIterator
+
 
+
OS_PROPERTY - Static variable in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
 
+
out - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.CommandRunner
+
 
+
out - Variable in class nl.esciencecenter.xenon.utils.StreamForwarder
+
 
+
output - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.RemoteCommandRunner
+
 
+
OutputReader - Class in nl.esciencecenter.xenon.utils
+
+
A simple output reader that uses a daemon thread to read from an InputStream and buffer this data.
+
+
OutputReader(InputStream) - Constructor for class nl.esciencecenter.xenon.utils.OutputReader
+
+
Create an OutputReader that reads from source.
+
+
outputStream - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpOutputStream
+
 
+
owner - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
The owner of this file
+
+
+ + + +

P

+
+
ParallelEnvironmentInfo - Class in nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+
+
Class that holds some info on parallel environments used in Grid Engine.
+
+
ParallelEnvironmentInfo(Map<String, String>) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
+
 
+
ParallelEnvironmentInfo(String, int, ParallelEnvironmentInfo.AllocationRule, int) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
+
 
+
ParallelEnvironmentInfo.AllocationRule - Enum in nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+
 
+
parallelEnvironments - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
 
+
parallelEnvironments - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.QueueInfo
+
 
+
parseDocument(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineXmlParser
+
 
+
parseDocument(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueXmlParser
+
 
+
parseJobIDFromLine(String, String, String...) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingParser
+
+
Get a JobID (number) from a line of input.
+
+
parseJobInfos(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineXmlParser
+
+
Parses job info from "qstat -xml"
+
+
parseJobInfos(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueXmlParser
+
+
Parses job info from "qstat -x"
+
+
parseKeyValueLines(String, Pattern, String, String...) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingParser
+
+
Parses lines containing single key/value pairs separated by the given separator, possibly surrounded by whitespace.
+
+
parseKeyValuePairs(String, String, String...) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingParser
+
+
Parses a output with key=value pairs separated by whitespace, on one or more lines.
+
+
parseKeyValueRecords(String, String, Pattern, String, String...) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingParser
+
+
Parses multiple key value records.
+
+
parseList(String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingParser
+
+
Parses a list of strings, separated by whitespace (including newlines) + Trailing empty strings are not included.
+
+
parseQueueInfos(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineXmlParser
+
+
Parses queue info from "qstat -g c -xml"
+
+
parser - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
parser - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
parseSizeValue(String) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
 
+
parseTable(String, String, Pattern, String, String...) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingParser
+
+
Parses lines containing multiple values.
+
+
password - Variable in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil.PasswordProvider
+
 
+
password - Variable in class nl.esciencecenter.xenon.credentials.PasswordCredential
+
+
Must be char array for security!! (Strings end up in the constant pool, etc.)
+
+
PasswordCredential - Class in nl.esciencecenter.xenon.credentials
+
+
A Credential consisting of a username + password combination.
+
+
PasswordCredential(String, String) - Constructor for class nl.esciencecenter.xenon.credentials.PasswordCredential
+
+
Create a new PasswordCredential using a String as password.
+
+
PasswordCredential(String, char[]) - Constructor for class nl.esciencecenter.xenon.credentials.PasswordCredential
+
+
Create a new PasswordCredential using a char array as password.
+
+
PasswordProvider(char[]) - Constructor for class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil.PasswordProvider
+
 
+
path - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
The path these attributes belong to
+
+
Path - Class in nl.esciencecenter.xenon.filesystems
+
+
Path contains a sequence of path elements separated by a separator.
+
+
Path() - Constructor for class nl.esciencecenter.xenon.filesystems.Path
+
+
Create a new empty Path using the default separator.
+
+
Path(String) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
+
+
Create a new Path by parsing path using the default separator.
+
+
Path(char, String) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
+
+
Create a new Path by parsing path using the provided separator.
+
+
Path(boolean, String...) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
+
+
Create a new Path using the given path elements and the default separator.
+
+
Path(char, boolean, String...) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
+
+
Create a new Path using the given path elements and the provided separator.
+
+
Path(boolean, List<String>) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
+
+
Create a new Path using the given path elements and the default separator.
+
+
Path(char, boolean, List<String>) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
+
+
Create a new Path using the given path separator, absoluteness, and elements.
+
+
Path.PathIterator - Class in nl.esciencecenter.xenon.filesystems
+
 
+
PATH_ELEMENT_LENGTH - Static variable in class nl.esciencecenter.xenon.filesystems.Path
+
+
Estimate of path element String length.
+
+
PathAlreadyExistsException - Exception in nl.esciencecenter.xenon.filesystems
+
+
Signals that a path already exists.
+
+
PathAlreadyExistsException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.PathAlreadyExistsException
+
 
+
PathAlreadyExistsException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.PathAlreadyExistsException
+
 
+
PathAttributes - Interface in nl.esciencecenter.xenon.filesystems
+
+
FileAttributes represents a set of attributes of a path.
+
+
PathAttributesImplementation - Class in nl.esciencecenter.xenon.adaptors.filesystems
+
+
FileAttributes represents a set of attributes of a path.
+
+
PathAttributesImplementation() - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
PathIterator() - Constructor for class nl.esciencecenter.xenon.filesystems.Path.PathIterator
+
 
+
PENDING_STATE - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
PENDING_STATES - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
+
These are the states a job can be in when it is pending: + + PENDING: the job is awaiting resource allocation.
+
+
pendingCopies - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
PendingCopy(Future<Void>, FileSystem.CopyCallback) - Constructor for class nl.esciencecenter.xenon.filesystems.FileSystem.PendingCopy
+
 
+
performCopy(Path, FileSystem, Path, CopyMode, boolean, FileSystem.CopyCallback) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Perform a (possibly) recursive copy from a path on this filesystem to a path on destinationFS.
+
+
PERMISSION_TYPES - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
PermissionDeniedException - Exception in nl.esciencecenter.xenon.adaptors.filesystems
+
+
Signals that the user does not have sufficient permissions to perform the operation.
+
+
PermissionDeniedException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.adaptors.filesystems.PermissionDeniedException
+
 
+
PermissionDeniedException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.filesystems.PermissionDeniedException
+
 
+
permissions - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
The permissions of this file (POSIX only)
+
+
permissionsToBits(Set<PosixFilePermission>) - Static method in class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
 
+
POLL_DELAY_PROPERTY - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSchedulerAdaptor
+
+
Polling delay for jobs started by this adaptor.
+
+
POLL_DELAY_PROPERTY - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSchedulerAdaptor
+
+
Polling delay for jobs started by this adaptor.
+
+
POLL_DELAY_PROPERTY - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueSchedulerAdaptor
+
+
Polling delay for jobs started by this adaptor.
+
+
pollDelay - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
 
+
POLLING_DELAY - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
+
Polling delay in ms.
+
+
POLLING_DELAY - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
+
Property for maximum history length for finished jobs
+
+
POLLING_DELAY - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
Property for maximum history length for finished jobs
+
+
pollingDelay - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
pollingDelay - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
pool - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
popEmpties() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem.RecursiveListIterator
+
 
+
popEmpties() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.RecursiveListIterator
+
 
+
PosixFilePermission - Enum in nl.esciencecenter.xenon.filesystems
+
+
PosixFilePermission is an enumeration containing all supported Posix file permissions.
+
+
PosixFilePermission() - Constructor for enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
 
+
PosixFileUtils - Class in nl.esciencecenter.xenon.adaptors.filesystems
+
+
PosixFileUtils contains several utility functions related to Posix files.
+
+
PosixFileUtils() - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
 
+
ppn - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
+
 
+
PREFIX - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
+
All our own properties start with this prefix.
+
+
PREFIX - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileAdaptor
+
+
All our own properties start with this prefix.
+
+
PREFIX - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileAdaptor
+
+
Local properties start with this prefix.
+
+
PREFIX - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor
+
+
All our own properties start with this prefix.
+
+
PREFIX - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
+
All our own properties start with this prefix.
+
+
PREFIX - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileAdaptor
+
+
All our own properties start with this prefix.
+
+
PREFIX - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSchedulerAdaptor
+
+
The prefix used by all properties related to this adaptor
+
+
PREFIX - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
+
Local properties start with this prefix.
+
+
PREFIX - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSchedulerAdaptor
+
+
The prefix used by all properties related to this adaptor
+
+
PREFIX - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
All our own properties start with this prefix.
+
+
PREFIX - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueSchedulerAdaptor
+
+
The prefix used by all properties related to this adaptor
+
+
printProperties(PrintStream, String) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Prints properties (including default properties) to a stream.
+
+
process - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.BatchProcess
+
 
+
process - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcess
+
 
+
Process - Interface in nl.esciencecenter.xenon.adaptors.schedulers
+
 
+
processesPerNode - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The number of processes to start/reserve per node.
+
+
processPath(Path, String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.BatchProcess
+
 
+
processPath(Path, String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
properties - Variable in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
The properties that are actually set.
+
+
properties - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
properties - Variable in class nl.esciencecenter.xenon.schedulers.Scheduler
+
 
+
propertyDescriptions - Variable in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Contains a description of all properties this XenonProperties should accept, including their type, default, etc.
+
+
propertySet(String) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Check if the property with the given name is set.
+
+
PropertyTypeException - Exception in nl.esciencecenter.xenon
+
+
Signals that a property has a different type than the get method it was retrieved with.
+
+
PropertyTypeException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.PropertyTypeException
+
 
+
PropertyTypeException(String, String) - Constructor for exception nl.esciencecenter.xenon.PropertyTypeException
+
 
+
protectAgainstShellMetas(String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.CommandLineUtils
+
+
Escapes and quotes command line arguments to keep shells from expanding/interpreting them.
+
+
put(String, UserCredential) - Method in class nl.esciencecenter.xenon.credentials.CredentialMap
+
+
Add a Credential to the CredentialMap using key as a unique key.
+
+
+ + + +

Q

+
+
QACCT_HEADER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
qconfPeDetailsArguments(String[]) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
+
generate arguments to list details of all parallel environments given
+
+
queryQueueNames() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
queryQueues(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
QUEUE - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
+
Local queue properties start with this prefix.
+
+
QUEUE - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
All our own queue properties start with this prefix.
+
+
QUEUE_INFO_NAME - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueUtils
+
 
+
QueueInfo - Class in nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+
+
Class that holds some info on queues used in Grid Engine.
+
+
QueueInfo(Map<String, String>) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.QueueInfo
+
 
+
QueueInfo(String, int, String...) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.QueueInfo
+
+
Testing constructor
+
+
queueName - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.QueueStatusImplementation
+
 
+
queueName - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The queue to submit to.
+
+
queueNames - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
 
+
queueNames - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
queueNames - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
queues - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
 
+
queues - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
QueueStatus - Interface in nl.esciencecenter.xenon.schedulers
+
+
QueueStatus contains status information for a specific queue.
+
+
QueueStatusImplementation - Class in nl.esciencecenter.xenon.adaptors.schedulers
+
+
QueueStatus contains status information for a specific queue.
+
+
QueueStatusImplementation(Scheduler, String, XenonException, Map<String, String>) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.QueueStatusImplementation
+
+
Create a Queue status.
+
+
+ + + +

R

+
+
read() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpInputStream
+
 
+
read(byte[]) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpInputStream
+
 
+
read(byte[], int, int) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpInputStream
+
 
+
READ_GROUP - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
+
read by group
+
+
READ_OTHERS - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
+
read by others
+
+
READ_OWNER - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
+
read by owner
+
+
readable - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Is the file readable ?
+
+
readFromFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
readFromFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
readFromFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
readFromFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
readFromFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
readFromFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
readFromFile(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Open an existing file and return an InputStream to read from this file.
+
+
readSymbolicLink(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
readSymbolicLink(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
readSymbolicLink(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
readSymbolicLink(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
readSymbolicLink(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
readSymbolicLink(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
readSymbolicLink(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Reads the target of a symbolic link (optional operation).
+
+
RecursiveListIterator(Iterator<PathAttributes>) - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem.RecursiveListIterator
+
 
+
RecursiveListIterator - Class in nl.esciencecenter.xenon.adaptors.filesystems
+
 
+
RecursiveListIterator(Function<Path, Iterator<PathAttributes>>, Path) - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.RecursiveListIterator
+
 
+
recursiveMapFromElement(Node, Map<String, String>) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueXmlParser
+
+
Create a Map from the tag names and text values of child nodes.
+
+
relativize(Path) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Create a relative Path between the given Path and this Path.
+
+
RemoteCommandRunner - Class in nl.esciencecenter.xenon.adaptors.schedulers
+
+
Runs a command.
+
+
RemoteCommandRunner(Scheduler, String, String, String...) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.RemoteCommandRunner
+
+
Run a command remotely, and save stdout, stderr, and exit code for later processing.
+
+
remove() - Method in class nl.esciencecenter.xenon.filesystems.Path.PathIterator
+
 
+
removeDirectoryPlaceholder(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
rename(Path, Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
rename(Path, Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
rename(Path, Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
rename(Path, Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
rename(Path, Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
rename(Path, Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
rename(Path, Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Rename an existing source path to a non-existing target path (optional operation).
+
+
reset() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpInputStream
+
 
+
resolve(Path) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Resolve a Path against this Path.
+
+
resolve(String) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Resolve a Path represented as a String against this path.
+
+
resolveSibling(Path) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Resolves the given Path to this paths parent Path, thereby creating a sibling to this Path.
+
+
root - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
run() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem.StreamToFileWriter
+
 
+
run() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
run() - Method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil.Tunnel
+
 
+
run() - Method in class nl.esciencecenter.xenon.utils.InputWriter
+
+
Entry point for the Daemon thread.
+
+
run() - Method in class nl.esciencecenter.xenon.utils.OutputReader
+
+
Entry method for daemon thread.
+
+
run() - Method in class nl.esciencecenter.xenon.utils.StreamForwarder
+
+
Main entry method for the daemon thread.
+
+
runCheckedCommand(String, String, String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
+
Run a command until completion.
+
+
runCommand(String, String, String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
+
Run a command on the remote scheduler machine.
+
+
running - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
 
+
RUNNING_STATE - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
RUNNING_STATES - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
+
These are the states a job can be in when it is running: + + CONFIGURING: the resources are available and being preparing to run the job (for example by booting).
+
+
+ + + +

S

+
+
S3FileAdaptor - Class in nl.esciencecenter.xenon.adaptors.filesystems.s3
+
+
Created by atze on 29-6-17.
+
+
S3FileAdaptor() - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor
+
 
+
scheduler - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.QueueStatusImplementation
+
 
+
Scheduler - Class in nl.esciencecenter.xenon.schedulers
+
+
Scheduler represents a (possibly remote) scheduler that can be used to submit jobs and retrieve queue information.
+
+
Scheduler(String, String, String, Credential, XenonProperties) - Constructor for class nl.esciencecenter.xenon.schedulers.Scheduler
+
 
+
SchedulerAdaptor - Class in nl.esciencecenter.xenon.adaptors.schedulers
+
 
+
SchedulerAdaptor(String, String, String[], XenonPropertyDescription[]) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.SchedulerAdaptor
+
 
+
SchedulerAdaptorDescription - Interface in nl.esciencecenter.xenon.schedulers
+
 
+
schedulerArguments - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The arguments to pass to the scheduler.
+
+
SchedulerClosedException - Exception in nl.esciencecenter.xenon.adaptors.schedulers
+
+
Signals that a unknown Copy handle was provided.
+
+
SchedulerClosedException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.adaptors.schedulers.SchedulerClosedException
+
 
+
SchedulerClosedException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.schedulers.SchedulerClosedException
+
 
+
schedulerSpecificInformation - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
 
+
schedulerSpecificInformation - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.QueueStatusImplementation
+
 
+
ScriptingParser - Class in nl.esciencecenter.xenon.adaptors.schedulers
+
 
+
ScriptingParser() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingParser
+
 
+
ScriptingScheduler - Class in nl.esciencecenter.xenon.adaptors.schedulers
+
+
Connection to a remote scheduler, implemented by calling command line commands over a ssh connection.
+
+
ScriptingScheduler(String, String, String, Credential, Map<String, String>, XenonPropertyDescription[], String) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
 
+
ScriptingSchedulerAdaptor - Class in nl.esciencecenter.xenon.adaptors.schedulers
+
 
+
ScriptingSchedulerAdaptor(String, String, String[], XenonPropertyDescription[]) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingSchedulerAdaptor
+
 
+
ScriptingUtils - Class in nl.esciencecenter.xenon.adaptors.schedulers
+
 
+
ScriptingUtils() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingUtils
+
 
+
separator - Variable in class nl.esciencecenter.xenon.filesystems.Path
+
+
The separator used in this path
+
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.adaptors.filesystems.ConnectionLostException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.adaptors.filesystems.EndOfFileException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.adaptors.filesystems.NoSpaceException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.adaptors.filesystems.PermissionDeniedException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.adaptors.NotConnectedException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.adaptors.schedulers.BadParameterException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.adaptors.schedulers.IncompatibleVersionException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.adaptors.schedulers.JobCanceledException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.adaptors.schedulers.local.CommandNotFoundException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.adaptors.schedulers.SchedulerClosedException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.adaptors.shared.ssh.CertificateNotFoundException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.adaptors.shared.ssh.CredentialNotFoundException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.filesystems.AttributeNotSupportedException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.filesystems.DirectoryNotEmptyException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.filesystems.FileSystemClosedException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.filesystems.InvalidOptionsException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.filesystems.InvalidPathException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.filesystems.InvalidResumeTargetException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.filesystems.NoSuchCopyException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.filesystems.NoSuchPathException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.filesystems.PathAlreadyExistsException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.InvalidCredentialException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.InvalidLocationException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.InvalidPropertyException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.PropertyTypeException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.schedulers.IncompleteJobDescriptionException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.schedulers.InvalidJobDescriptionException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.schedulers.NoSuchJobException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.schedulers.NoSuchQueueException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.schedulers.UnsupportedJobDescriptionException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.UnknownAdaptorException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.UnknownPropertyException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.UnsupportedOperationException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.XenonException
+
 
+
serialVersionUID - Static variable in exception nl.esciencecenter.xenon.XenonRuntimeException
+
 
+
server - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
server - Variable in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil.Tunnel
+
 
+
session - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcess
+
 
+
session - Variable in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHConnection
+
 
+
sessions - Variable in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHConnection
+
 
+
setArguments(String...) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Sets the command line arguments of the executable.
+
+
setArguments(String...) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
+
This method should not be used.
+
+
setCreationTime(long) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
setDirectory(boolean) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
setEnvironment(Map<String, String>) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Sets the environment of the executable.
+
+
setExecutable(boolean) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
setExecutable(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Sets the path to the executable.
+
+
setFinished() - Method in class nl.esciencecenter.xenon.utils.InputWriter
+
 
+
setFinished() - Method in class nl.esciencecenter.xenon.utils.OutputReader
+
 
+
setGroup(String) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
setHidden(boolean) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
setJavaArguments(String...) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
+
Sets the arguments of the java main class.
+
+
setJavaClasspath(String...) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
+
Sets the java class path.
+
+
setJavaMain(String) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
+
Sets the main class.
+
+
setJavaOptions(String...) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
+
Sets the JVM options.
+
+
setJavaSystemProperties(Map<String, String>) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
+
Sets the system properties.
+
+
setJobOptions(Map<String, String>) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Sets the job options of the job.
+
+
setLastAccessTime(long) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
setLastModifiedTime(long) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
setMaxMemory(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Set the amount of memory needed for process (in MBytes).
+
+
setMaxRuntime(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Set the maximum job duration in minutes.
+
+
setName(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Set the name of the job.
+
+
setNodeCount(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Set the number of nodes.
+
+
setOther(boolean) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
setOwner(String) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
setPath(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
setPermissions(Set<PosixFilePermission>) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
setPosixFilePermissions(Path, Set<PosixFilePermission>) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
setPosixFilePermissions(Path, Set<PosixFilePermission>) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
setPosixFilePermissions(Path, Set<PosixFilePermission>) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
setPosixFilePermissions(Path, Set<PosixFilePermission>) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
setPosixFilePermissions(Path, Set<PosixFilePermission>) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
setPosixFilePermissions(Path, Set<PosixFilePermission>) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
setPosixFilePermissions(Path, Set<PosixFilePermission>) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Sets the POSIX permissions of a path (optional operation).
+
+
setProcessesPerNode(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Set the number of processes started on each node.
+
+
setQueueName(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Set the queue name;
+
+
setReadable(boolean) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
setRegular(boolean) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
setSchedulerArguments(String...) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Sets the scheduler specific arguments for this job.
+
+
setSession(ClientSession) - Method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHConnection
+
 
+
setSize(long) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
setStartSingleProcess(boolean) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Set if only a single process is started, instead of nodeCount * processesPerNode.
+
+
setStderr(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Sets the path to the file to which the executable must redirect stderr.
+
+
setStdin(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Sets the path to the file from which the executable must redirect stdin.
+
+
setStdout(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Sets the path to the file to which the executable must redirect stdout.
+
+
setStreams(Streams) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
setSymbolicLink(boolean) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
setThreadsPerProcess(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Set the number of threads needed per process.
+
+
setup - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
setupInfo - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
setWorkingDirectory(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Set the current working directory of this file system to directory.
+
+
setWorkingDirectory(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Sets the path of the working directory for the executable.
+
+
setWritable(boolean) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
sftpExceptionToXenonException(IOException, String) - Static method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
SftpFileAdaptor - Class in nl.esciencecenter.xenon.adaptors.filesystems.sftp
+
 
+
SftpFileAdaptor() - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
 
+
SftpFileSystem - Class in nl.esciencecenter.xenon.adaptors.filesystems.sftp
+
 
+
SftpFileSystem(String, String, String, Credential, Path, int, SSHConnection, SftpClient, XenonProperties) - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
SGE62_SCHEMA_ATTRIBUTE - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineXmlParser
+
 
+
SGE62_SCHEMA_VALUE - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineXmlParser
+
 
+
SINGLE_QUEUE_NAME - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
singleExecutor - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
singleQ - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
size - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
The size of this file
+
+
skip(long) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpInputStream
+
 
+
sleep(long) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
+
Sleep for a certain amount of time, provide the job is not done, and no one requested an update.
+
+
sleep(long) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
 
+
slots - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
+
 
+
slots - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.QueueInfo
+
 
+
SLURM_UPDATE_SLEEP - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSchedulerAdaptor
+
 
+
SLURM_UPDATE_TIMEOUT - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSchedulerAdaptor
+
 
+
SlurmScheduler - Class in nl.esciencecenter.xenon.adaptors.schedulers.slurm
+
+
Interface to the GridEngine command line tools.
+
+
SlurmScheduler(String, String, Credential, XenonPropertyDescription[], Map<String, String>) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
SlurmSchedulerAdaptor - Class in nl.esciencecenter.xenon.adaptors.schedulers.slurm
+
+
Adaptor for Slurm scheduler.
+
+
SlurmSchedulerAdaptor() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSchedulerAdaptor
+
 
+
SlurmSetup - Class in nl.esciencecenter.xenon.adaptors.schedulers.slurm
+
 
+
SlurmSetup(Map<String, String>, boolean) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSetup
+
 
+
SlurmUtils - Class in nl.esciencecenter.xenon.adaptors.schedulers.slurm
+
 
+
SlurmUtils() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
 
+
socket - Variable in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil.Tunnel
+
 
+
source - Variable in class nl.esciencecenter.xenon.utils.OutputReader
+
 
+
SSH_CONFIG_FILE - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
+
OpenSSH config filename.
+
+
SSH_CONFIG_FILE - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
OpenSSH config filename.
+
+
SSHConnection - Class in nl.esciencecenter.xenon.adaptors.shared.ssh
+
 
+
SSHConnection(int) - Constructor for class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHConnection
+
 
+
SshInteractiveProcess - Class in nl.esciencecenter.xenon.adaptors.schedulers.ssh
+
+
LocalBatchProcess implements a InteractiveProcess for local batch processes.
+
+
SshInteractiveProcess(ClientSession, JobDescription, String, long) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcess
+
 
+
SshInteractiveProcessFactory - Class in nl.esciencecenter.xenon.adaptors.schedulers.ssh
+
 
+
SshInteractiveProcessFactory(SSHConnection) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcessFactory
+
 
+
SshSchedulerAdaptor - Class in nl.esciencecenter.xenon.adaptors.schedulers.ssh
+
 
+
SshSchedulerAdaptor() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
 
+
SSHUtil - Class in nl.esciencecenter.xenon.adaptors.shared.ssh
+
 
+
SSHUtil() - Constructor for class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
+
+
This constructor is only needed for testing.
+
+
SSHUtil.PasswordProvider - Class in nl.esciencecenter.xenon.adaptors.shared.ssh
+
 
+
SSHUtil.Tunnel - Class in nl.esciencecenter.xenon.adaptors.shared.ssh
+
 
+
stack - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem.RecursiveListIterator
+
 
+
stack - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.RecursiveListIterator
+
 
+
start(long) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyCallback
+
 
+
started - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyCallback
+
 
+
startInteractiveCommand(String, String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
+
Start an interactive command on the remote machine (usually via ssh).
+
+
startSingleProcess - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
If true, only a single process is started on the first node aquired, instead of nodeCount * processesPerNode.
+
+
startsWith(Path) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Tests if this Path starts with the given Path.
+
+
startsWith(String) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Tests if this Path starts with the given Path represented as a String.
+
+
startsWithLinuxRoot(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
+
Checks if the provide path starts with a valid Linux root, that is "/".
+
+
startupTimeout - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
startupTimeout - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
startWithRoot(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
+
Checks if the provide path starts with a valid root, such as "/" or "C:".
+
+
startWithWindowsRoot(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
+
Checks if the provide path starts with a valid Windows root, for example "C:".
+
+
stat(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
state - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
state - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
 
+
state - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
stderr - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.StreamsImplementation
+
 
+
stderr - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The location file which to redirect stderr to.
+
+
stderrForwarder - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.BatchProcess
+
 
+
stdin - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.StreamsImplementation
+
 
+
stdin - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The location file from which to redirect stdin.
+
+
stdinForwarder - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.BatchProcess
+
 
+
stdout - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.StreamsImplementation
+
 
+
stdout - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The location file which to redirect stdout to.
+
+
stdoutForwarder - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.BatchProcess
+
 
+
streamCopy(InputStream, OutputStream, int, FileSystem.CopyCallback) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Copy data from in to out using a buffer size of buffersize.
+
+
StreamForwarder - Class in nl.esciencecenter.xenon.utils
+
+
A simple stream forwarder that uses a daemon thread to read from an InputStream and write it to a OutputStream.
+
+
StreamForwarder(String, InputStream, OutputStream, int) - Constructor for class nl.esciencecenter.xenon.utils.StreamForwarder
+
+
Create a new StreamForwarder and start it immediately.
+
+
StreamForwarder(InputStream, OutputStream) - Constructor for class nl.esciencecenter.xenon.utils.StreamForwarder
+
+
Create a new StreamForwarder and start it immediately.
+
+
streams - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
streams - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcess
+
 
+
streams - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcess
+
 
+
Streams - Interface in nl.esciencecenter.xenon.schedulers
+
+
Streams is a container for the standard input, output and error streams of a job.
+
+
StreamsImplementation - Class in nl.esciencecenter.xenon.adaptors.schedulers
+
+
Streams is a container for the standard input, output and error streams of a job.
+
+
StreamsImplementation(String, InputStream, OutputStream, InputStream) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.StreamsImplementation
+
+
Create a Streams containing the job and its standard streams.
+
+
StreamToFileWriter(String, InputStream) - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem.StreamToFileWriter
+
 
+
STRICT_HOST_KEY_CHECKING - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
+
Enable strict host key checking.
+
+
STRICT_HOST_KEY_CHECKING - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
Enable strict host key checking.
+
+
subFileSystem - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
 
+
submit(JobDescription, boolean) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
submitBatchJob(JobDescription) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
submitBatchJob(JobDescription) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
submitBatchJob(JobDescription) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
submitBatchJob(JobDescription) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
submitBatchJob(JobDescription) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Submit a batch job.
+
+
submitInteractiveJob(JobDescription) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
submitInteractiveJob(JobDescription) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
submitInteractiveJob(JobDescription) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
submitInteractiveJob(JobDescription) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
submitInteractiveJob(JobDescription) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Submit an interactive job (optional operation).
+
+
SUBMITTED - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
+
How many jobs have been submitted locally.
+
+
SUBMITTED - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
How many jobs have been submitted using this adaptor.
+
+
subpath(int, int) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Returns a Path that is a subsequence of the name elements of this path.
+
+
subScheduler - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
 
+
success() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.RemoteCommandRunner
+
 
+
SUPPORTED_VERSIONS - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSchedulerAdaptor
+
 
+
supportedLocations - Variable in class nl.esciencecenter.xenon.adaptors.Adaptor
+
 
+
supportedProperties - Variable in class nl.esciencecenter.xenon.adaptors.Adaptor
+
 
+
supportsBatch() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.SchedulerAdaptor
+
 
+
supportsBatch() - Method in interface nl.esciencecenter.xenon.schedulers.SchedulerAdaptorDescription
+
+
Does this Scheduler support the submission of batch jobs ? + + For batch jobs the standard streams of the jobs are redirected from and to files.
+
+
supportsInteractive() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
 
+
supportsInteractive() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.SchedulerAdaptor
+
 
+
supportsInteractive() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSchedulerAdaptor
+
 
+
supportsInteractive() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
 
+
supportsInteractive() - Method in interface nl.esciencecenter.xenon.schedulers.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.
+
+
supportsProperty(String) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Check if this XenonProperties supports a property with the given name.
+
+
supportsReadingPosixPermissions() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor
+
 
+
supportsReadingPosixPermissions() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
 
+
supportsReadingPosixPermissions() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileAdaptor
+
 
+
supportsReadingPosixPermissions() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor
+
 
+
supportsReadingPosixPermissions() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
 
+
supportsReadingPosixPermissions() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
+
 
+
supportsRename() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor
+
 
+
supportsRename() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor
+
 
+
supportsRename() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
+
 
+
supportsSettingPosixPermissions() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor
+
 
+
supportsSettingPosixPermissions() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileAdaptor
+
 
+
supportsSettingPosixPermissions() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor
+
 
+
supportsSettingPosixPermissions() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
 
+
supportsSettingPosixPermissions() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
+
 
+
supportsThirdPartyCopy() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor
+
 
+
supportsThirdPartyCopy() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
+
+
Does this adaptor support third party copy ? + + In third party copy, a file is copied between two remote locations, without passing through the local machine first.
+
+
+ + + +

T

+
+
terminate(long) - Method in class nl.esciencecenter.xenon.utils.StreamForwarder
+
+
Wait for a given timeout for the StreamForwarder to terminate by reading an end-of-stream on the input.
+
+
TERMINATION_DELAY - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.BatchProcess
+
+
Time to wait for a StreamForwarder to terminate (in ms.)
+
+
threadsPerProcess - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The number of threads the executable will use per processes
+
+
TIMEOUT - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
Add gateway to access machine.
+
+
toAbsolutePath(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Convert the provided path to an absolute path by (if necessary) resolving a relative path against the working directory of this FileSystem.
+
+
toAbsolutePath() - Method in class nl.esciencecenter.xenon.filesystems.Path
+
 
+
toBucketEntry(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
toHDFSPath(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
toMap() - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Returns all properties that are set in a new Map.
+
+
toPathAttributes(FileStatus) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
toPathAttributes(StorageMetadata) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
toPermissionSet(FsPermission) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
toRelativePath() - Method in class nl.esciencecenter.xenon.filesystems.Path
+
 
+
TorqueScheduler - Class in nl.esciencecenter.xenon.adaptors.schedulers.torque
+
+
Interface to the TORQUE command line tools.
+
+
TorqueScheduler(String, String, Credential, XenonPropertyDescription[], Map<String, String>) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
TorqueSchedulerAdaptor - Class in nl.esciencecenter.xenon.adaptors.schedulers.torque
+
+
Adaptor for TORQUE batch system.
+
+
TorqueSchedulerAdaptor() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueSchedulerAdaptor
+
 
+
TorqueUtils - Class in nl.esciencecenter.xenon.adaptors.schedulers.torque
+
+
Generator for GridEngine job script.
+
+
TorqueUtils() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueUtils
+
 
+
TorqueXmlParser - Class in nl.esciencecenter.xenon.adaptors.schedulers.torque
+
+
Parses xml output from TORQUE batch system.
+
+
TorqueXmlParser() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueXmlParser
+
 
+
toString() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpInputStream
+
 
+
toString() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpOutputStream
+
 
+
toString() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
 
+
toString() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
+
 
+
toString() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.QueueInfo
+
 
+
toString() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
+
 
+
toString() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.QueueStatusImplementation
+
 
+
toString() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.RemoteCommandRunner
+
 
+
toString() - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
 
+
toString() - Method in class nl.esciencecenter.xenon.credentials.CertificateCredential
+
 
+
toString() - Method in class nl.esciencecenter.xenon.credentials.PasswordCredential
+
 
+
toString() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
toString() - Method in class nl.esciencecenter.xenon.filesystems.Path
+
 
+
toString() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
 
+
toString() - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
+
 
+
toString() - Method in class nl.esciencecenter.xenon.XenonPropertyDescription
+
 
+
translateError(RemoteCommandRunner, String, String, String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
 
+
translateError(RemoteCommandRunner, String, String, String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
translateProperties(Map<String, String>, String, XenonPropertyDescription[], String) - Static method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
+
 
+
triggerStatusUpdate() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
+
Signal the polling thread to produce a status update.
+
+
Tunnel(ServerSocket, ChannelDirectTcpip, int) - Constructor for class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil.Tunnel
+
 
+
tunnels - Variable in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHConnection
+
 
+
type - Variable in class nl.esciencecenter.xenon.XenonPropertyDescription
+
 
+
Type() - Constructor for enum nl.esciencecenter.xenon.XenonPropertyDescription.Type
+
 
+
+ + + +

U

+
+
uniqueID - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
uniqueID - Variable in class nl.esciencecenter.xenon.schedulers.Scheduler
+
 
+
UnknownAdaptorException - Exception in nl.esciencecenter.xenon
+
+
Thrown when an unknown adaptor name is provided.
+
+
UnknownAdaptorException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.UnknownAdaptorException
+
 
+
UnknownAdaptorException(String, String) - Constructor for exception nl.esciencecenter.xenon.UnknownAdaptorException
+
 
+
UnknownPropertyException - Exception in nl.esciencecenter.xenon
+
+
Signals that a property has a different type than the get method it was retrieved with.
+
+
UnknownPropertyException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.UnknownPropertyException
+
 
+
UnknownPropertyException(String, String) - Constructor for exception nl.esciencecenter.xenon.UnknownPropertyException
+
 
+
UNLIMITED_QUEUE_NAME - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
unlimitedExecutor - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
unlimitedQ - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
UnsupportedJobDescriptionException - Exception in nl.esciencecenter.xenon.schedulers
+
+
Signals that a combination of options used in a JobDescription is not supported by a resource.
+
+
UnsupportedJobDescriptionException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.schedulers.UnsupportedJobDescriptionException
+
 
+
UnsupportedJobDescriptionException(String, String) - Constructor for exception nl.esciencecenter.xenon.schedulers.UnsupportedJobDescriptionException
+
 
+
UnsupportedOperationException - Exception in nl.esciencecenter.xenon
+
+
Throw when an unsupported optional operation is called.
+
+
UnsupportedOperationException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.UnsupportedOperationException
+
 
+
UnsupportedOperationException(String, String) - Constructor for exception nl.esciencecenter.xenon.UnsupportedOperationException
+
 
+
updateJobsSeenMap(Set<String>) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
updateJobsSeenMap(Set<String>) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
 
+
updateSignal - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
updateState(String, int, XenonException) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
url - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem.StreamToFileWriter
+
 
+
USER_TYPES - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
UserCredential - Interface in nl.esciencecenter.xenon.credentials
+
 
+
username - Variable in class nl.esciencecenter.xenon.credentials.DefaultCredential
+
 
+
username - Variable in class nl.esciencecenter.xenon.credentials.KeytabCredential
+
 
+
username - Variable in class nl.esciencecenter.xenon.credentials.PasswordCredential
+
+
The user name associated with the credential.
+
+
usesFileSystem() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.SchedulerAdaptor
+
 
+
usesFileSystem() - Method in interface nl.esciencecenter.xenon.schedulers.SchedulerAdaptorDescription
+
+
Does this Scheduler create a FileSystem to support the submission of jobs ? + + Many scheduler implementations use a FileSystem internally to handle job submission, for example to store submission scripts or handle the standard I/O + streams of a process.
+
+
+ + + +

V

+
+
VALID_JOB_OPTIONS - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
VALID_JOB_OPTIONS - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
 
+
VALID_JOB_OPTIONS - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueUtils
+
 
+
VALID_PROPERTIES - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
+
List of properties supported by this FTP adaptor
+
+
VALID_PROPERTIES - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileAdaptor
+
 
+
VALID_PROPERTIES - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileAdaptor
+
+
List of properties supported by this FTP adaptor
+
+
VALID_PROPERTIES - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.s3.S3FileAdaptor
+
+
List of properties supported by this FTP adaptor
+
+
VALID_PROPERTIES - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileAdaptor
+
+
List of properties supported by this SSH adaptor
+
+
VALID_PROPERTIES - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileAdaptor
+
+
List of properties supported by this FTP adaptor
+
+
VALID_PROPERTIES - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSchedulerAdaptor
+
+
List of all properties supported by this adaptor
+
+
VALID_PROPERTIES - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalSchedulerAdaptor
+
+
The properties supported by this adaptor
+
+
VALID_PROPERTIES - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSchedulerAdaptor
+
+
List of all properties supported by this adaptor
+
+
VALID_PROPERTIES - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
List of properties supported by this SSH adaptor
+
+
VALID_PROPERTIES - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueSchedulerAdaptor
+
+
List of all properties supported by this adaptor
+
+
validateHost(String, String) - Static method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
+
+
Weak validation of a host string containing either a hostame of IP adres.
+
+
validProperties(XenonPropertyDescription[]) - Static method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
+
 
+
valueOf(String) - Static method in enum nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo.AllocationRule
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum nl.esciencecenter.xenon.filesystems.CopyMode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum nl.esciencecenter.xenon.XenonPropertyDescription.Type
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Static method in enum nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo.AllocationRule
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum nl.esciencecenter.xenon.filesystems.CopyMode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum nl.esciencecenter.xenon.XenonPropertyDescription.Type
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
verifyJobDescription(JobDescription) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
verifyJobDescription(JobDescription, boolean) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
verifyJobDescription(JobDescription, String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingUtils
+
+
Do some checks on a job description.
+
+
verifyJobDescription(JobDescription, boolean) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
 
+
verifyJobDescription(JobDescription) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueUtils
+
 
+
verifyJobInfo(Map<String, String>, String, String, String, String...) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingUtils
+
+
Check if the info map for a job exists, contains the expected job ID, and contains the given additional fields
+
+
verifyJobOptions(Map<String, String>, String[], String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingUtils
+
 
+
verifyLoginSuccess(int) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
 
+
version - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSetup
+
 
+
version() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSetup
+
 
+
VIA_TAG - Static variable in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
+
 
+
+ + + +

W

+
+
waitForStatusUpdate(long) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
+
Wait for a certain amount of time for an update.
+
+
waitUntilDone(long) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
waitUntilDone(String, long) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
waitUntilDone(String, long) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
+
Wait until a Job is done, or until the give timeout expires (whichever comes first).
+
+
waitUntilDone(String, long) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Wait until a copy operation is done or until a timeout expires.
+
+
waitUntilDone(String, long) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Wait until a job is done or until a timeout expires.
+
+
waitUntilFinished() - Method in class nl.esciencecenter.xenon.utils.InputWriter
+
+
Wait until the InputWriter has finished writing.
+
+
waitUntilFinished() - Method in class nl.esciencecenter.xenon.utils.OutputReader
+
+
Waits until the OutputReader has finished (i.e., has reached the end-of-stream on the input).
+
+
waitUntilRunning(long) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
waitUntilRunning(String, long) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
waitUntilRunning(String, long) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
+
Wait until a Job is running (or already done), or until the given timeout expires, whichever comes first.
+
+
waitUntilRunning(String, long) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Wait until a job starts running, or until a timeout expires.
+
+
WebdavFileAdaptor - Class in nl.esciencecenter.xenon.adaptors.filesystems.webdav
+
 
+
WebdavFileAdaptor() - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileAdaptor
+
 
+
WebdavFileSystem - Class in nl.esciencecenter.xenon.adaptors.filesystems.webdav
+
 
+
WebdavFileSystem(String, String, String, Credential, String, Path, int, Sardine, XenonProperties) - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
WebdavFileSystem.StreamToFileWriter - Class in nl.esciencecenter.xenon.adaptors.filesystems.webdav
+
 
+
WHITESPACE_REGEX - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingParser
+
 
+
workingDirectory - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
+
 
+
workingDirectory - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
workingDirectory - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
workingDirectory - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The working directory for the job.
+
+
writable - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
Is the file writable ?
+
+
write(int) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpOutputStream
+
 
+
write(byte[]) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpOutputStream
+
 
+
write(byte[], int, int) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpOutputStream
+
 
+
WRITE_GROUP - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
+
write by group
+
+
WRITE_OTHERS - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
+
write by others
+
+
WRITE_OWNER - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
+
write by owner
+
+
writeToFile(Path, long) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
writeToFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
writeToFile(Path, long) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
writeToFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.hdfs.HDFSFileSystem
+
 
+
writeToFile(Path, long) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
writeToFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem
+
 
+
writeToFile(Path, long) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
writeToFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
writeToFile(Path, long) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
writeToFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
writeToFile(Path, long) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
writeToFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
writeToFile(Path, long) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Open a file and return an OutputStream to write to this file.
+
+
writeToFile(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Open a file and return an OutputStream to write to this file.
+
+
+ + + +

X

+
+
XenonException - Exception in nl.esciencecenter.xenon
+
+
XenonException is the parent exception for all exceptions raised in Xenon.
+
+
XenonException(String, String) - Constructor for exception nl.esciencecenter.xenon.XenonException
+
 
+
XenonException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.XenonException
+
 
+
xenonPermissions(Set<PosixFilePermission>) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
XenonProperties - Class in nl.esciencecenter.xenon.adaptors
+
+
Read-only properties implementation.
+
+
XenonProperties(Map<String, XenonPropertyDescription>, Map<String, String>) - Constructor for class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Private constructor for XenonProperties using in copying and filtering.
+
+
XenonProperties() - Constructor for class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Creates an empty XenonProperties.
+
+
XenonProperties(XenonPropertyDescription[], Map<String, String>) - Constructor for class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Create a new XenonProperties that will support the properties in supportedProperties.
+
+
XenonPropertyDescription - Class in nl.esciencecenter.xenon
+
+
XenonPropertyDescription contains all necessary information about a property that is recognized by Xenon
+
+
XenonPropertyDescription(String, XenonPropertyDescription.Type, String, String) - Constructor for class nl.esciencecenter.xenon.XenonPropertyDescription
+
 
+
XenonPropertyDescription.Type - Enum in nl.esciencecenter.xenon
+
+
This Type enumeration lists all possible types of properties recognized by Xenon.
+
+
XenonRuntimeException - Exception in nl.esciencecenter.xenon
+
+
XenonRuntimeException is the parent for all runtime exceptions raised in Xenon.
+
+
XenonRuntimeException(String, String) - Constructor for exception nl.esciencecenter.xenon.XenonRuntimeException
+
 
+
XenonRuntimeException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.XenonRuntimeException
+
 
+
+A B C D E F G H I J K L M N O P Q R S T U V W X 
+ +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/index.html b/docs/versions/2.6.1/javadoc-devel/index.html new file mode 100644 index 000000000..871f73ab4 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/index.html @@ -0,0 +1,74 @@ + + + + + +xenon-2.3.0 2.6.1 API for Xenon developers + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/AdaptorDescription.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/AdaptorDescription.html new file mode 100644 index 000000000..f9b885d3e --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/AdaptorDescription.html @@ -0,0 +1,314 @@ + + + + + +AdaptorDescription (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
nl.esciencecenter.xenon
+

Interface AdaptorDescription

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        Get the name of the adaptor.
        +
        +
        Returns:
        +
        the name of the adaptor.
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        java.lang.String getDescription()
        +
        Get the description of the adaptor.
        +
        +
        Returns:
        +
        the description of the adaptor.
        +
        +
        • +
      + + + +
        +
      • +

        getSupportedLocations

        +
        java.lang.String[] getSupportedLocations()
        +
        Get the supported locations for this adaptor.
        +
        +
        Returns:
        +
        the locations supported by this adaptor.
        +
        +
        • +
      + + + +
        +
      • +

        getSupportedCredentials

        +
        java.lang.Class[] getSupportedCredentials()
        +
        Get the supported credential types for this adaptor.
        +
        +
        Returns:
        +
        the credential types supported by this adaptor.
        +
        +
        • +
      + + + +
        +
      • +

        getSupportedProperties

        +
        XenonPropertyDescription[] getSupportedProperties()
        +
        Returns an array containing all properties this adaptor supports.
        +
        +
        Returns:
        +
        an array containing all properties this adaptor supports.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/InvalidCredentialException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/InvalidCredentialException.html new file mode 100644 index 000000000..871151adc --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/InvalidCredentialException.html @@ -0,0 +1,332 @@ + + + + + +InvalidCredentialException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon
+

Class InvalidCredentialException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class InvalidCredentialException
+extends XenonException
    +
    Signals that an invalid credential was used to access a resource.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      InvalidCredentialException(java.lang.String adaptorName, + java.lang.String message) 
      InvalidCredentialException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InvalidCredentialException

        +
        public InvalidCredentialException(java.lang.String adaptorName,
+                                  java.lang.String message,
+                                  java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        InvalidCredentialException

        +
        public InvalidCredentialException(java.lang.String adaptorName,
+                                  java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/InvalidLocationException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/InvalidLocationException.html new file mode 100644 index 000000000..c8ae29b13 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/InvalidLocationException.html @@ -0,0 +1,332 @@ + + + + + +InvalidLocationException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon
+

Class InvalidLocationException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class InvalidLocationException
+extends XenonException
    +
    Signals that an invalid location was provided.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      InvalidLocationException(java.lang.String adaptorName, + java.lang.String message) 
      InvalidLocationException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InvalidLocationException

        +
        public InvalidLocationException(java.lang.String adaptorName,
+                                java.lang.String message,
+                                java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        InvalidLocationException

        +
        public InvalidLocationException(java.lang.String adaptorName,
+                                java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/InvalidPropertyException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/InvalidPropertyException.html new file mode 100644 index 000000000..4330872b1 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/InvalidPropertyException.html @@ -0,0 +1,332 @@ + + + + + +InvalidPropertyException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon
+

Class InvalidPropertyException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class InvalidPropertyException
+extends XenonException
    +
    Signals that a property has a different type than the get method it was retrieved with.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      InvalidPropertyException(java.lang.String adaptorName, + java.lang.String message) 
      InvalidPropertyException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InvalidPropertyException

        +
        public InvalidPropertyException(java.lang.String adaptorName,
+                                java.lang.String message,
+                                java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        InvalidPropertyException

        +
        public InvalidPropertyException(java.lang.String adaptorName,
+                                java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/PropertyTypeException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/PropertyTypeException.html new file mode 100644 index 000000000..a541071ea --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/PropertyTypeException.html @@ -0,0 +1,332 @@ + + + + + +PropertyTypeException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon
+

Class PropertyTypeException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class PropertyTypeException
+extends XenonException
    +
    Signals that a property has a different type than the get method it was retrieved with.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PropertyTypeException(java.lang.String adaptorName, + java.lang.String message) 
      PropertyTypeException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PropertyTypeException

        +
        public PropertyTypeException(java.lang.String adaptorName,
+                             java.lang.String message,
+                             java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        PropertyTypeException

        +
        public PropertyTypeException(java.lang.String adaptorName,
+                             java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/UnknownAdaptorException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/UnknownAdaptorException.html new file mode 100644 index 000000000..03907bdf4 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/UnknownAdaptorException.html @@ -0,0 +1,330 @@ + + + + + +UnknownAdaptorException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon
+

Class UnknownAdaptorException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class UnknownAdaptorException
+extends XenonException
    +
    Thrown when an unknown adaptor name is provided.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      UnknownAdaptorException(java.lang.String adaptorName, + java.lang.String message) 
      UnknownAdaptorException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UnknownAdaptorException

        +
        public UnknownAdaptorException(java.lang.String adaptorName,
+                               java.lang.String message,
+                               java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        UnknownAdaptorException

        +
        public UnknownAdaptorException(java.lang.String adaptorName,
+                               java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/UnknownPropertyException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/UnknownPropertyException.html new file mode 100644 index 000000000..414b7de0f --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/UnknownPropertyException.html @@ -0,0 +1,332 @@ + + + + + +UnknownPropertyException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon
+

Class UnknownPropertyException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class UnknownPropertyException
+extends XenonException
    +
    Signals that a property has a different type than the get method it was retrieved with.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      UnknownPropertyException(java.lang.String adaptorName, + java.lang.String message) 
      UnknownPropertyException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UnknownPropertyException

        +
        public UnknownPropertyException(java.lang.String adaptorName,
+                                java.lang.String message,
+                                java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        UnknownPropertyException

        +
        public UnknownPropertyException(java.lang.String adaptorName,
+                                java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/UnsupportedOperationException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/UnsupportedOperationException.html new file mode 100644 index 000000000..9d1911681 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/UnsupportedOperationException.html @@ -0,0 +1,330 @@ + + + + + +UnsupportedOperationException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon
+

Class UnsupportedOperationException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class UnsupportedOperationException
+extends XenonException
    +
    Throw when an unsupported optional operation is called.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UnsupportedOperationException

        +
        public UnsupportedOperationException(java.lang.String adaptorName,
+                                     java.lang.String message,
+                                     java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        UnsupportedOperationException

        +
        public UnsupportedOperationException(java.lang.String adaptorName,
+                                     java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/XenonException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/XenonException.html new file mode 100644 index 000000000..49521b3cd --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/XenonException.html @@ -0,0 +1,377 @@ + + + + + +XenonException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon
+

Class XenonException

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Throwable
      • +
    • +
        +
      • java.lang.Exception
        • +
      • +
          +
        • nl.esciencecenter.xenon.XenonException
          • +
        +
        • +
      +
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.lang.StringadaptorName 
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      XenonException(java.lang.String adaptorName, + java.lang.String message) 
      XenonException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetMessage() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        serialVersionUID

        +
        private static final long serialVersionUID
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        adaptorName

        +
        private final java.lang.String adaptorName
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        XenonException

        +
        public XenonException(java.lang.String adaptorName,
+                      java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        XenonException

        +
        public XenonException(java.lang.String adaptorName,
+                      java.lang.String message,
+                      java.lang.Throwable t)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMessage

        +
        public java.lang.String getMessage()
        +
        +
        Overrides:
        +
        getMessage in class java.lang.Throwable
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/XenonPropertyDescription.Type.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/XenonPropertyDescription.Type.html new file mode 100644 index 000000000..1778c0f36 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/XenonPropertyDescription.Type.html @@ -0,0 +1,435 @@ + + + + + +XenonPropertyDescription.Type (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon
+

Enum XenonPropertyDescription.Type

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      BOOLEAN +
      Properties of type BOOLEAN can be either "true" or "false".
      +
      DOUBLE +
      Properties of type DOUBLE can be converted into a 64-bit floating point number using + Double.valueOf(String).
      +
      INTEGER +
      Properties of type INTEGER can be converted into a 32-bit signed integer using + Integer.valueOf(String).
      +
      LONG +
      Properties of type LONG can be converted into a 64-bit signed long using + Long.valueOf(String).
      +
      NATURAL +
      Properties of type NATURAL may contain only positive values, including 0.
      +
      SIZE +
      Properties of type SIZE can be converted into a 64-bit signed long using + Long.valueOf(String).
      +
      STRING +
      Properties of type STRING are directly stored in a String without conversion.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static XenonPropertyDescription.TypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static XenonPropertyDescription.Type[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + + + + + +
        +
      • +

        INTEGER

        +
        public static final XenonPropertyDescription.Type INTEGER
        +
        Properties of type INTEGER can be converted into a 32-bit signed integer using + Integer.valueOf(String).
        +
        • +
      + + + +
        +
      • +

        LONG

        +
        public static final XenonPropertyDescription.Type LONG
        +
        Properties of type LONG can be converted into a 64-bit signed long using + Long.valueOf(String).
        +
        • +
      + + + +
        +
      • +

        NATURAL

        +
        public static final XenonPropertyDescription.Type NATURAL
        +
        Properties of type NATURAL may contain only positive values, including 0. + They will be converted into a 64-bit signed long using Long.valueOf(String).
        +
        • +
      + + + +
        +
      • +

        DOUBLE

        +
        public static final XenonPropertyDescription.Type DOUBLE
        +
        Properties of type DOUBLE can be converted into a 64-bit floating point number using + Double.valueOf(String).
        +
        • +
      + + + +
        +
      • +

        STRING

        +
        public static final XenonPropertyDescription.Type STRING
        +
        Properties of type STRING are directly stored in a String without conversion.
        +
        • +
      + + + +
        +
      • +

        SIZE

        +
        public static final XenonPropertyDescription.Type SIZE
        +
        Properties of type SIZE can be converted into a 64-bit signed long using + Long.valueOf(String). In addition, the postfixes "K", "M" and "G" may + be used to multiply the value by 1024, 1024*1024, or 1024*1024*1024 + respectively.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static XenonPropertyDescription.Type[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (XenonPropertyDescription.Type c : XenonPropertyDescription.Type.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static XenonPropertyDescription.Type valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/XenonPropertyDescription.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/XenonPropertyDescription.html new file mode 100644 index 000000000..5f1ca0128 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/XenonPropertyDescription.html @@ -0,0 +1,482 @@ + + + + + +XenonPropertyDescription (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon
+

Class XenonPropertyDescription

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.XenonPropertyDescription
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class XenonPropertyDescription
+extends java.lang.Object
    +

    XenonPropertyDescription contains all necessary information about a property that is recognized by Xenon

    + +

    Each XenonPropertyDescription contains the following information:

    + +
      +
    • + A name that uniquely identifies the property. + This name should be used as a key when passing properties to Xenon in a Map. +
      • + +
    • + A (human-readable) description that explains the use of the property. +
      • +
    • + + The type of values that are accepted for the property (one of the XenonPropertyDescription.Type enum). + Even though it is customary to pass the values of properties as Strings, the user should ensure the values can be + converted into the expected type. +
      • + +
    • + The default value of the property. +
      • +
    +
    +
    Since:
    +
    1.0
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class XenonPropertyDescription.Type +
      This Type enumeration lists all possible types of properties recognized by Xenon.
      +
      +
      • +
    + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetDefaultValue() +
      Returns the default value for this property.
      +
      java.lang.StringgetDescription() +
      Returns a human readable description of this property.
      +
      java.lang.StringgetName() +
      Returns the name of the property.
      +
      XenonPropertyDescription.TypegetType() +
      Returns the type of the property.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        name

        +
        private final java.lang.String name
        +
        • +
      + + + + + + + +
        +
      • +

        defaultValue

        +
        private final java.lang.String defaultValue
        +
        • +
      + + + +
        +
      • +

        description

        +
        private final java.lang.String description
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        XenonPropertyDescription

        +
        public XenonPropertyDescription(java.lang.String name,
+                                XenonPropertyDescription.Type type,
+                                java.lang.String defaultValue,
+                                java.lang.String description)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Returns the name of the property.
        +
        +
        Returns:
        +
        the name of the property.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getDefaultValue

        +
        public java.lang.String getDefaultValue()
        +
        Returns the default value for this property.
        +
        +
        Returns:
        +
        the default value for this property or null is no default is set.
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        Returns a human readable description of this property.
        +
        +
        Returns:
        +
        a human readable description of this property.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/XenonRuntimeException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/XenonRuntimeException.html new file mode 100644 index 000000000..891d74b6c --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/XenonRuntimeException.html @@ -0,0 +1,378 @@ + + + + + +XenonRuntimeException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon
+

Class XenonRuntimeException

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Throwable
      • +
    • +
        +
      • java.lang.Exception
        • +
      • +
          +
        • java.lang.RuntimeException
          • +
        • +
            +
          • nl.esciencecenter.xenon.XenonRuntimeException
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class XenonRuntimeException
+extends java.lang.RuntimeException
    +
    XenonRuntimeException is the parent for all runtime exceptions raised in Xenon. + + Next to the regular exception message and cause, XenonRuntimeException add a source adaptor name to all runtime exceptions.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.lang.StringadaptorName 
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      XenonRuntimeException(java.lang.String adaptorName, + java.lang.String message) 
      XenonRuntimeException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetMessage() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        serialVersionUID

        +
        private static final long serialVersionUID
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        adaptorName

        +
        private final java.lang.String adaptorName
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        XenonRuntimeException

        +
        public XenonRuntimeException(java.lang.String adaptorName,
+                             java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        XenonRuntimeException

        +
        public XenonRuntimeException(java.lang.String adaptorName,
+                             java.lang.String message,
+                             java.lang.Throwable t)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMessage

        +
        public java.lang.String getMessage()
        +
        +
        Overrides:
        +
        getMessage in class java.lang.Throwable
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/Adaptor.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/Adaptor.html new file mode 100644 index 000000000..999b9a7c9 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/Adaptor.html @@ -0,0 +1,472 @@ + + + + + +Adaptor (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors
+

Class Adaptor

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.Adaptor
      • +
    +
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        currentID

        +
        private static int currentID
        +
        • +
      + + + +
        +
      • +

        name

        +
        private final java.lang.String name
        +
        • +
      + + + +
        +
      • +

        description

        +
        private final java.lang.String description
        +
        • +
      + + + +
        +
      • +

        supportedLocations

        +
        private final java.lang.String[] supportedLocations
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Adaptor

        +
        protected Adaptor(java.lang.String name,
+                  java.lang.String description,
+                  java.lang.String[] locations,
+                  XenonPropertyDescription[] properties)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getNewUniqueID

        +
        protected java.lang.String getNewUniqueID()
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Description copied from interface: AdaptorDescription
        +
        Get the name of the adaptor.
        +
        +
        Specified by:
        +
        getName in interface AdaptorDescription
        +
        Returns:
        +
        the name of the adaptor.
        +
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        Description copied from interface: AdaptorDescription
        +
        Get the description of the adaptor.
        +
        +
        Specified by:
        +
        getDescription in interface AdaptorDescription
        +
        Returns:
        +
        the description of the adaptor.
        +
        +
        • +
      + + + +
        +
      • +

        getSupportedLocations

        +
        public java.lang.String[] getSupportedLocations()
        +
        Description copied from interface: AdaptorDescription
        +
        Get the supported locations for this adaptor.
        +
        +
        Specified by:
        +
        getSupportedLocations in interface AdaptorDescription
        +
        Returns:
        +
        the locations supported by this adaptor.
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/NotConnectedException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/NotConnectedException.html new file mode 100644 index 000000000..8dc972f42 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/NotConnectedException.html @@ -0,0 +1,332 @@ + + + + + +NotConnectedException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors
+

Class NotConnectedException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class NotConnectedException
+extends XenonException
    +
    Signals that there was no connection.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      NotConnectedException(java.lang.String adaptorName, + java.lang.String message) 
      NotConnectedException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NotConnectedException

        +
        public NotConnectedException(java.lang.String adaptorName,
+                             java.lang.String message,
+                             java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        NotConnectedException

        +
        public NotConnectedException(java.lang.String adaptorName,
+                             java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/XenonProperties.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/XenonProperties.html new file mode 100644 index 000000000..9cc30d176 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/XenonProperties.html @@ -0,0 +1,1065 @@ + + + + + +XenonProperties (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors
+

Class XenonProperties

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.XenonProperties
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class XenonProperties
+extends java.lang.Object
    +
    Read-only properties implementation. Also contains some utility functions for getting typed properties.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static intGIGA +
      One giga is a kilo*kilo*kilo
      +
      private static intKILO +
      One kilo is 1024
      +
      private static intMEGA +
      One mega is a kilo*kilo
      +
      private static java.lang.StringNAME 
      private java.util.Map<java.lang.String,java.lang.String>properties +
      The properties that are actually set.
      +
      private java.util.Map<java.lang.String,XenonPropertyDescription>propertyDescriptions +
      Contains a description of all properties this XenonProperties should accept, including their type, default, etc.
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
       XenonProperties() +
      Creates an empty XenonProperties.
      +
      private XenonProperties(java.util.Map<java.lang.String,XenonPropertyDescription> propertyDescriptions, + java.util.Map<java.lang.String,java.lang.String> properties) +
      Private constructor for XenonProperties using in copying and filtering.
      +
       XenonProperties(XenonPropertyDescription[] propertyDescriptions, + java.util.Map<java.lang.String,java.lang.String> properties) +
      Create a new XenonProperties that will support the properties in supportedProperties.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private voidaddProperties(java.util.Map<java.lang.String,java.lang.String> properties) +
      Adds the specified properties to the current ones and checks if their names and types are correct.
      +
      private voidcheckType(XenonPropertyDescription description, + java.lang.String key, + java.lang.String value) 
      XenonPropertiesclear(java.lang.String prefix) +
      Returns a copy of this XenonProperties that contains all properties but clears the properties that start with the given prefix.
      +
      static <K,V> java.util.Map<K,V>emptyMap(int capacity) +
      Creates empty mutable Map with sufficient initial capacity.
      +
      XenonPropertiesexclude(java.lang.String prefix) +
      Returns a copy of this XenonProperties that contains all properties except the properties that start with the given prefix.
      +
      XenonPropertiesfilter(java.lang.String prefix) +
      Returns a new XenonProperties that contains only the properties whose key start with a certain prefix.
      +
      private <K,V> java.util.Map<K,V>filterOnKey(java.util.Map<K,V> map, + java.util.function.Predicate<K> predicate) 
      private XenonPropertiesfilterUsingPredicate(java.util.function.Predicate<java.lang.String> predicate) 
      booleangetBooleanProperty(java.lang.String name) +
      Retrieves the value of a boolean property with the given name.
      +
      doublegetDoubleProperty(java.lang.String name) +
      Retrieves the value of an double property with the given name.
      +
      intgetIntegerProperty(java.lang.String name) +
      Retrieves the value of an integer property with the given name.
      +
      intgetIntegerProperty(java.lang.String name, + int defaultValue) +
      Retrieves the value of an integer property with the given name.
      +
      longgetLongProperty(java.lang.String name) +
      Retrieves the value of an long property with the given name.
      +
      longgetNaturalProperty(java.lang.String name) +
      Retrieves the value of an natural number property (e.g.
      +
      java.lang.StringgetProperty(java.lang.String name) +
      Retrieves the value of a property with the given name without checking its type.
      +
      private java.lang.StringgetProperty(java.lang.String name, + XenonPropertyDescription.Type type) 
      java.lang.String[]getPropertyNames() +
      Returns a sorted list of all supported property names.
      +
      longgetSizeProperty(java.lang.String name) +
      Retrieves the value of a size property with the given name.
      +
      java.lang.StringgetStringProperty(java.lang.String name) +
      Retrieves the value of a string property with the given name.
      +
      XenonPropertyDescription[]getSupportedProperties() +
      Returns the descriptions of all supported properties.
      +
      private longparseSizeValue(java.lang.String value) 
      voidprintProperties(java.io.PrintStream out, + java.lang.String prefix) +
      Prints properties (including default properties) to a stream.
      +
      booleanpropertySet(java.lang.String name) +
      Check if the property with the given name is set.
      +
      booleansupportsProperty(java.lang.String name) +
      Check if this XenonProperties supports a property with the given name.
      +
      java.util.Map<java.lang.String,java.lang.String>toMap() +
      Returns all properties that are set in a new Map.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + + + + + +
        +
      • +

        MEGA

        +
        private static final int MEGA
        +
        One mega is a kilo*kilo
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        GIGA

        +
        private static final int GIGA
        +
        One giga is a kilo*kilo*kilo
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        propertyDescriptions

        +
        private final java.util.Map<java.lang.String,XenonPropertyDescription> propertyDescriptions
        +
        Contains a description of all properties this XenonProperties should accept, including their type, default, etc.
        +
        • +
      + + + +
        +
      • +

        properties

        +
        private final java.util.Map<java.lang.String,java.lang.String> properties
        +
        The properties that are actually set.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        XenonProperties

        +
        private XenonProperties(java.util.Map<java.lang.String,XenonPropertyDescription> propertyDescriptions,
+                        java.util.Map<java.lang.String,java.lang.String> properties)
        +
        Private constructor for XenonProperties using in copying and filtering. The properties parameter is assumed to only contain valid supported + properties and have values of the correct type.
        +
        +
        Parameters:
        +
        propertyDescriptions - a map containing a description of all supported properties.
        +
        properties - a map containing valid properties and their values.
        +
        +
        • +
      + + + +
        +
      • +

        XenonProperties

        +
        public XenonProperties()
        +
        Creates an empty XenonProperties.
        +
        • +
      + + + +
        +
      • +

        XenonProperties

        +
        public XenonProperties(XenonPropertyDescription[] propertyDescriptions,
+                       java.util.Map<java.lang.String,java.lang.String> properties)
+                throws UnknownPropertyException,
+                       InvalidPropertyException
        +
        Create a new XenonProperties that will support the properties in supportedProperties. All properties in properties will be + added.
        +
        +
        Parameters:
        +
        propertyDescriptions - the properties to support
        +
        properties - the set of properties to store
        +
        Throws:
        +
        UnknownPropertyException - if key is found in properties that is not listed in supportedProperties
        +
        InvalidPropertyException - if a key from properties has a value that does not match the type as listed in supportedProperties
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        emptyMap

        +
        public static <K,V> java.util.Map<K,V> emptyMap(int capacity)
        +
        Creates empty mutable Map with sufficient initial capacity.
        +
        +
        Type Parameters:
        +
        K - key type
        +
        V - value type
        +
        Parameters:
        +
        capacity - maximum size without resizing underlying data structure
        +
        Returns:
        +
        an empty map
        +
        +
        • +
      + + + +
        +
      • +

        addProperties

        +
        private void addProperties(java.util.Map<java.lang.String,java.lang.String> properties)
+                    throws UnknownPropertyException,
+                           InvalidPropertyException
        +
        Adds the specified properties to the current ones and checks if their names and types are correct.
        +
        +
        Parameters:
        +
        properties - the properties to add.
        +
        Throws:
        +
        UnknownPropertyException - if the property can not be fonud
        +
        InvalidPropertyException - if the type of the value does not match the expected type
        +
        +
        • +
      + + + + + + + +
        +
      • +

        supportsProperty

        +
        public boolean supportsProperty(java.lang.String name)
        +
        Check if this XenonProperties supports a property with the given name.
        +
        +
        Parameters:
        +
        name - the name of the property.
        +
        Returns:
        +
        true if this XenonProperties supports a property with the given name, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        propertySet

        +
        public boolean propertySet(java.lang.String name)
+                    throws UnknownPropertyException
        +
        Check if the property with the given name is set.
        +
        +
        Parameters:
        +
        name - the name of the property.
        +
        Returns:
        +
        true if the property with the given name is set, false otherwise.
        +
        Throws:
        +
        UnknownPropertyException - if the given name is not a supported property.
        +
        +
        • +
      + + + +
        +
      • +

        getProperty

        +
        public java.lang.String getProperty(java.lang.String name)
+                             throws UnknownPropertyException
        +
        Retrieves the value of a property with the given name without checking its type. + + If the property is not set, its default value will be returned. That the type of the value is not checked. Instead its String representation + is always returned.
        +
        +
        Parameters:
        +
        name - the name of the property.
        +
        Returns:
        +
        the value of the property with the given name or its default value if it is not set.
        +
        Throws:
        +
        UnknownPropertyException - if the given name is not a supported property.
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        getStringProperty

        +
        public java.lang.String getStringProperty(java.lang.String name)
+                                   throws UnknownPropertyException,
+                                          PropertyTypeException
        +
        Retrieves the value of a string property with the given name.
        +
        +
        Parameters:
        +
        name - the name of the property
        +
        Returns:
        +
        the value of an string property with the given name.
        +
        Throws:
        +
        UnknownPropertyException - if the given name is not a supported property.
        +
        PropertyTypeException - if the property is not of type string.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getSizeProperty

        +
        public long getSizeProperty(java.lang.String name)
+                     throws UnknownPropertyException,
+                            PropertyTypeException,
+                            InvalidPropertyException
        +
        Retrieves the value of a size property with the given name. + + Valid values for the property are a long or a long a long followed by either a K, M or G. These size modifiers multiply the value by 1024, 1024^2 and + 1024^3 respectively.
        +
        +
        Parameters:
        +
        name - the name of the property
        +
        Returns:
        +
        the value of an size property with the given name.
        +
        Throws:
        +
        UnknownPropertyException - if the given name is not a supported property.
        +
        PropertyTypeException - if the property is not of type size.
        +
        InvalidPropertyException - if the property value cannot be converted into a long.
        +
        +
        • +
      + + + +
        +
      • +

        filter

        +
        public XenonProperties filter(java.lang.String prefix)
        +
        Returns a new XenonProperties that contains only the properties whose key start with a certain prefix.
        +
        +
        Parameters:
        +
        prefix - the desired prefix
        +
        Returns:
        +
        an XenonProperties containing only the matching properties.
        +
        +
        • +
      + + + +
        +
      • +

        exclude

        +
        public XenonProperties exclude(java.lang.String prefix)
        +
        Returns a copy of this XenonProperties that contains all properties except the properties that start with the given prefix. Note that these properties + are also removed from the supported properties set.
        +
        +
        Parameters:
        +
        prefix - the prefix of the properties to exclude
        +
        Returns:
        +
        an XenonProperties containing all properties except the properties with the given prefix.
        +
        +
        • +
      + + + +
        +
      • +

        filterUsingPredicate

        +
        private XenonProperties filterUsingPredicate(java.util.function.Predicate<java.lang.String> predicate)
        +
        • +
      + + + +
        +
      • +

        filterOnKey

        +
        private <K,V> java.util.Map<K,V> filterOnKey(java.util.Map<K,V> map,
+                                             java.util.function.Predicate<K> predicate)
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public XenonProperties clear(java.lang.String prefix)
        +
        Returns a copy of this XenonProperties that contains all properties but clears the properties that start with the given prefix. Note that these + properties are not removed from the supported properties set.
        +
        +
        Parameters:
        +
        prefix - the prefix of the properties to exclude
        +
        Returns:
        +
        an XenonProperties containing all properties except the properties with the given prefix.
        +
        +
        • +
      + + + +
        +
      • +

        getSupportedProperties

        +
        public XenonPropertyDescription[] getSupportedProperties()
        +
        Returns the descriptions of all supported properties.
        +
        +
        Returns:
        +
        the descriptions of all supported properties.
        +
        +
        • +
      + + + +
        +
      • +

        getPropertyNames

        +
        public java.lang.String[] getPropertyNames()
        +
        Returns a sorted list of all supported property names.
        +
        +
        Returns:
        +
        Sorted list of supported property names.
        +
        +
        • +
      + + + +
        +
      • +

        toMap

        +
        public java.util.Map<java.lang.String,java.lang.String> toMap()
        +
        Returns all properties that are set in a new Map.
        +
        +
        Returns:
        +
        all properties that are set in a new Map.
        +
        +
        • +
      + + + +
        +
      • +

        printProperties

        +
        public void printProperties(java.io.PrintStream out,
+                            java.lang.String prefix)
        +
        Prints properties (including default properties) to a stream.
        +
        +
        Parameters:
        +
        out - The stream to write output to.
        +
        prefix - Only print properties which start with the given prefix. If null, will print all properties
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ConnectionLostException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ConnectionLostException.html new file mode 100644 index 000000000..419ca1b68 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ConnectionLostException.html @@ -0,0 +1,332 @@ + + + + + +ConnectionLostException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems
+

Class ConnectionLostException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class ConnectionLostException
+extends XenonException
    +
    Signals that a connection was lost.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      ConnectionLostException(java.lang.String adaptorName, + java.lang.String message) 
      ConnectionLostException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConnectionLostException

        +
        public ConnectionLostException(java.lang.String adaptorName,
+                               java.lang.String message,
+                               java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        ConnectionLostException

        +
        public ConnectionLostException(java.lang.String adaptorName,
+                               java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/EndOfFileException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/EndOfFileException.html new file mode 100644 index 000000000..42839a2c0 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/EndOfFileException.html @@ -0,0 +1,332 @@ + + + + + +EndOfFileException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems
+

Class EndOfFileException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class EndOfFileException
+extends XenonException
    +
    Signals that an end-of-file was encountered.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      EndOfFileException(java.lang.String adaptorName, + java.lang.String message) 
      EndOfFileException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EndOfFileException

        +
        public EndOfFileException(java.lang.String adaptorName,
+                          java.lang.String message,
+                          java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        EndOfFileException

        +
        public EndOfFileException(java.lang.String adaptorName,
+                          java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/FileAdaptor.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/FileAdaptor.html new file mode 100644 index 000000000..8586a52e6 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/FileAdaptor.html @@ -0,0 +1,532 @@ + + + + + +FileAdaptor (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems
+

Class FileAdaptor

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/NoSpaceException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/NoSpaceException.html new file mode 100644 index 000000000..ec09f1163 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/NoSpaceException.html @@ -0,0 +1,332 @@ + + + + + +NoSpaceException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems
+

Class NoSpaceException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class NoSpaceException
+extends XenonException
    +
    Signals that an end-of-file was encountered.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      NoSpaceException(java.lang.String adaptorName, + java.lang.String message) 
      NoSpaceException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NoSpaceException

        +
        public NoSpaceException(java.lang.String adaptorName,
+                        java.lang.String message,
+                        java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        NoSpaceException

        +
        public NoSpaceException(java.lang.String adaptorName,
+                        java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PathAttributesImplementation.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PathAttributesImplementation.html new file mode 100644 index 000000000..f933ab16e --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PathAttributesImplementation.html @@ -0,0 +1,1168 @@ + + + + + +PathAttributesImplementation (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems
+

Class PathAttributesImplementation

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    PathAttributes
    +
    +
    +
    +
    public class PathAttributesImplementation
+extends java.lang.Object
+implements PathAttributes
    +
    FileAttributes represents a set of attributes of a path.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private longcreationTime +
      The creation time of this file
      +
      private booleanexecutable +
      Is the file executable ?
      +
      private java.lang.Stringgroup +
      The group of this file
      +
      private booleanhidden +
      Is the file hidden ?
      +
      private booleanisDirectory +
      Is this a directory ?
      +
      private booleanisOther +
      Is this an other type of file ?
      +
      private booleanisRegular +
      Is this a regular file ?
      +
      private booleanisSymbolicLink +
      Is this a symbolic link ?
      +
      private longlastAccessTime +
      The last access time of this file
      +
      private longlastModifiedTime +
      The last modified time of this file
      +
      private java.lang.Stringowner +
      The owner of this file
      +
      private Pathpath +
      The path these attributes belong to
      +
      private java.util.Set<PosixFilePermission>permissions +
      The permissions of this file (POSIX only)
      +
      private booleanreadable +
      Is the file readable ?
      +
      private longsize +
      The size of this file
      +
      private booleanwritable +
      Is the file writable ?
      +
      +
      • +
    + + + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        path

        +
        private Path path
        +
        The path these attributes belong to
        +
        • +
      + + + +
        +
      • +

        isDirectory

        +
        private boolean isDirectory
        +
        Is this a directory ?
        +
        • +
      + + + +
        +
      • +

        isRegular

        +
        private boolean isRegular
        +
        Is this a regular file ?
        +
        • +
      + + + +
        +
      • +

        isSymbolicLink

        +
        private boolean isSymbolicLink
        +
        Is this a symbolic link ?
        +
        • +
      + + + +
        +
      • +

        isOther

        +
        private boolean isOther
        +
        Is this an other type of file ?
        +
        • +
      + + + +
        +
      • +

        executable

        +
        private boolean executable
        +
        Is the file executable ?
        +
        • +
      + + + +
        +
      • +

        readable

        +
        private boolean readable
        +
        Is the file readable ?
        +
        • +
      + + + +
        +
      • +

        writable

        +
        private boolean writable
        +
        Is the file writable ?
        +
        • +
      + + + +
        +
      • +

        hidden

        +
        private boolean hidden
        +
        Is the file hidden ?
        +
        • +
      + + + +
        +
      • +

        creationTime

        +
        private long creationTime
        +
        The creation time of this file
        +
        • +
      + + + +
        +
      • +

        lastAccessTime

        +
        private long lastAccessTime
        +
        The last access time of this file
        +
        • +
      + + + +
        +
      • +

        lastModifiedTime

        +
        private long lastModifiedTime
        +
        The last modified time of this file
        +
        • +
      + + + +
        +
      • +

        size

        +
        private long size
        +
        The size of this file
        +
        • +
      + + + +
        +
      • +

        owner

        +
        private java.lang.String owner
        +
        The owner of this file
        +
        • +
      + + + +
        +
      • +

        group

        +
        private java.lang.String group
        +
        The group of this file
        +
        • +
      + + + +
        +
      • +

        permissions

        +
        private java.util.Set<PosixFilePermission> permissions
        +
        The permissions of this file (POSIX only)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PathAttributesImplementation

        +
        public PathAttributesImplementation()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPath

        +
        public Path getPath()
        +
        Get the path these attributes belong to.
        +
        +
        Specified by:
        +
        getPath in interface PathAttributes
        +
        Returns:
        +
        the path these attributes belong to.
        +
        +
        • +
      + + + +
        +
      • +

        setPath

        +
        public void setPath(Path path)
        +
        • +
      + + + +
        +
      • +

        isDirectory

        +
        public boolean isDirectory()
        +
        Does the path refer to a directory ?
        +
        +
        Specified by:
        +
        isDirectory in interface PathAttributes
        +
        Returns:
        +
        if the path refers to a directory.
        +
        +
        • +
      + + + +
        +
      • +

        setDirectory

        +
        public void setDirectory(boolean isDirectory)
        +
        • +
      + + + +
        +
      • +

        isRegular

        +
        public boolean isRegular()
        +
        Does the path refer to a regular file ?
        +
        +
        Specified by:
        +
        isRegular in interface PathAttributes
        +
        Returns:
        +
        if the path refers to a regular file.
        +
        +
        • +
      + + + +
        +
      • +

        setRegular

        +
        public void setRegular(boolean isRegular)
        +
        • +
      + + + +
        +
      • +

        isSymbolicLink

        +
        public boolean isSymbolicLink()
        +
        Does the path refer to a symbolic link ?
        +
        +
        Specified by:
        +
        isSymbolicLink in interface PathAttributes
        +
        Returns:
        +
        if the path refers to a symbolic link.
        +
        +
        • +
      + + + +
        +
      • +

        setSymbolicLink

        +
        public void setSymbolicLink(boolean isSymbolicLink)
        +
        • +
      + + + +
        +
      • +

        isOther

        +
        public boolean isOther()
        +
        Is the path not a file, link or directory ?
        +
        +
        Specified by:
        +
        isOther in interface PathAttributes
        +
        Returns:
        +
        if the path does not refer to a file, link or directory.
        +
        +
        • +
      + + + +
        +
      • +

        setOther

        +
        public void setOther(boolean isOther)
        +
        • +
      + + + +
        +
      • +

        isExecutable

        +
        public boolean isExecutable()
        +
        Does the path refer to an executable file ?
        +
        +
        Specified by:
        +
        isExecutable in interface PathAttributes
        +
        Returns:
        +
        if the path refers an executable file ?
        +
        +
        • +
      + + + +
        +
      • +

        setExecutable

        +
        public void setExecutable(boolean executable)
        +
        • +
      + + + +
        +
      • +

        isReadable

        +
        public boolean isReadable()
        +
        Does the path refer to an readable file ?
        +
        +
        Specified by:
        +
        isReadable in interface PathAttributes
        +
        Returns:
        +
        if the path refers an readable file ?
        +
        +
        • +
      + + + +
        +
      • +

        setReadable

        +
        public void setReadable(boolean readable)
        +
        • +
      + + + +
        +
      • +

        isWritable

        +
        public boolean isWritable()
        +
        Does the path refer to a writable file ?
        +
        +
        Specified by:
        +
        isWritable in interface PathAttributes
        +
        Returns:
        +
        if the path refers a writable file ?
        +
        +
        • +
      + + + +
        +
      • +

        setWritable

        +
        public void setWritable(boolean writable)
        +
        • +
      + + + +
        +
      • +

        isHidden

        +
        public boolean isHidden()
        +
        Does the path refer to an hidden file ?
        +
        +
        Specified by:
        +
        isHidden in interface PathAttributes
        +
        Returns:
        +
        if the path refers an hidden file ?
        +
        +
        • +
      + + + +
        +
      • +

        setHidden

        +
        public void setHidden(boolean hidden)
        +
        • +
      + + + +
        +
      • +

        getCreationTime

        +
        public long getCreationTime()
        +
        Get the creation time for this file. + + If creationTime is not supported by the adaptor, getLastModifiedTime() will be returned instead.
        +
        +
        Specified by:
        +
        getCreationTime in interface PathAttributes
        +
        Returns:
        +
        the creation time for this file.
        +
        +
        • +
      + + + +
        +
      • +

        setCreationTime

        +
        public void setCreationTime(long creationTime)
        +
        • +
      + + + +
        +
      • +

        getLastAccessTime

        +
        public long getLastAccessTime()
        +
        Get the last access time for this file. + + If lastAccessTime is not supported by the adaptor, use getLastModifiedTime() will be returned instead.
        +
        +
        Specified by:
        +
        getLastAccessTime in interface PathAttributes
        +
        Returns:
        +
        the last access time for this file.
        +
        +
        • +
      + + + +
        +
      • +

        setLastAccessTime

        +
        public void setLastAccessTime(long lastAccessTime)
        +
        • +
      + + + +
        +
      • +

        getLastModifiedTime

        +
        public long getLastModifiedTime()
        +
        Get the last modified time for this file. + + If lastModifiedTime is not supported by the adaptor, 0 will be returned instead.
        +
        +
        Specified by:
        +
        getLastModifiedTime in interface PathAttributes
        +
        Returns:
        +
        the last modified time for this file.
        +
        +
        • +
      + + + +
        +
      • +

        setLastModifiedTime

        +
        public void setLastModifiedTime(long lastModifiedTime)
        +
        • +
      + + + +
        +
      • +

        getSize

        +
        public long getSize()
        +
        Get the size of this file in bytes. + + If the file is not a regular file, 0 will be returned.
        +
        +
        Specified by:
        +
        getSize in interface PathAttributes
        +
        Returns:
        +
        the size of this file.
        +
        +
        • +
      + + + +
        +
      • +

        setSize

        +
        public void setSize(long size)
        +
        • +
      + + + + + + + +
        +
      • +

        setOwner

        +
        public void setOwner(java.lang.String owner)
        +
        • +
      + + + + + + + +
        +
      • +

        setGroup

        +
        public void setGroup(java.lang.String group)
        +
        • +
      + + + + + + + +
        +
      • +

        setPermissions

        +
        public void setPermissions(java.util.Set<PosixFilePermission> permissions)
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PermissionDeniedException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PermissionDeniedException.html new file mode 100644 index 000000000..cbce392b9 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PermissionDeniedException.html @@ -0,0 +1,332 @@ + + + + + +PermissionDeniedException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems
+

Class PermissionDeniedException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class PermissionDeniedException
+extends XenonException
    +
    Signals that the user does not have sufficient permissions to perform the operation.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PermissionDeniedException(java.lang.String adaptorName, + java.lang.String message) 
      PermissionDeniedException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PermissionDeniedException

        +
        public PermissionDeniedException(java.lang.String adaptorName,
+                                 java.lang.String message,
+                                 java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        PermissionDeniedException

        +
        public PermissionDeniedException(java.lang.String adaptorName,
+                                 java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PosixFileUtils.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PosixFileUtils.html new file mode 100644 index 000000000..2020a6276 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PosixFileUtils.html @@ -0,0 +1,530 @@ + + + + + +PosixFileUtils (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems
+

Class PosixFileUtils

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class PosixFileUtils
+extends java.lang.Object
    +
    PosixFileUtils contains several utility functions related to Posix files.
    +
    +
    Since:
    +
    1.0
    +
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PosixFileUtils

        +
        private PosixFileUtils()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        bitsToPermissions

        +
        public static java.util.Set<PosixFilePermission> bitsToPermissions(int bit)
        +
        • +
      + + + +
        +
      • +

        permissionsToBits

        +
        public static int permissionsToBits(java.util.Set<PosixFilePermission> permissions)
        +
        • +
      + + + +
        +
      • +

        isExecutable

        +
        public static boolean isExecutable(int permissions)
        +
        • +
      + + + +
        +
      • +

        isReadable

        +
        public static boolean isReadable(int permissions)
        +
        • +
      + + + +
        +
      • +

        isWritable

        +
        public static boolean isWritable(int permissions)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/RecursiveListIterator.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/RecursiveListIterator.html new file mode 100644 index 000000000..9248b642e --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/RecursiveListIterator.html @@ -0,0 +1,365 @@ + + + + + +RecursiveListIterator (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems
+

Class RecursiveListIterator

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.filesystems.RecursiveListIterator
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Iterator<PathAttributes>
    +
    +
    +
    +
    public class RecursiveListIterator
+extends java.lang.Object
+implements java.util.Iterator<PathAttributes>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      (package private) java.util.function.Function<Path,java.util.Iterator<PathAttributes>>list 
      (package private) java.util.Stack<java.util.Iterator<PathAttributes>>stack 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanhasNext() 
      PathAttributesnext() 
      (package private) voidpopEmpties() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.util.Iterator

        +forEachRemaining, remove
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RecursiveListIterator

        +
        public RecursiveListIterator(java.util.function.Function<Path,java.util.Iterator<PathAttributes>> list,
+                             Path path)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        popEmpties

        +
        void popEmpties()
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
        +
        +
        Specified by:
        +
        hasNext in interface java.util.Iterator<PathAttributes>
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpFileAdaptor.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpFileAdaptor.html new file mode 100644 index 000000000..ec47c972d --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpFileAdaptor.html @@ -0,0 +1,668 @@ + + + + + +FtpFileAdaptor (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems.ftp
+

Class FtpFileAdaptor

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      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

        +
        protected static final int DEFAULT_PORT
        +
        The default SSH port
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ADAPTOR_DESCRIPTION

        +
        private 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
        +
        +
        • +
      + + + +
        +
      • +

        BUFFER_SIZE

        +
        public static final java.lang.String BUFFER_SIZE
        +
        The buffer size to use when copying data.
        +
        +
        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 FTP adaptor
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FtpFileAdaptor

        +
        public FtpFileAdaptor()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpFileSystem.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpFileSystem.html new file mode 100644 index 000000000..d0f38652a --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpFileSystem.html @@ -0,0 +1,1068 @@ + + + + + +FtpFileSystem (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems.ftp
+

Class FtpFileSystem

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.AutoCloseable
    +
    +
    +
    +
    public class FtpFileSystem
+extends FileSystem
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        PERMISSION_TYPES

        +
        private static final int[] PERMISSION_TYPES
        +
        • +
      + + + +
        +
      • +

        USER_TYPES

        +
        private static final int[] USER_TYPES
        +
        • +
      + + + +
        +
      • +

        ftpClient

        +
        private final org.apache.commons.net.ftp.FTPClient ftpClient
        +
        • +
      + + + +
        +
      • +

        credential

        +
        private final Credential credential
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FtpFileSystem

        +
        protected FtpFileSystem(java.lang.String uniqueID,
+                        java.lang.String name,
+                        java.lang.String location,
+                        Path entryPath,
+                        int bufferSize,
+                        org.apache.commons.net.ftp.FTPClient ftpClient,
+                        Credential credential,
+                        FtpFileAdaptor adaptor,
+                        XenonProperties properties)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws XenonException
        +
        Description copied from class: FileSystem
        +
        Close this FileSystem. If the adaptor does not support closing this is a no-op.
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Overrides:
        +
        close in class FileSystem
        +
        Throws:
        +
        XenonException - If the FileSystem failed to close or if an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        isOpen

        +
        public boolean isOpen()
+               throws XenonException
        +
        Description copied from class: FileSystem
        +
        Return if the connection to the FileSystem is open. An adaptor which does not support closing is always open.
        +
        +
        Specified by:
        +
        isOpen in class FileSystem
        +
        Returns:
        +
        if the connection to the FileSystem is open.
        +
        Throws:
        +
        XenonException - if the test failed or an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        getPermissions

        +
        private java.util.HashSet<PosixFilePermission> getPermissions(org.apache.commons.net.ftp.FTPFile attributes)
        +
        • +
      + + + +
        +
      • +

        getPosixFilePermission

        +
        private PosixFilePermission getPosixFilePermission(int userType,
+                                                   int permissionType)
        +
        • +
      + + + +
        +
      • +

        convertAttributes

        +
        private PathAttributes convertAttributes(Path path,
+                                         org.apache.commons.net.ftp.FTPFile attributes)
        +
        • +
      + + + +
        +
      • +

        checkClientReply

        +
        private void checkClientReply(org.apache.commons.net.ftp.FTPClient client,
+                              java.lang.String message)
+                       throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + + + + + +
        +
      • +

        rename

        +
        public void rename(Path source,
+                   Path target)
+            throws XenonException
        +
        Description copied from class: FileSystem
        +
        Rename an existing source path to a non-existing target path (optional operation). +

        + + This method only implements a rename operation, not a move operation. Hence, this method will not copy files and should return (almost) + instantaneously. + + The parent of the target path (e.g. target.getParent) must exist. + + If the target is equal to the source this method has no effect. + + If the source is a link, the link itself will be renamed, not the path to which it refers. + + If the source is a directory, it will be renamed to the target. This implies that a moving a directory between physical locations may fail. +

        +
        +
        Specified by:
        +
        rename in class FileSystem
        +
        Parameters:
        +
        source - the existing source path.
        +
        target - the non existing target path.
        +
        Throws:
        +
        UnsupportedOperationException - If the adapter does not support renaming.
        +
        NoSuchPathException - If the source file does not exist or the target parent directory does not exist.
        +
        PathAlreadyExistsException - If the target file already exists.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - If the move failed.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        createSymbolicLink

        +
        public void createSymbolicLink(Path link,
+                               Path path)
+                        throws XenonException
        +
        Description copied from class: FileSystem
        +
        Creates a new symbolic link, failing if the link already exists (optional operation). + + The target is taken as is. It may be absolute, relative path and/or non-normalized path and may or may not exist.
        +
        +
        Specified by:
        +
        createSymbolicLink in class FileSystem
        +
        Parameters:
        +
        link - the symbolic link to create.
        +
        path - the target the symbolic link should refer to.
        +
        Throws:
        +
        PathAlreadyExistsException - If the link already exists.
        +
        NoSuchPathException - If the target or parent directory of link does not exist
        +
        InvalidPathException - If parent of link is not a directory
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - If an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        deleteDirectory

        +
        protected void deleteDirectory(Path path)
+                        throws XenonException
        +
        Description copied from class: FileSystem
        +
        Delete an empty directory. Is only called on empty directories + + This operation can only delete empty directories (analogous to rmdir in Linux). + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        deleteDirectory in class FileSystem
        +
        Parameters:
        +
        path - the directory to remove
        +
        Throws:
        +
        InvalidPathException - if the provided path is not a directory.
        +
        NoSuchPathException - if the provided path does not exist.
        +
        XenonException - If the directory could not be removed.
        +
        +
        • +
      + + + +
        +
      • +

        deleteFile

        +
        protected void deleteFile(Path path)
+                   throws XenonException
        +
        Description copied from class: FileSystem
        +
        Delete a file. Is only called on existing files + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        deleteFile in class FileSystem
        +
        Parameters:
        +
        path - the file to remove
        +
        Throws:
        +
        InvalidPathException - if the provided path is not a file.
        +
        NoSuchPathException - if the provided file does not exist.
        +
        XenonException - If the file could not be removed.
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + +
        +
      • +

        listDirectory

        +
        protected java.util.List<PathAttributes> listDirectory(Path path)
+                                                throws XenonException
        +
        Description copied from class: FileSystem
        +
        Return the list of entries in a directory. + + This operation is non-recursive; any subdirectories in dir will be returned as part of the list, but they will not be listed themselves. + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        listDirectory in class FileSystem
        +
        Parameters:
        +
        path - the directory to list
        +
        Returns:
        +
        a Iterable that iterates over all entries in dir
        +
        Throws:
        +
        XenonException - If the list could not be retrieved.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        writeToFile

        +
        public java.io.OutputStream writeToFile(Path path,
+                                        long size)
+                                 throws XenonException
        +
        Description copied from class: FileSystem
        +
        Open a file and return an OutputStream to write to this file. +

        + + The size of the file (once all data has been written) must be specified using the size parameter. This is required by some implementations + (typically blob-stores). + +

        +
        +
        Specified by:
        +
        writeToFile in class FileSystem
        +
        Parameters:
        +
        path - the target file for the OutputStream.
        +
        size - the size of the file once fully written.
        +
        Returns:
        +
        the OutputStream to write to the file.
        +
        Throws:
        +
        PathAlreadyExistsException - If the target existed.
        +
        NoSuchPathException - if a parent directory does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        writeToFile

        +
        public java.io.OutputStream writeToFile(Path path)
+                                 throws XenonException
        +
        Description copied from class: FileSystem
        +
        Open a file and return an OutputStream to write to this file. (optional operation) +

        + If the file already exists it will be replaced and its data will be lost. + + The amount of data that will be written to the file is not specified in advance. This operation may not be supported by all implementations. + +

        +
        +
        Specified by:
        +
        writeToFile in class FileSystem
        +
        Parameters:
        +
        path - the target file for the OutputStream.
        +
        Returns:
        +
        the OutputStream to write to the file.
        +
        Throws:
        +
        PathAlreadyExistsException - If the target existed.
        +
        NoSuchPathException - if a parent directory does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        +
        • +
      + + + + + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpInputStream.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpInputStream.html new file mode 100644 index 000000000..39f40e68a --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpInputStream.html @@ -0,0 +1,529 @@ + + + + + +FtpInputStream (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems.ftp
+

Class FtpInputStream

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.io.InputStream
      • +
    • +
        +
      • nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpInputStream
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.lang.AutoCloseable
    +
    +
    +
    +
    public class FtpInputStream
+extends java.io.InputStream
    +
    Wraps an InputStream instance. Only functionality added is sending a pending command completed signal after closing the input + stream.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FtpInputStream(java.io.InputStream inputStream, + org.apache.commons.net.ftp.FTPClient ftpClient) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intavailable() 
      voidclose() 
      voidmark(int readlimit) 
      booleanmarkSupported() 
      intread() 
      intread(byte[] b) 
      intread(byte[] b, + int off, + int len) 
      voidreset() 
      longskip(long n) 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        inputStream

        +
        private final java.io.InputStream inputStream
        +
        • +
      + + + +
        +
      • +

        ftpClient

        +
        private final org.apache.commons.net.ftp.FTPClient ftpClient
        +
        • +
      + + + +
        +
      • +

        completedPendingFtpCommand

        +
        private boolean completedPendingFtpCommand
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FtpInputStream

        +
        public FtpInputStream(java.io.InputStream inputStream,
+                      org.apache.commons.net.ftp.FTPClient ftpClient)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        read

        +
        public int read()
+         throws java.io.IOException
        +
        +
        Specified by:
        +
        read in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws java.io.IOException
        +
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Overrides:
        +
        close in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        available

        +
        public int available()
+              throws java.io.IOException
        +
        +
        Overrides:
        +
        available in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        mark

        +
        public void mark(int readlimit)
        +
        +
        Overrides:
        +
        mark in class java.io.InputStream
        +
        +
        • +
      + + + +
        +
      • +

        markSupported

        +
        public boolean markSupported()
        +
        +
        Overrides:
        +
        markSupported in class java.io.InputStream
        +
        +
        • +
      + + + +
        +
      • +

        read

        +
        public int read(byte[] b)
+         throws java.io.IOException
        +
        +
        Overrides:
        +
        read in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        read

        +
        public int read(byte[] b,
+                int off,
+                int len)
+         throws java.io.IOException
        +
        +
        Overrides:
        +
        read in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        reset

        +
        public void reset()
+           throws java.io.IOException
        +
        +
        Overrides:
        +
        reset in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        skip

        +
        public long skip(long n)
+          throws java.io.IOException
        +
        +
        Overrides:
        +
        skip in class java.io.InputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpOutputStream.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpOutputStream.html new file mode 100644 index 000000000..59411ec6e --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpOutputStream.html @@ -0,0 +1,457 @@ + + + + + +FtpOutputStream (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems.ftp
+

Class FtpOutputStream

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.io.OutputStream
      • +
    • +
        +
      • nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpOutputStream
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
    +
    +
    +
    +
    public class FtpOutputStream
+extends java.io.OutputStream
    +
    Wraps an OutputStream instance. Only functionality added is sending a pending command completed signal after closing the output + stream.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      FtpOutputStream(java.io.OutputStream outputStream, + org.apache.commons.net.ftp.FTPClient ftpClient) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidclose() 
      voidflush() 
      java.lang.StringtoString() 
      voidwrite(byte[] b) 
      voidwrite(byte[] b, + int off, + int len) 
      voidwrite(int b) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        outputStream

        +
        private final java.io.OutputStream outputStream
        +
        • +
      + + + +
        +
      • +

        ftpClient

        +
        private final org.apache.commons.net.ftp.FTPClient ftpClient
        +
        • +
      + + + +
        +
      • +

        completedPendingFtpCommand

        +
        private boolean completedPendingFtpCommand
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FtpOutputStream

        +
        public FtpOutputStream(java.io.OutputStream outputStream,
+                       org.apache.commons.net.ftp.FTPClient ftpClient)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        write

        +
        public void write(int b)
+           throws java.io.IOException
        +
        +
        Specified by:
        +
        write in class java.io.OutputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        write

        +
        public void write(byte[] b)
+           throws java.io.IOException
        +
        +
        Overrides:
        +
        write in class java.io.OutputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        write

        +
        public void write(byte[] b,
+                  int off,
+                  int len)
+           throws java.io.IOException
        +
        +
        Overrides:
        +
        write in class java.io.OutputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws java.io.IOException
        +
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Overrides:
        +
        close in class java.io.OutputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        flush

        +
        public void flush()
+           throws java.io.IOException
        +
        +
        Specified by:
        +
        flush in interface java.io.Flushable
        +
        Overrides:
        +
        flush in class java.io.OutputStream
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/package-frame.html new file mode 100644 index 000000000..5907bde73 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/package-frame.html @@ -0,0 +1,22 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.ftp (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.adaptors.filesystems.ftp

+
+

Classes

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/package-summary.html new file mode 100644 index 000000000..0e638a3cd --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/package-summary.html @@ -0,0 +1,155 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.ftp (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.adaptors.filesystems.ftp

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/package-tree.html new file mode 100644 index 000000000..ff3fcfcad --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/package-tree.html @@ -0,0 +1,157 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.ftp Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.filesystems.ftp

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • nl.esciencecenter.xenon.adaptors.Adaptor (implements nl.esciencecenter.xenon.AdaptorDescription) + +
      • +
    • nl.esciencecenter.xenon.filesystems.FileSystem (implements java.lang.AutoCloseable) +
        +
      • nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
        • +
      +
      • +
    • java.io.InputStream (implements java.io.Closeable) + +
      • +
    • java.io.OutputStream (implements java.io.Closeable, java.io.Flushable) + +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/hdfs/HDFSFileAdaptor.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/hdfs/HDFSFileAdaptor.html new file mode 100644 index 000000000..bfc965f82 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/hdfs/HDFSFileAdaptor.html @@ -0,0 +1,566 @@ + + + + + +HDFSFileAdaptor (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems.hdfs
+

Class HDFSFileAdaptor

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        ADAPTOR_NAME

        +
        public static final java.lang.String ADAPTOR_NAME
        +
        The name of this adaptor
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        DEFAULT_PORT

        +
        protected static final int DEFAULT_PORT
        +
        The default SSH port
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ADAPTOR_DESCRIPTION

        +
        private static final java.lang.String ADAPTOR_DESCRIPTION
        +
        A description of this adaptor
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ADAPTOR_LOCATIONS

        +
        private static final java.lang.String[] ADAPTOR_LOCATIONS
        +
        The locations supported by this adaptor
        +
        • +
      + + + +
        +
      • +

        PREFIX

        +
        public static final java.lang.String PREFIX
        +
        All our own properties start with this prefix.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        HADOOP_SETTINGS_FILE

        +
        public static final java.lang.String HADOOP_SETTINGS_FILE
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BUFFER_SIZE

        +
        public static final java.lang.String BUFFER_SIZE
        +
        The buffer size to use when copying data.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HDFSFileAdaptor

        +
        public HDFSFileAdaptor()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/hdfs/HDFSFileSystem.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/hdfs/HDFSFileSystem.html new file mode 100644 index 000000000..23ce113e7 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/hdfs/HDFSFileSystem.html @@ -0,0 +1,1068 @@ + + + + + +HDFSFileSystem (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems.hdfs
+

Class HDFSFileSystem

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.AutoCloseable
    +
    +
    +
    +
    public class HDFSFileSystem
+extends FileSystem
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        fs

        +
        final org.apache.hadoop.fs.FileSystem fs
        +
        • +
      + + + +
        +
      • +

        closed

        +
        boolean closed
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HDFSFileSystem

        +
        protected HDFSFileSystem(java.lang.String uniqueID,
+                         java.lang.String endPoint,
+                         Credential credential,
+                         org.apache.hadoop.fs.FileSystem fs,
+                         int bufferSize,
+                         XenonProperties properties)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        close

        +
        public void close()
+           throws XenonException
        +
        Description copied from class: FileSystem
        +
        Close this FileSystem. If the adaptor does not support closing this is a no-op.
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Overrides:
        +
        close in class FileSystem
        +
        Throws:
        +
        XenonException - If the FileSystem failed to close or if an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        isOpen

        +
        public boolean isOpen()
+               throws XenonException
        +
        Description copied from class: FileSystem
        +
        Return if the connection to the FileSystem is open. An adaptor which does not support closing is always open.
        +
        +
        Specified by:
        +
        isOpen in class FileSystem
        +
        Returns:
        +
        if the connection to the FileSystem is open.
        +
        Throws:
        +
        XenonException - if the test failed or an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        rename

        +
        public void rename(Path source,
+                   Path target)
+            throws XenonException
        +
        Description copied from class: FileSystem
        +
        Rename an existing source path to a non-existing target path (optional operation). +

        + + This method only implements a rename operation, not a move operation. Hence, this method will not copy files and should return (almost) + instantaneously. + + The parent of the target path (e.g. target.getParent) must exist. + + If the target is equal to the source this method has no effect. + + If the source is a link, the link itself will be renamed, not the path to which it refers. + + If the source is a directory, it will be renamed to the target. This implies that a moving a directory between physical locations may fail. +

        +
        +
        Specified by:
        +
        rename in class FileSystem
        +
        Parameters:
        +
        source - the existing source path.
        +
        target - the non existing target path.
        +
        Throws:
        +
        UnsupportedOperationException - If the adapter does not support renaming.
        +
        NoSuchPathException - If the source file does not exist or the target parent directory does not exist.
        +
        PathAlreadyExistsException - If the target file already exists.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - If the move failed.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        createSymbolicLink

        +
        public void createSymbolicLink(Path link,
+                               Path target)
+                        throws XenonException
        +
        Description copied from class: FileSystem
        +
        Creates a new symbolic link, failing if the link already exists (optional operation). + + The target is taken as is. It may be absolute, relative path and/or non-normalized path and may or may not exist.
        +
        +
        Specified by:
        +
        createSymbolicLink in class FileSystem
        +
        Parameters:
        +
        link - the symbolic link to create.
        +
        target - the target the symbolic link should refer to.
        +
        Throws:
        +
        PathAlreadyExistsException - If the link already exists.
        +
        NoSuchPathException - If the target or parent directory of link does not exist
        +
        InvalidPathException - If parent of link is not a directory
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - If an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        delete

        +
        public void delete(Path path,
+                   boolean recursive)
+            throws XenonException
        +
        Description copied from class: FileSystem
        +
        Deletes an existing path. + + If path is a symbolic link the symbolic link is removed and the symbolic link's target is not deleted. + + If the path is a directory and recursive is set to true, the contents of the directory will also be deleted. If recursive is + set to false, a directory will only be removed if it is empty.
        +
        +
        Overrides:
        +
        delete in class FileSystem
        +
        Parameters:
        +
        path - the path to delete.
        +
        recursive - if the delete must be done recursively
        +
        Throws:
        +
        DirectoryNotEmptyException - if the directory was not empty (and the delete was not recursive).
        +
        NoSuchPathException - if the provided path does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        list

        +
        public java.lang.Iterable<PathAttributes> list(Path dir,
+                                               boolean recursive)
+                                        throws XenonException
        +
        Description copied from class: FileSystem
        +
        List all entries in the directory dir. + + All entries in the directory are returned, but subdirectories will not be traversed by default. Set recursive to true, include + the listing of all subdirectories. + + Symbolic links are not followed.
        +
        +
        Overrides:
        +
        list in class FileSystem
        +
        Parameters:
        +
        dir - the target directory.
        +
        recursive - should the list recursively traverse the subdirectories ?
        +
        Returns:
        +
        a List of PathAttributes that iterates over all entries in the directory dir.
        +
        Throws:
        +
        NoSuchPathException - If a directory does not exists.
        +
        InvalidPathException - If dir is not a directory.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        listIteratorNoException

        +
        private java.util.Iterator<PathAttributes> listIteratorNoException(Path dir)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        writeToFile

        +
        public java.io.OutputStream writeToFile(Path path,
+                                        long size)
+                                 throws XenonException
        +
        Description copied from class: FileSystem
        +
        Open a file and return an OutputStream to write to this file. +

        + + The size of the file (once all data has been written) must be specified using the size parameter. This is required by some implementations + (typically blob-stores). + +

        +
        +
        Specified by:
        +
        writeToFile in class FileSystem
        +
        Parameters:
        +
        path - the target file for the OutputStream.
        +
        size - the size of the file once fully written.
        +
        Returns:
        +
        the OutputStream to write to the file.
        +
        Throws:
        +
        PathAlreadyExistsException - If the target existed.
        +
        NoSuchPathException - if a parent directory does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        writeToFile

        +
        public java.io.OutputStream writeToFile(Path path)
+                                 throws XenonException
        +
        Description copied from class: FileSystem
        +
        Open a file and return an OutputStream to write to this file. (optional operation) +

        + If the file already exists it will be replaced and its data will be lost. + + The amount of data that will be written to the file is not specified in advance. This operation may not be supported by all implementations. + +

        +
        +
        Specified by:
        +
        writeToFile in class FileSystem
        +
        Parameters:
        +
        path - the target file for the OutputStream.
        +
        Returns:
        +
        the OutputStream to write to the file.
        +
        Throws:
        +
        PathAlreadyExistsException - If the target existed.
        +
        NoSuchPathException - if a parent directory does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        deleteFile

        +
        protected void deleteFile(Path file)
+                   throws XenonException
        +
        Description copied from class: FileSystem
        +
        Delete a file. Is only called on existing files + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        deleteFile in class FileSystem
        +
        Parameters:
        +
        file - the file to remove
        +
        Throws:
        +
        InvalidPathException - if the provided path is not a file.
        +
        NoSuchPathException - if the provided file does not exist.
        +
        XenonException - If the file could not be removed.
        +
        +
        • +
      + + + +
        +
      • +

        deleteDirectory

        +
        protected void deleteDirectory(Path path)
+                        throws XenonException
        +
        Description copied from class: FileSystem
        +
        Delete an empty directory. Is only called on empty directories + + This operation can only delete empty directories (analogous to rmdir in Linux). + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        deleteDirectory in class FileSystem
        +
        Parameters:
        +
        path - the directory to remove
        +
        Throws:
        +
        InvalidPathException - if the provided path is not a directory.
        +
        NoSuchPathException - if the provided path does not exist.
        +
        XenonException - If the directory could not be removed.
        +
        +
        • +
      + + + +
        +
      • +

        listDirectory

        +
        protected java.lang.Iterable<PathAttributes> listDirectory(Path dir)
+                                                    throws XenonException
        +
        Description copied from class: FileSystem
        +
        Return the list of entries in a directory. + + This operation is non-recursive; any subdirectories in dir will be returned as part of the list, but they will not be listed themselves. + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        listDirectory in class FileSystem
        +
        Parameters:
        +
        dir - the directory to list
        +
        Returns:
        +
        a Iterable that iterates over all entries in dir
        +
        Throws:
        +
        XenonException - If the list could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        toHDFSPath

        +
        org.apache.hadoop.fs.Path toHDFSPath(Path p)
        +
        • +
      + + + +
        +
      • +

        fromHDFSPath

        +
        static Path fromHDFSPath(org.apache.hadoop.fs.Path p)
        +
        • +
      + + + +
        +
      • +

        toPathAttributes

        +
        private PathAttributes toPathAttributes(org.apache.hadoop.fs.FileStatus s)
        +
        • +
      + + + +
        +
      • +

        toPermissionSet

        +
        private java.util.Set<PosixFilePermission> toPermissionSet(org.apache.hadoop.fs.permission.FsPermission permission)
        +
        • +
      + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/hdfs/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/hdfs/package-frame.html new file mode 100644 index 000000000..c7adf1584 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/hdfs/package-frame.html @@ -0,0 +1,20 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.hdfs (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.adaptors.filesystems.hdfs

+
+

Classes

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/hdfs/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/hdfs/package-summary.html new file mode 100644 index 000000000..3862057ad --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/hdfs/package-summary.html @@ -0,0 +1,145 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.hdfs (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.adaptors.filesystems.hdfs

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/hdfs/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/hdfs/package-tree.html new file mode 100644 index 000000000..3000c0e1c --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/hdfs/package-tree.html @@ -0,0 +1,147 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.hdfs Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.filesystems.hdfs

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/JCloudsFileSytem.ListingIterator.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/JCloudsFileSytem.ListingIterator.html new file mode 100644 index 000000000..67dcd2f4e --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/JCloudsFileSytem.ListingIterator.html @@ -0,0 +1,398 @@ + + + + + +JCloudsFileSytem.ListingIterator (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems.jclouds
+

Class JCloudsFileSytem.ListingIterator

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem.ListingIterator
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Iterator<PathAttributes>
    +
    +
    +
    Enclosing class:
    +
    JCloudsFileSytem
    +
    +
    +
    +
    class JCloudsFileSytem.ListingIterator
+extends java.lang.Object
+implements java.util.Iterator<PathAttributes>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      (package private) java.util.Iterator<? extends org.jclouds.blobstore.domain.StorageMetadata>curIterator 
      (package private) org.jclouds.blobstore.domain.PageSet<? extends org.jclouds.blobstore.domain.StorageMetadata>curPageSet 
      (package private) org.jclouds.blobstore.domain.StorageMetadatanxt 
      private org.jclouds.blobstore.options.ListContainerOptionsoptions 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ListingIterator(org.jclouds.blobstore.options.ListContainerOptions options, + org.jclouds.blobstore.domain.PageSet<? extends org.jclouds.blobstore.domain.StorageMetadata> pageSet) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      (package private) voidgetNext() 
      booleanhasNext() 
      PathAttributesnext() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.util.Iterator

        +forEachRemaining, remove
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        options

        +
        private final org.jclouds.blobstore.options.ListContainerOptions options
        +
        • +
      + + + +
        +
      • +

        curIterator

        +
        java.util.Iterator<? extends org.jclouds.blobstore.domain.StorageMetadata> curIterator
        +
        • +
      + + + +
        +
      • +

        curPageSet

        +
        org.jclouds.blobstore.domain.PageSet<? extends org.jclouds.blobstore.domain.StorageMetadata> curPageSet
        +
        • +
      + + + +
        +
      • +

        nxt

        +
        org.jclouds.blobstore.domain.StorageMetadata nxt
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ListingIterator

        +
        ListingIterator(org.jclouds.blobstore.options.ListContainerOptions options,
+                org.jclouds.blobstore.domain.PageSet<? extends org.jclouds.blobstore.domain.StorageMetadata> pageSet)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getNext

        +
        void getNext()
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
        +
        +
        Specified by:
        +
        hasNext in interface java.util.Iterator<PathAttributes>
        +
        +
        • +
      + + + +
        +
      • +

        next

        +
        public PathAttributes next()
+                    throws java.util.NoSuchElementException
        +
        +
        Specified by:
        +
        next in interface java.util.Iterator<PathAttributes>
        +
        Throws:
        +
        java.util.NoSuchElementException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/JCloudsFileSytem.RecursiveListIterator.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/JCloudsFileSytem.RecursiveListIterator.html new file mode 100644 index 000000000..0156b83f6 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/JCloudsFileSytem.RecursiveListIterator.html @@ -0,0 +1,357 @@ + + + + + +JCloudsFileSytem.RecursiveListIterator (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems.jclouds
+

Class JCloudsFileSytem.RecursiveListIterator

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.filesystems.jclouds.JCloudsFileSytem.RecursiveListIterator
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Iterator<PathAttributes>
    +
    +
    +
    Enclosing class:
    +
    JCloudsFileSytem
    +
    +
    +
    +
    private class JCloudsFileSytem.RecursiveListIterator
+extends java.lang.Object
+implements java.util.Iterator<PathAttributes>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      (package private) java.util.Deque<java.util.Iterator<PathAttributes>>stack 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanhasNext() 
      PathAttributesnext() 
      (package private) voidpopEmpties() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.util.Iterator

        +forEachRemaining, remove
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        stack

        +
        final java.util.Deque<java.util.Iterator<PathAttributes>> stack
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RecursiveListIterator

        +
        public RecursiveListIterator(java.util.Iterator<PathAttributes> root)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        popEmpties

        +
        void popEmpties()
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
        +
        +
        Specified by:
        +
        hasNext in interface java.util.Iterator<PathAttributes>
        +
        +
        • +
      + + + +
        +
      • +

        next

        +
        public PathAttributes next()
+                    throws java.util.NoSuchElementException
        +
        +
        Specified by:
        +
        next in interface java.util.Iterator<PathAttributes>
        +
        Throws:
        +
        java.util.NoSuchElementException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/JCloudsFileSytem.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/JCloudsFileSytem.html new file mode 100644 index 000000000..c33445342 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/JCloudsFileSytem.html @@ -0,0 +1,1163 @@ + + + + + +JCloudsFileSytem (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems.jclouds
+

Class JCloudsFileSytem

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.AutoCloseable
    +
    +
    +
    +
    public class JCloudsFileSytem
+extends FileSystem
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        NOT_EMPTY

        +
        private static final java.lang.String NOT_EMPTY
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        bucket

        +
        final java.lang.String bucket
        +
        • +
      + + + +
        +
      • +

        context

        +
        final org.jclouds.blobstore.BlobStoreContext context
        +
        • +
      + + + +
        +
      • +

        adaptorName

        +
        final java.lang.String adaptorName
        +
        • +
      + + + +
        +
      • +

        open

        +
        boolean open
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        JCloudsFileSytem

        +
        public JCloudsFileSytem(java.lang.String uniqueID,
+                        java.lang.String adaptorName,
+                        java.lang.String endPoint,
+                        Credential credential,
+                        Path workingDir,
+                        org.jclouds.blobstore.BlobStoreContext context,
+                        java.lang.String bucket,
+                        int bufferSize,
+                        XenonProperties properties)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toBucketEntry

        +
        java.lang.String toBucketEntry(Path path)
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws XenonException
        +
        Description copied from class: FileSystem
        +
        Close this FileSystem. If the adaptor does not support closing this is a no-op.
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Overrides:
        +
        close in class FileSystem
        +
        Throws:
        +
        XenonException - If the FileSystem failed to close or if an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        isOpen

        +
        public boolean isOpen()
+               throws XenonException
        +
        Description copied from class: FileSystem
        +
        Return if the connection to the FileSystem is open. An adaptor which does not support closing is always open.
        +
        +
        Specified by:
        +
        isOpen in class FileSystem
        +
        Returns:
        +
        if the connection to the FileSystem is open.
        +
        Throws:
        +
        XenonException - if the test failed or an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        rename

        +
        public void rename(Path source,
+                   Path target)
+            throws XenonException
        +
        Description copied from class: FileSystem
        +
        Rename an existing source path to a non-existing target path (optional operation). +

        + + This method only implements a rename operation, not a move operation. Hence, this method will not copy files and should return (almost) + instantaneously. + + The parent of the target path (e.g. target.getParent) must exist. + + If the target is equal to the source this method has no effect. + + If the source is a link, the link itself will be renamed, not the path to which it refers. + + If the source is a directory, it will be renamed to the target. This implies that a moving a directory between physical locations may fail. +

        +
        +
        Specified by:
        +
        rename in class FileSystem
        +
        Parameters:
        +
        source - the existing source path.
        +
        target - the non existing target path.
        +
        Throws:
        +
        UnsupportedOperationException - If the adapter does not support renaming.
        +
        NoSuchPathException - If the source file does not exist or the target parent directory does not exist.
        +
        PathAlreadyExistsException - If the target file already exists.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - If the move failed.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        makeDirectoryPlaceholder

        +
        private void makeDirectoryPlaceholder(Path dir)
        +
        • +
      + + + +
        +
      • +

        removeDirectoryPlaceholder

        +
        private void removeDirectoryPlaceholder(Path dir)
        +
        • +
      + + + + + + + +
        +
      • +

        createSymbolicLink

        +
        public void createSymbolicLink(Path link,
+                               Path target)
+                        throws XenonException
        +
        Description copied from class: FileSystem
        +
        Creates a new symbolic link, failing if the link already exists (optional operation). + + The target is taken as is. It may be absolute, relative path and/or non-normalized path and may or may not exist.
        +
        +
        Specified by:
        +
        createSymbolicLink in class FileSystem
        +
        Parameters:
        +
        link - the symbolic link to create.
        +
        target - the target the symbolic link should refer to.
        +
        Throws:
        +
        PathAlreadyExistsException - If the link already exists.
        +
        NoSuchPathException - If the target or parent directory of link does not exist
        +
        InvalidPathException - If parent of link is not a directory
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - If an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        ensureDirectoryExists

        +
        private void ensureDirectoryExists(Path dir)
        +
        • +
      + + + +
        +
      • +

        deleteFile

        +
        public void deleteFile(Path file)
+                throws XenonException
        +
        Description copied from class: FileSystem
        +
        Delete a file. Is only called on existing files + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        deleteFile in class FileSystem
        +
        Parameters:
        +
        file - the file to remove
        +
        Throws:
        +
        InvalidPathException - if the provided path is not a file.
        +
        NoSuchPathException - if the provided file does not exist.
        +
        XenonException - If the file could not be removed.
        +
        +
        • +
      + + + +
        +
      • +

        deleteDirectory

        +
        protected void deleteDirectory(Path dir)
+                        throws XenonException
        +
        Description copied from class: FileSystem
        +
        Delete an empty directory. Is only called on empty directories + + This operation can only delete empty directories (analogous to rmdir in Linux). + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        deleteDirectory in class FileSystem
        +
        Parameters:
        +
        dir - the directory to remove
        +
        Throws:
        +
        InvalidPathException - if the provided path is not a directory.
        +
        NoSuchPathException - if the provided path does not exist.
        +
        XenonException - If the directory could not be removed.
        +
        +
        • +
      + + + +
        +
      • +

        listDirectory

        +
        protected java.lang.Iterable<PathAttributes> listDirectory(Path dir)
+                                                    throws XenonException
        +
        Description copied from class: FileSystem
        +
        Return the list of entries in a directory. + + This operation is non-recursive; any subdirectories in dir will be returned as part of the list, but they will not be listed themselves. + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        listDirectory in class FileSystem
        +
        Parameters:
        +
        dir - the directory to list
        +
        Returns:
        +
        a Iterable that iterates over all entries in dir
        +
        Throws:
        +
        XenonException - If the list could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        dirExists

        +
        private boolean dirExists(Path path)
        +
        • +
      + + + +
        +
      • +

        fileExists

        +
        private boolean fileExists(Path path)
        +
        • +
      + + + + + + + +
        +
      • +

        makeDirAttributes

        +
        PathAttributes makeDirAttributes(org.jclouds.blobstore.domain.StorageMetadata m)
        +
        • +
      + + + +
        +
      • +

        makeBlobAttributes

        +
        private PathAttributes makeBlobAttributes(java.lang.String name)
        +
        • +
      + + + +
        +
      • +

        toPathAttributes

        +
        PathAttributes toPathAttributes(org.jclouds.blobstore.domain.StorageMetadata m)
        +
        • +
      + + + +
        +
      • +

        listNonRecursiveIterator

        +
        java.util.Iterator<PathAttributes> listNonRecursiveIterator(java.lang.String bucketEntry)
        +
        • +
      + + + +
        +
      • +

        list

        +
        public java.lang.Iterable<PathAttributes> list(Path path,
+                                               boolean recursive)
+                                        throws XenonException
        +
        Description copied from class: FileSystem
        +
        List all entries in the directory dir. + + All entries in the directory are returned, but subdirectories will not be traversed by default. Set recursive to true, include + the listing of all subdirectories. + + Symbolic links are not followed.
        +
        +
        Overrides:
        +
        list in class FileSystem
        +
        Parameters:
        +
        path - the target directory.
        +
        recursive - should the list recursively traverse the subdirectories ?
        +
        Returns:
        +
        a List of PathAttributes that iterates over all entries in the directory dir.
        +
        Throws:
        +
        NoSuchPathException - If a directory does not exists.
        +
        InvalidPathException - If dir is not a directory.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        listPrefix

        +
        private java.lang.Iterable<PathAttributes> listPrefix(java.lang.String prefix,
+                                                      boolean recursive)
        +
        • +
      + + + + + + + +
        +
      • +

        writeToFile

        +
        public java.io.OutputStream writeToFile(Path path,
+                                        long size)
+                                 throws XenonException
        +
        Description copied from class: FileSystem
        +
        Open a file and return an OutputStream to write to this file. +

        + + The size of the file (once all data has been written) must be specified using the size parameter. This is required by some implementations + (typically blob-stores). + +

        +
        +
        Specified by:
        +
        writeToFile in class FileSystem
        +
        Parameters:
        +
        path - the target file for the OutputStream.
        +
        size - the size of the file once fully written.
        +
        Returns:
        +
        the OutputStream to write to the file.
        +
        Throws:
        +
        PathAlreadyExistsException - If the target existed.
        +
        NoSuchPathException - if a parent directory does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        writeToFile

        +
        public java.io.OutputStream writeToFile(Path file)
+                                 throws XenonException
        +
        Description copied from class: FileSystem
        +
        Open a file and return an OutputStream to write to this file. (optional operation) +

        + If the file already exists it will be replaced and its data will be lost. + + The amount of data that will be written to the file is not specified in advance. This operation may not be supported by all implementations. + +

        +
        +
        Specified by:
        +
        writeToFile in class FileSystem
        +
        Parameters:
        +
        file - the target file for the OutputStream.
        +
        Returns:
        +
        the OutputStream to write to the file.
        +
        Throws:
        +
        PathAlreadyExistsException - If the target existed.
        +
        NoSuchPathException - if a parent directory does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        +
        • +
      + + + + + + + + + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/package-frame.html new file mode 100644 index 000000000..ee194caae --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/package-frame.html @@ -0,0 +1,19 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.jclouds (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.adaptors.filesystems.jclouds

+
+

Classes

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/package-summary.html new file mode 100644 index 000000000..09b8d1956 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/package-summary.html @@ -0,0 +1,139 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.jclouds (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.adaptors.filesystems.jclouds

+
+
+
    +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    JCloudsFileSytem 
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/package-tree.html new file mode 100644 index 000000000..dad6b2693 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/jclouds/package-tree.html @@ -0,0 +1,140 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.jclouds Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.filesystems.jclouds

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/LocalFileAdaptor.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/LocalFileAdaptor.html new file mode 100644 index 000000000..a02728537 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/LocalFileAdaptor.html @@ -0,0 +1,570 @@ + + + + + +LocalFileAdaptor (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems.local
+

Class LocalFileAdaptor

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/LocalFileSystem.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/LocalFileSystem.html new file mode 100644 index 000000000..df92258cc --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/LocalFileSystem.html @@ -0,0 +1,949 @@ + + + + + +LocalFileSystem (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems.local
+

Class LocalFileSystem

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.AutoCloseable
    +
    +
    +
    +
    public class LocalFileSystem
+extends FileSystem
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        root

        +
        private final java.lang.String root
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LocalFileSystem

        +
        protected LocalFileSystem(java.lang.String uniqueID,
+                          java.lang.String location,
+                          Credential credential,
+                          java.lang.String root,
+                          Path entryPath,
+                          int bufferSize,
+                          XenonProperties properties)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        javaPath

        +
        java.nio.file.Path javaPath(Path path)
        +
        • +
      + + + +
        +
      • +

        xenonPermissions

        +
        java.util.Set<PosixFilePermission> xenonPermissions(java.util.Set<java.nio.file.attribute.PosixFilePermission> permissions)
        +
        • +
      + + + +
        +
      • +

        javaPermissions

        +
        java.util.Set<java.nio.file.attribute.PosixFilePermission> javaPermissions(java.util.Set<PosixFilePermission> permissions)
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        isOpen

        +
        public boolean isOpen()
+               throws XenonException
        +
        Description copied from class: FileSystem
        +
        Return if the connection to the FileSystem is open. An adaptor which does not support closing is always open.
        +
        +
        Specified by:
        +
        isOpen in class FileSystem
        +
        Returns:
        +
        if the connection to the FileSystem is open.
        +
        Throws:
        +
        XenonException - if the test failed or an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        rename

        +
        public void rename(Path source,
+                   Path target)
+            throws XenonException
        +
        Description copied from class: FileSystem
        +
        Rename an existing source path to a non-existing target path (optional operation). +

        + + This method only implements a rename operation, not a move operation. Hence, this method will not copy files and should return (almost) + instantaneously. + + The parent of the target path (e.g. target.getParent) must exist. + + If the target is equal to the source this method has no effect. + + If the source is a link, the link itself will be renamed, not the path to which it refers. + + If the source is a directory, it will be renamed to the target. This implies that a moving a directory between physical locations may fail. +

        +
        +
        Specified by:
        +
        rename in class FileSystem
        +
        Parameters:
        +
        source - the existing source path.
        +
        target - the non existing target path.
        +
        Throws:
        +
        UnsupportedOperationException - If the adapter does not support renaming.
        +
        NoSuchPathException - If the source file does not exist or the target parent directory does not exist.
        +
        PathAlreadyExistsException - If the target file already exists.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - If the move failed.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        createSymbolicLink

        +
        public void createSymbolicLink(Path link,
+                               Path path)
+                        throws XenonException
        +
        Description copied from class: FileSystem
        +
        Creates a new symbolic link, failing if the link already exists (optional operation). + + The target is taken as is. It may be absolute, relative path and/or non-normalized path and may or may not exist.
        +
        +
        Specified by:
        +
        createSymbolicLink in class FileSystem
        +
        Parameters:
        +
        link - the symbolic link to create.
        +
        path - the target the symbolic link should refer to.
        +
        Throws:
        +
        PathAlreadyExistsException - If the link already exists.
        +
        NoSuchPathException - If the target or parent directory of link does not exist
        +
        InvalidPathException - If parent of link is not a directory
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - If an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        deleteFile

        +
        protected void deleteFile(Path path)
+                   throws XenonException
        +
        Description copied from class: FileSystem
        +
        Delete a file. Is only called on existing files + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        deleteFile in class FileSystem
        +
        Parameters:
        +
        path - the file to remove
        +
        Throws:
        +
        InvalidPathException - if the provided path is not a file.
        +
        NoSuchPathException - if the provided file does not exist.
        +
        XenonException - If the file could not be removed.
        +
        +
        • +
      + + + +
        +
      • +

        deleteDirectory

        +
        protected void deleteDirectory(Path path)
+                        throws XenonException
        +
        Description copied from class: FileSystem
        +
        Delete an empty directory. Is only called on empty directories + + This operation can only delete empty directories (analogous to rmdir in Linux). + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        deleteDirectory in class FileSystem
        +
        Parameters:
        +
        path - the directory to remove
        +
        Throws:
        +
        InvalidPathException - if the provided path is not a directory.
        +
        NoSuchPathException - if the provided path does not exist.
        +
        XenonException - If the directory could not be removed.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        listDirectory

        +
        protected java.util.List<PathAttributes> listDirectory(Path dir)
+                                                throws XenonException
        +
        Description copied from class: FileSystem
        +
        Return the list of entries in a directory. + + This operation is non-recursive; any subdirectories in dir will be returned as part of the list, but they will not be listed themselves. + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        listDirectory in class FileSystem
        +
        Parameters:
        +
        dir - the directory to list
        +
        Returns:
        +
        a Iterable that iterates over all entries in dir
        +
        Throws:
        +
        XenonException - If the list could not be retrieved.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        writeToFile

        +
        public java.io.OutputStream writeToFile(Path path,
+                                        long size)
+                                 throws XenonException
        +
        Description copied from class: FileSystem
        +
        Open a file and return an OutputStream to write to this file. +

        + + The size of the file (once all data has been written) must be specified using the size parameter. This is required by some implementations + (typically blob-stores). + +

        +
        +
        Specified by:
        +
        writeToFile in class FileSystem
        +
        Parameters:
        +
        path - the target file for the OutputStream.
        +
        size - the size of the file once fully written.
        +
        Returns:
        +
        the OutputStream to write to the file.
        +
        Throws:
        +
        PathAlreadyExistsException - If the target existed.
        +
        NoSuchPathException - if a parent directory does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        writeToFile

        +
        public java.io.OutputStream writeToFile(Path path)
+                                 throws XenonException
        +
        Description copied from class: FileSystem
        +
        Open a file and return an OutputStream to write to this file. (optional operation) +

        + If the file already exists it will be replaced and its data will be lost. + + The amount of data that will be written to the file is not specified in advance. This operation may not be supported by all implementations. + +

        +
        +
        Specified by:
        +
        writeToFile in class FileSystem
        +
        Parameters:
        +
        path - the target file for the OutputStream.
        +
        Returns:
        +
        the OutputStream to write to the file.
        +
        Throws:
        +
        PathAlreadyExistsException - If the target existed.
        +
        NoSuchPathException - if a parent directory does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        +
        • +
      + + + + + + + + + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/package-frame.html new file mode 100644 index 000000000..2ff20e423 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/package-frame.html @@ -0,0 +1,20 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.local (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.adaptors.filesystems.local

+
+

Classes

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/package-summary.html new file mode 100644 index 000000000..0bd819131 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/package-summary.html @@ -0,0 +1,145 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.local (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.adaptors.filesystems.local

+
+
+
    +
  • + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    LocalFileAdaptor +
    LocalFiles implements an Xenon Files adaptor for local file operations.
    +
    LocalFileSystem 
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/package-tree.html new file mode 100644 index 000000000..2f5b9c0de --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/package-tree.html @@ -0,0 +1,147 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.local Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.filesystems.local

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/package-frame.html new file mode 100644 index 000000000..6899414a9 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/package-frame.html @@ -0,0 +1,29 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.adaptors.filesystems

+
+

Classes

+ +

Exceptions

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/package-summary.html new file mode 100644 index 000000000..a03406370 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/package-summary.html @@ -0,0 +1,190 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.adaptors.filesystems

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/package-tree.html new file mode 100644 index 000000000..cbefbfdd6 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/package-tree.html @@ -0,0 +1,157 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.filesystems

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/s3/S3FileAdaptor.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/s3/S3FileAdaptor.html new file mode 100644 index 000000000..8d5fe7ee2 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/s3/S3FileAdaptor.html @@ -0,0 +1,646 @@ + + + + + +S3FileAdaptor (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems.s3
+

Class S3FileAdaptor

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev Class
    • +
  • Next Class
    • +
+ + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/s3/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/s3/package-frame.html new file mode 100644 index 000000000..0ebcd3e72 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/s3/package-frame.html @@ -0,0 +1,19 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.s3 (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.adaptors.filesystems.s3

+
+

Classes

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/s3/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/s3/package-summary.html new file mode 100644 index 000000000..f84fed6c7 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/s3/package-summary.html @@ -0,0 +1,141 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.s3 (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.adaptors.filesystems.s3

+
+
+
    +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    S3FileAdaptor +
    Created by atze on 29-6-17.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/s3/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/s3/package-tree.html new file mode 100644 index 000000000..985f141f8 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/s3/package-tree.html @@ -0,0 +1,142 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.s3 Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.filesystems.s3

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/SftpFileAdaptor.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/SftpFileAdaptor.html new file mode 100644 index 000000000..a3f82fe8b --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/SftpFileAdaptor.html @@ -0,0 +1,777 @@ + + + + + +SftpFileAdaptor (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems.sftp
+

Class SftpFileAdaptor

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      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
        +
        +
        • +
      + + + +
        +
      • +

        CONNECTION_TIMEOUT

        +
        public static final java.lang.String CONNECTION_TIMEOUT
        +
        Property for maximum history length for finished jobs
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        BUFFER_SIZE

        +
        public static final java.lang.String BUFFER_SIZE
        +
        The buffer size to use when copying data.
        +
        +
        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

      + + + +
        +
      • +

        SftpFileAdaptor

        +
        public SftpFileAdaptor()
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/SftpFileSystem.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/SftpFileSystem.html new file mode 100644 index 000000000..def759819 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/SftpFileSystem.html @@ -0,0 +1,971 @@ + + + + + +SftpFileSystem (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems.sftp
+

Class SftpFileSystem

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.AutoCloseable
    +
    +
    +
    +
    public class SftpFileSystem
+extends FileSystem
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        client

        +
        private final org.apache.sshd.client.subsystem.sftp.SftpClient client
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SftpFileSystem

        +
        protected SftpFileSystem(java.lang.String uniqueID,
+                         java.lang.String name,
+                         java.lang.String location,
+                         Credential credential,
+                         Path entryPath,
+                         int bufferSize,
+                         SSHConnection connection,
+                         org.apache.sshd.client.subsystem.sftp.SftpClient client,
+                         XenonProperties properties)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws XenonException
        +
        Description copied from class: FileSystem
        +
        Close this FileSystem. If the adaptor does not support closing this is a no-op.
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Overrides:
        +
        close in class FileSystem
        +
        Throws:
        +
        XenonException - If the FileSystem failed to close or if an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        isOpen

        +
        public boolean isOpen()
+               throws XenonException
        +
        Description copied from class: FileSystem
        +
        Return if the connection to the FileSystem is open. An adaptor which does not support closing is always open.
        +
        +
        Specified by:
        +
        isOpen in class FileSystem
        +
        Returns:
        +
        if the connection to the FileSystem is open.
        +
        Throws:
        +
        XenonException - if the test failed or an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        rename

        +
        public void rename(Path source,
+                   Path target)
+            throws XenonException
        +
        Description copied from class: FileSystem
        +
        Rename an existing source path to a non-existing target path (optional operation). +

        + + This method only implements a rename operation, not a move operation. Hence, this method will not copy files and should return (almost) + instantaneously. + + The parent of the target path (e.g. target.getParent) must exist. + + If the target is equal to the source this method has no effect. + + If the source is a link, the link itself will be renamed, not the path to which it refers. + + If the source is a directory, it will be renamed to the target. This implies that a moving a directory between physical locations may fail. +

        +
        +
        Specified by:
        +
        rename in class FileSystem
        +
        Parameters:
        +
        source - the existing source path.
        +
        target - the non existing target path.
        +
        Throws:
        +
        UnsupportedOperationException - If the adapter does not support renaming.
        +
        NoSuchPathException - If the source file does not exist or the target parent directory does not exist.
        +
        PathAlreadyExistsException - If the target file already exists.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - If the move failed.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        createSymbolicLink

        +
        public void createSymbolicLink(Path link,
+                               Path path)
+                        throws XenonException
        +
        Description copied from class: FileSystem
        +
        Creates a new symbolic link, failing if the link already exists (optional operation). + + The target is taken as is. It may be absolute, relative path and/or non-normalized path and may or may not exist.
        +
        +
        Specified by:
        +
        createSymbolicLink in class FileSystem
        +
        Parameters:
        +
        link - the symbolic link to create.
        +
        path - the target the symbolic link should refer to.
        +
        Throws:
        +
        PathAlreadyExistsException - If the link already exists.
        +
        NoSuchPathException - If the target or parent directory of link does not exist
        +
        InvalidPathException - If parent of link is not a directory
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - If an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        deleteFile

        +
        protected void deleteFile(Path file)
+                   throws XenonException
        +
        Description copied from class: FileSystem
        +
        Delete a file. Is only called on existing files + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        deleteFile in class FileSystem
        +
        Parameters:
        +
        file - the file to remove
        +
        Throws:
        +
        InvalidPathException - if the provided path is not a file.
        +
        NoSuchPathException - if the provided file does not exist.
        +
        XenonException - If the file could not be removed.
        +
        +
        • +
      + + + +
        +
      • +

        deleteDirectory

        +
        protected void deleteDirectory(Path dir)
+                        throws XenonException
        +
        Description copied from class: FileSystem
        +
        Delete an empty directory. Is only called on empty directories + + This operation can only delete empty directories (analogous to rmdir in Linux). + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        deleteDirectory in class FileSystem
        +
        Parameters:
        +
        dir - the directory to remove
        +
        Throws:
        +
        InvalidPathException - if the provided path is not a directory.
        +
        NoSuchPathException - if the provided path does not exist.
        +
        XenonException - If the directory could not be removed.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        listDirectory

        +
        protected java.util.List<PathAttributes> listDirectory(Path path)
+                                                throws XenonException
        +
        Description copied from class: FileSystem
        +
        Return the list of entries in a directory. + + This operation is non-recursive; any subdirectories in dir will be returned as part of the list, but they will not be listed themselves. + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        listDirectory in class FileSystem
        +
        Parameters:
        +
        path - the directory to list
        +
        Returns:
        +
        a Iterable that iterates over all entries in dir
        +
        Throws:
        +
        XenonException - If the list could not be retrieved.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        writeToFile

        +
        public java.io.OutputStream writeToFile(Path path,
+                                        long size)
+                                 throws XenonException
        +
        Description copied from class: FileSystem
        +
        Open a file and return an OutputStream to write to this file. +

        + + The size of the file (once all data has been written) must be specified using the size parameter. This is required by some implementations + (typically blob-stores). + +

        +
        +
        Specified by:
        +
        writeToFile in class FileSystem
        +
        Parameters:
        +
        path - the target file for the OutputStream.
        +
        size - the size of the file once fully written.
        +
        Returns:
        +
        the OutputStream to write to the file.
        +
        Throws:
        +
        PathAlreadyExistsException - If the target existed.
        +
        NoSuchPathException - if a parent directory does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        writeToFile

        +
        public java.io.OutputStream writeToFile(Path path)
+                                 throws XenonException
        +
        Description copied from class: FileSystem
        +
        Open a file and return an OutputStream to write to this file. (optional operation) +

        + If the file already exists it will be replaced and its data will be lost. + + The amount of data that will be written to the file is not specified in advance. This operation may not be supported by all implementations. + +

        +
        +
        Specified by:
        +
        writeToFile in class FileSystem
        +
        Parameters:
        +
        path - the target file for the OutputStream.
        +
        Returns:
        +
        the OutputStream to write to the file.
        +
        Throws:
        +
        PathAlreadyExistsException - If the target existed.
        +
        NoSuchPathException - if a parent directory does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + +
        +
      • +

        convertTime

        +
        private static long convertTime(java.nio.file.attribute.FileTime time)
        +
        • +
      + + + +
        +
      • +

        convertAttributes

        +
        private static PathAttributes convertAttributes(Path path,
+                                                org.apache.sshd.client.subsystem.sftp.SftpClient.Attributes attributes)
        +
        • +
      + + + +
        +
      • +

        sftpExceptionToXenonException

        +
        static XenonException sftpExceptionToXenonException(java.io.IOException e,
+                                                    java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/package-frame.html new file mode 100644 index 000000000..b9835e2ba --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/package-frame.html @@ -0,0 +1,20 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.sftp (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.adaptors.filesystems.sftp

+
+

Classes

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/package-summary.html new file mode 100644 index 000000000..9825a5d9e --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/package-summary.html @@ -0,0 +1,143 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.sftp (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.adaptors.filesystems.sftp

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/package-tree.html new file mode 100644 index 000000000..ce43afb0b --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/package-tree.html @@ -0,0 +1,147 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.sftp Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.filesystems.sftp

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileAdaptor.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileAdaptor.html new file mode 100644 index 000000000..ac018fd94 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileAdaptor.html @@ -0,0 +1,570 @@ + + + + + +WebdavFileAdaptor (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems.webdav
+

Class WebdavFileAdaptor

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileSystem.StreamToFileWriter.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileSystem.StreamToFileWriter.html new file mode 100644 index 000000000..421e4cf7e --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileSystem.StreamToFileWriter.html @@ -0,0 +1,367 @@ + + + + + +WebdavFileSystem.StreamToFileWriter (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems.webdav
+

Class WebdavFileSystem.StreamToFileWriter

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Thread
      • +
    • +
        +
      • nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem.StreamToFileWriter
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Runnable
    +
    +
    +
    Enclosing class:
    +
    WebdavFileSystem
    +
    +
    +
    +
    class WebdavFileSystem.StreamToFileWriter
+extends java.lang.Thread
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class java.lang.Thread

        +java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.io.InputStreamin 
      private java.lang.Stringurl 
      +
        +
      • + + +

        Fields inherited from class java.lang.Thread

        +MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      StreamToFileWriter(java.lang.String url, + java.io.InputStream in) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidrun() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Thread

        +activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        url

        +
        private final java.lang.String url
        +
        • +
      + + + +
        +
      • +

        in

        +
        private final java.io.InputStream in
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StreamToFileWriter

        +
        StreamToFileWriter(java.lang.String url,
+                   java.io.InputStream in)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        run

        +
        public void run()
        +
        +
        Specified by:
        +
        run in interface java.lang.Runnable
        +
        Overrides:
        +
        run in class java.lang.Thread
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileSystem.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileSystem.html new file mode 100644 index 000000000..3dad915ff --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileSystem.html @@ -0,0 +1,944 @@ + + + + + +WebdavFileSystem (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.filesystems.webdav
+

Class WebdavFileSystem

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.AutoCloseable
    +
    +
    +
    +
    public class WebdavFileSystem
+extends FileSystem
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        client

        +
        private final com.github.sardine.Sardine client
        +
        • +
      + + + +
        +
      • +

        server

        +
        private final java.lang.String server
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        WebdavFileSystem

        +
        protected WebdavFileSystem(java.lang.String uniqueID,
+                           java.lang.String name,
+                           java.lang.String location,
+                           Credential credential,
+                           java.lang.String server,
+                           Path entryPath,
+                           int bufferSize,
+                           com.github.sardine.Sardine client,
+                           XenonProperties properties)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFilePath

        +
        private java.lang.String getFilePath(Path path)
        +
        • +
      + + + +
        +
      • +

        getDirectoryPath

        +
        private java.lang.String getDirectoryPath(Path path)
        +
        • +
      + + + +
        +
      • +

        getAttributes

        +
        private PathAttributes getAttributes(Path path,
+                                     com.github.sardine.DavResource p)
        +
        • +
      + + + +
        +
      • +

        listDirectory

        +
        protected java.util.List<PathAttributes> listDirectory(Path path)
+                                                throws XenonException
        +
        Description copied from class: FileSystem
        +
        Return the list of entries in a directory. + + This operation is non-recursive; any subdirectories in dir will be returned as part of the list, but they will not be listed themselves. + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        listDirectory in class FileSystem
        +
        Parameters:
        +
        path - the directory to list
        +
        Returns:
        +
        a Iterable that iterates over all entries in dir
        +
        Throws:
        +
        XenonException - If the list could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        isOpen

        +
        public boolean isOpen()
+               throws XenonException
        +
        Description copied from class: FileSystem
        +
        Return if the connection to the FileSystem is open. An adaptor which does not support closing is always open.
        +
        +
        Specified by:
        +
        isOpen in class FileSystem
        +
        Returns:
        +
        if the connection to the FileSystem is open.
        +
        Throws:
        +
        XenonException - if the test failed or an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        rename

        +
        public void rename(Path source,
+                   Path target)
+            throws XenonException
        +
        Description copied from class: FileSystem
        +
        Rename an existing source path to a non-existing target path (optional operation). +

        + + This method only implements a rename operation, not a move operation. Hence, this method will not copy files and should return (almost) + instantaneously. + + The parent of the target path (e.g. target.getParent) must exist. + + If the target is equal to the source this method has no effect. + + If the source is a link, the link itself will be renamed, not the path to which it refers. + + If the source is a directory, it will be renamed to the target. This implies that a moving a directory between physical locations may fail. +

        +
        +
        Specified by:
        +
        rename in class FileSystem
        +
        Parameters:
        +
        source - the existing source path.
        +
        target - the non existing target path.
        +
        Throws:
        +
        UnsupportedOperationException - If the adapter does not support renaming.
        +
        NoSuchPathException - If the source file does not exist or the target parent directory does not exist.
        +
        PathAlreadyExistsException - If the target file already exists.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - If the move failed.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        createSymbolicLink

        +
        public void createSymbolicLink(Path link,
+                               Path path)
+                        throws XenonException
        +
        Description copied from class: FileSystem
        +
        Creates a new symbolic link, failing if the link already exists (optional operation). + + The target is taken as is. It may be absolute, relative path and/or non-normalized path and may or may not exist.
        +
        +
        Specified by:
        +
        createSymbolicLink in class FileSystem
        +
        Parameters:
        +
        link - the symbolic link to create.
        +
        path - the target the symbolic link should refer to.
        +
        Throws:
        +
        PathAlreadyExistsException - If the link already exists.
        +
        NoSuchPathException - If the target or parent directory of link does not exist
        +
        InvalidPathException - If parent of link is not a directory
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - If an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        deleteFile

        +
        protected void deleteFile(Path path)
+                   throws XenonException
        +
        Description copied from class: FileSystem
        +
        Delete a file. Is only called on existing files + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        deleteFile in class FileSystem
        +
        Parameters:
        +
        path - the file to remove
        +
        Throws:
        +
        InvalidPathException - if the provided path is not a file.
        +
        NoSuchPathException - if the provided file does not exist.
        +
        XenonException - If the file could not be removed.
        +
        +
        • +
      + + + +
        +
      • +

        deleteDirectory

        +
        protected void deleteDirectory(Path path)
+                        throws XenonException
        +
        Description copied from class: FileSystem
        +
        Delete an empty directory. Is only called on empty directories + + This operation can only delete empty directories (analogous to rmdir in Linux). + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Specified by:
        +
        deleteDirectory in class FileSystem
        +
        Parameters:
        +
        path - the directory to remove
        +
        Throws:
        +
        InvalidPathException - if the provided path is not a directory.
        +
        NoSuchPathException - if the provided path does not exist.
        +
        XenonException - If the directory could not be removed.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        writeToFile

        +
        public java.io.OutputStream writeToFile(Path file,
+                                        long size)
+                                 throws XenonException
        +
        Description copied from class: FileSystem
        +
        Open a file and return an OutputStream to write to this file. +

        + + The size of the file (once all data has been written) must be specified using the size parameter. This is required by some implementations + (typically blob-stores). + +

        +
        +
        Specified by:
        +
        writeToFile in class FileSystem
        +
        Parameters:
        +
        file - the target file for the OutputStream.
        +
        size - the size of the file once fully written.
        +
        Returns:
        +
        the OutputStream to write to the file.
        +
        Throws:
        +
        PathAlreadyExistsException - If the target existed.
        +
        NoSuchPathException - if a parent directory does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        writeToFile

        +
        public java.io.OutputStream writeToFile(Path file)
+                                 throws XenonException
        +
        Description copied from class: FileSystem
        +
        Open a file and return an OutputStream to write to this file. (optional operation) +

        + If the file already exists it will be replaced and its data will be lost. + + The amount of data that will be written to the file is not specified in advance. This operation may not be supported by all implementations. + +

        +
        +
        Specified by:
        +
        writeToFile in class FileSystem
        +
        Parameters:
        +
        file - the target file for the OutputStream.
        +
        Returns:
        +
        the OutputStream to write to the file.
        +
        Throws:
        +
        PathAlreadyExistsException - If the target existed.
        +
        NoSuchPathException - if a parent directory does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        +
        • +
      + + + + + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/package-frame.html new file mode 100644 index 000000000..633b40d54 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/package-frame.html @@ -0,0 +1,20 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.webdav (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.adaptors.filesystems.webdav

+
+

Classes

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/package-summary.html new file mode 100644 index 000000000..c410ad54d --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/package-summary.html @@ -0,0 +1,143 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.webdav (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.adaptors.filesystems.webdav

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/package-tree.html new file mode 100644 index 000000000..60f54b6d5 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/package-tree.html @@ -0,0 +1,152 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.webdav Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.filesystems.webdav

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/package-frame.html new file mode 100644 index 000000000..d72e3c26a --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/package-frame.html @@ -0,0 +1,24 @@ + + + + + +nl.esciencecenter.xenon.adaptors (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.adaptors

+
+

Classes

+ +

Exceptions

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/package-summary.html new file mode 100644 index 000000000..1e7bea672 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/package-summary.html @@ -0,0 +1,162 @@ + + + + + +nl.esciencecenter.xenon.adaptors (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.adaptors

+
+
+
    +
  • + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    Adaptor 
    XenonProperties +
    Read-only properties implementation.
    +
    +
    • +
  • + + + + + + + + + + + + +
    Exception Summary 
    ExceptionDescription
    NotConnectedException +
    Signals that there was no connection.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/package-tree.html new file mode 100644 index 000000000..7a367dfce --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/package-tree.html @@ -0,0 +1,148 @@ + + + + + +nl.esciencecenter.xenon.adaptors Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/BadParameterException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/BadParameterException.html new file mode 100644 index 000000000..df796bdba --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/BadParameterException.html @@ -0,0 +1,332 @@ + + + + + +BadParameterException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class BadParameterException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class BadParameterException
+extends XenonException
    +
    Signals that a parameter has an invalid value.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      BadParameterException(java.lang.String adaptorName, + java.lang.String message) 
      BadParameterException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BadParameterException

        +
        public BadParameterException(java.lang.String adaptorName,
+                             java.lang.String message,
+                             java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        BadParameterException

        +
        public BadParameterException(java.lang.String adaptorName,
+                             java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/BatchProcess.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/BatchProcess.html new file mode 100644 index 000000000..403e373ec --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/BatchProcess.html @@ -0,0 +1,478 @@ + + + + + +BatchProcess (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class BatchProcess

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.BatchProcess
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Process
    +
    +
    +
    +
    class BatchProcess
+extends java.lang.Object
+implements Process
    +
    BatchProcess wraps an InteractiveProcess to emulate a batch process.
    +
    +
    Since:
    +
    1.0
    +
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/CommandLineUtils.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/CommandLineUtils.html new file mode 100644 index 000000000..0495d6082 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/CommandLineUtils.html @@ -0,0 +1,324 @@ + + + + + +CommandLineUtils (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class CommandLineUtils

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.CommandLineUtils
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class CommandLineUtils
+extends java.lang.Object
    +
    Some simple utilities for handling and creating scripts and command lines.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      private CommandLineUtils() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static java.lang.StringasCSList(java.lang.String[] values) +
      Create a single comma separated string out of a list of strings.
      +
      static java.lang.Stringconcat(java.lang.String... strings) +
      Concatinate a series of Strings using a StringBuilder.
      +
      static java.lang.StringprotectAgainstShellMetas(java.lang.String argument) +
      Escapes and quotes command line arguments to keep shells from expanding/interpreting them.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        CommandLineUtils

        +
        private CommandLineUtils()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        concat

        +
        public static java.lang.String concat(java.lang.String... strings)
        +
        Concatinate a series of Strings using a StringBuilder.
        +
        +
        Parameters:
        +
        strings - Strings to concatinate. Any Strings that are null will be ignored.
        +
        Returns:
        +
        the concatination of the provided strings, or the empty string is no strings where provided.
        +
        +
        • +
      + + + +
        +
      • +

        asCSList

        +
        public static java.lang.String asCSList(java.lang.String[] values)
        +
        Create a single comma separated string out of a list of strings. Will ignore null values
        +
        +
        Parameters:
        +
        values - an array of values.
        +
        Returns:
        +
        the given values as a single comma separated list (no spaces between elements, no trailing comma)
        +
        +
        • +
      + + + +
        +
      • +

        protectAgainstShellMetas

        +
        public static java.lang.String protectAgainstShellMetas(java.lang.String argument)
        +
        Escapes and quotes command line arguments to keep shells from expanding/interpreting them.
        +
        +
        Parameters:
        +
        argument - the argument to protect.
        +
        Returns:
        +
        an argument with quotes, and escaped characters where needed.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/Deadline.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/Deadline.html new file mode 100644 index 000000000..1bd12f1f2 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/Deadline.html @@ -0,0 +1,287 @@ + + + + + +Deadline (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class Deadline

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.Deadline
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class Deadline
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Deadline() +
      No need to use this constructor, use static methods instead.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static longgetDeadline(long timeout) +
      Calculate the epoch timestamp when a timeout will expire.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        Deadline

        +
        public Deadline()
        +
        No need to use this constructor, use static methods instead.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDeadline

        +
        public static long getDeadline(long timeout)
        +
        Calculate the epoch timestamp when a timeout will expire. + + This deadline is computed by adding the timeout to System.currentTimeMillis(). This computation is protected against overflow, + that is, the deadline will never exceed Long.MAX_VALUE. + + This allows the user to simply test if the deadline has passed by performing a check against the current epoch time: + + if (deadline <= System.currentTimeMillis()) { // deadline has passed }
        +
        +
        Parameters:
        +
        timeout - the timeout to compute the deadline with. Must be >= 0 or an IllegalArgumentException will be thrown.
        +
        Returns:
        +
        the timestamp at which the timeout will expire, or Long.MAX_VALUE if the timeout causes an overflow.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/IncompatibleVersionException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/IncompatibleVersionException.html new file mode 100644 index 000000000..fe39ad5f2 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/IncompatibleVersionException.html @@ -0,0 +1,332 @@ + + + + + +IncompatibleVersionException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class IncompatibleVersionException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class IncompatibleVersionException
+extends XenonException
    +
    Signals that an adaptor is unable to connect to a resource due to version problems.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      IncompatibleVersionException(java.lang.String adaptorName, + java.lang.String message) 
      IncompatibleVersionException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IncompatibleVersionException

        +
        public IncompatibleVersionException(java.lang.String adaptorName,
+                                    java.lang.String message,
+                                    java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        IncompatibleVersionException

        +
        public IncompatibleVersionException(java.lang.String adaptorName,
+                                    java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/InteractiveProcess.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/InteractiveProcess.html new file mode 100644 index 000000000..0cbef53a8 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/InteractiveProcess.html @@ -0,0 +1,234 @@ + + + + + +InteractiveProcess (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Interface InteractiveProcess

+
+
+
+ +
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/InteractiveProcessFactory.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/InteractiveProcessFactory.html new file mode 100644 index 000000000..096c065a6 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/InteractiveProcessFactory.html @@ -0,0 +1,269 @@ + + + + + +InteractiveProcessFactory (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Interface InteractiveProcessFactory

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobCanceledException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobCanceledException.html new file mode 100644 index 000000000..022bc7af8 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobCanceledException.html @@ -0,0 +1,332 @@ + + + + + +JobCanceledException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class JobCanceledException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class JobCanceledException
+extends XenonException
    +
    Signals that a jobs has been canceled by the user.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      JobCanceledException(java.lang.String adaptorName, + java.lang.String message) 
      JobCanceledException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        JobCanceledException

        +
        public JobCanceledException(java.lang.String adaptorName,
+                            java.lang.String message,
+                            java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        JobCanceledException

        +
        public JobCanceledException(java.lang.String adaptorName,
+                            java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobExecutor.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobExecutor.html new file mode 100644 index 000000000..0e0011aff --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobExecutor.html @@ -0,0 +1,953 @@ + + + + + +JobExecutor (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class JobExecutor

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.JobExecutor
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Runnable
    +
    +
    +
    +
    public class JobExecutor
+extends java.lang.Object
+implements java.lang.Runnable
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PENDING_STATE

        +
        private static final java.lang.String PENDING_STATE
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        RUNNING_STATE

        +
        private static final java.lang.String RUNNING_STATE
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        DONE_STATE

        +
        private static final java.lang.String DONE_STATE
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ERROR_STATE

        +
        private static final java.lang.String ERROR_STATE
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        KILLED_STATE

        +
        private static final java.lang.String KILLED_STATE
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        POLLING_DELAY

        +
        private static final long POLLING_DELAY
        +
        Polling delay in ms.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        MILLISECONDS_PER_MINUTE

        +
        private static final long MILLISECONDS_PER_MINUTE
        +
        Number of ms. per min.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + + + + + +
        +
      • +

        jobIdentifier

        +
        private final java.lang.String jobIdentifier
        +
        • +
      + + + +
        +
      • +

        interactive

        +
        private final boolean interactive
        +
        • +
      + + + + + + + +
        +
      • +

        pollingDelay

        +
        private final long pollingDelay
        +
        • +
      + + + +
        +
      • +

        startupTimeout

        +
        private final long startupTimeout
        +
        • +
      + + + +
        +
      • +

        adaptorName

        +
        private final java.lang.String adaptorName
        +
        • +
      + + + +
        +
      • +

        filesystem

        +
        private final FileSystem filesystem
        +
        • +
      + + + +
        +
      • +

        workingDirectory

        +
        private final Path workingDirectory
        +
        • +
      + + + +
        +
      • +

        streams

        +
        private Streams streams
        +
        • +
      + + + +
        +
      • +

        exitStatus

        +
        private java.lang.Integer exitStatus
        +
        • +
      + + + +
        +
      • +

        updateSignal

        +
        private boolean updateSignal
        +
        • +
      + + + +
        +
      • +

        isRunning

        +
        private boolean isRunning
        +
        • +
      + + + +
        +
      • +

        killed

        +
        private boolean killed
        +
        • +
      + + + +
        +
      • +

        done

        +
        private boolean done
        +
        • +
      + + + +
        +
      • +

        hasRun

        +
        private boolean hasRun
        +
        • +
      + + + +
        +
      • +

        state

        +
        private java.lang.String state
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        JobExecutor

        +
        public JobExecutor(java.lang.String adaptorName,
+                   FileSystem filesystem,
+                   Path workingDirectory,
+                   InteractiveProcessFactory factory,
+                   JobDescription description,
+                   java.lang.String jobIdentifier,
+                   boolean interactive,
+                   long pollingDelay,
+                   long startupTimeout)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hasRun

        +
        public boolean hasRun()
        +
        • +
      + + + +
        +
      • +

        kill

        +
        public boolean kill()
        +
        • +
      + + + +
        +
      • +

        isDone

        +
        public boolean isDone()
        +
        • +
      + + + +
        +
      • +

        getJobIdentifier

        +
        public java.lang.String getJobIdentifier()
        +
        • +
      + + + +
        +
      • +

        getJobDescription

        +
        public JobDescription getJobDescription()
        +
        • +
      + + + +
        +
      • +

        getStatus

        +
        public JobStatus getStatus()
        +
        • +
      + + + +
        +
      • +

        getState

        +
        public java.lang.String getState()
        +
        • +
      + + + +
        +
      • +

        getError

        +
        public java.lang.Exception getError()
        +
        • +
      + + + +
        +
      • +

        updateState

        +
        private void updateState(java.lang.String state,
+                         int exitStatus,
+                         XenonException e)
        +
        • +
      + + + +
        +
      • +

        getKilled

        +
        private boolean getKilled()
        +
        • +
      + + + +
        +
      • +

        setStreams

        +
        private void setStreams(Streams streams)
        +
        • +
      + + + + + + + +
        +
      • +

        waitUntilRunning

        +
        public JobStatus waitUntilRunning(long timeout)
        +
        • +
      + + + +
        +
      • +

        waitUntilDone

        +
        public JobStatus waitUntilDone(long timeout)
        +
        • +
      + + + +
        +
      • +

        triggerStatusUpdate

        +
        private void triggerStatusUpdate()
        +
        Signal the polling thread to produce a status update.
        +
        • +
      + + + +
        +
      • +

        waitForStatusUpdate

        +
        private void waitForStatusUpdate(long maxDelay)
        +
        Wait for a certain amount of time for an update.
        +
        +
        Parameters:
        +
        maxDelay - the maximum time to wait
        +
        +
        • +
      + + + +
        +
      • +

        clearUpdateRequest

        +
        private void clearUpdateRequest()
        +
        Clear the update signal and wake up any waiting threads
        +
        • +
      + + + +
        +
      • +

        sleep

        +
        private void sleep(long maxDelay)
        +
        Sleep for a certain amount of time, provide the job is not done, and no one requested an update.
        +
        +
        Parameters:
        +
        maxDelay - the maximum amount of time to wait
        +
        +
        • +
      + + + +
        +
      • +

        processPath

        +
        private Path processPath(Path root,
+                         java.lang.String path)
        +
        • +
      + + + +
        +
      • +

        run

        +
        public void run()
        +
        +
        Specified by:
        +
        run in interface java.lang.Runnable
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobQueueScheduler.DaemonThreadFactory.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobQueueScheduler.DaemonThreadFactory.html new file mode 100644 index 000000000..49f33f2dc --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobQueueScheduler.DaemonThreadFactory.html @@ -0,0 +1,284 @@ + + + + + +JobQueueScheduler.DaemonThreadFactory (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class JobQueueScheduler.DaemonThreadFactory

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler.DaemonThreadFactory
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.concurrent.ThreadFactory
    +
    +
    +
    Enclosing class:
    +
    JobQueueScheduler
    +
    +
    +
    +
    private class JobQueueScheduler.DaemonThreadFactory
+extends java.lang.Object
+implements java.util.concurrent.ThreadFactory
    +
    Simple thread factory which returns daemon threads instead of normal threads
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      private DaemonThreadFactory() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.ThreadnewThread(java.lang.Runnable runnable) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        DaemonThreadFactory

        +
        private DaemonThreadFactory()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        newThread

        +
        public java.lang.Thread newThread(java.lang.Runnable runnable)
        +
        +
        Specified by:
        +
        newThread in interface java.util.concurrent.ThreadFactory
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobQueueScheduler.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobQueueScheduler.html new file mode 100644 index 000000000..9bf9aa054 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobQueueScheduler.html @@ -0,0 +1,1222 @@ + + + + + +JobQueueScheduler (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class JobQueueScheduler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.AutoCloseable
    +
    +
    +
    +
    public class JobQueueScheduler
+extends Scheduler
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        SINGLE_QUEUE_NAME

        +
        private static final java.lang.String SINGLE_QUEUE_NAME
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        MULTI_QUEUE_NAME

        +
        private static final java.lang.String MULTI_QUEUE_NAME
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        UNLIMITED_QUEUE_NAME

        +
        private static final java.lang.String UNLIMITED_QUEUE_NAME
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        MIN_POLLING_DELAY

        +
        public static final int MIN_POLLING_DELAY
        +
        The minimal allowed value for the polling delay
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        MAX_POLLING_DELAY

        +
        public static final int MAX_POLLING_DELAY
        +
        The maximum allowed value for the polling delay
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        adaptorName

        +
        private final java.lang.String adaptorName
        +
        • +
      + + + +
        +
      • +

        filesystem

        +
        private final FileSystem filesystem
        +
        • +
      + + + +
        +
      • +

        workingDirectory

        +
        private final Path workingDirectory
        +
        • +
      + + + +
        +
      • +

        singleQ

        +
        private final java.util.List<JobExecutor> singleQ
        +
        • +
      + + + +
        +
      • +

        multiQ

        +
        private final java.util.List<JobExecutor> multiQ
        +
        • +
      + + + +
        +
      • +

        unlimitedQ

        +
        private final java.util.List<JobExecutor> unlimitedQ
        +
        • +
      + + + +
        +
      • +

        singleExecutor

        +
        private final java.util.concurrent.ExecutorService singleExecutor
        +
        • +
      + + + +
        +
      • +

        multiExecutor

        +
        private final java.util.concurrent.ExecutorService multiExecutor
        +
        • +
      + + + +
        +
      • +

        unlimitedExecutor

        +
        private final java.util.concurrent.ExecutorService unlimitedExecutor
        +
        • +
      + + + +
        +
      • +

        pollingDelay

        +
        private final long pollingDelay
        +
        • +
      + + + +
        +
      • +

        startupTimeout

        +
        private final long startupTimeout
        +
        • +
      + + + + + + + +
        +
      • +

        jobID

        +
        private final java.util.concurrent.atomic.AtomicLong jobID
        +
        • +
      + + + +
        +
      • +

        queues

        +
        private final java.util.ArrayList<java.util.List<JobExecutor>> queues
        +
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCurrentJobID

        +
        public long getCurrentJobID()
        +
        • +
      + + + +
        +
      • +

        getJobs

        +
        private void getJobs(java.util.List<JobExecutor> list,
+                     java.util.List<java.lang.String> out)
        +
        • +
      + + + +
        +
      • +

        getDefaultQueueName

        +
        public java.lang.String getDefaultQueueName()
+                                     throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get the name of the default queue.
        +
        +
        Specified by:
        +
        getDefaultQueueName in class Scheduler
        +
        Returns:
        +
        the name of the default queue for this scheduler, or null if no default queue is available.
        +
        Throws:
        +
        NotConnectedException - If scheduler is closed.
        +
        XenonException - If an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        getJobs

        +
        public java.lang.String[] getJobs(java.lang.String... queueNames)
+                           throws NoSuchQueueException
        +
        Description copied from class: Scheduler
        +
        Get all job identifier of jobs currently in (one ore more) queues. + + If no queue names are specified, the job identifiers for all queues are returned. + + Note that job identifiers of jobs submitted by other users or other schedulers may also be returned.
        +
        +
        Specified by:
        +
        getJobs in class Scheduler
        +
        Parameters:
        +
        queueNames - the names of the queues.
        +
        Returns:
        +
        an array containing the resulting job identifiers .
        +
        Throws:
        +
        NoSuchQueueException - If the queue does not exist in the scheduler.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        cleanupJob

        +
        private boolean cleanupJob(java.util.List<JobExecutor> queue,
+                           java.lang.String jobIdentifier)
        +
        • +
      + + + +
        +
      • +

        cleanupJob

        +
        private void cleanupJob(java.lang.String jobIdentifier)
        +
        • +
      + + + +
        +
      • +

        getJobStatus

        +
        public JobStatus getJobStatus(java.lang.String jobIdentifier)
+                       throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get the status of a Job.
        +
        +
        Specified by:
        +
        getJobStatus in class Scheduler
        +
        Parameters:
        +
        jobIdentifier - the job identifier of the job to get the status for.
        +
        Returns:
        +
        the status of the Job.
        +
        Throws:
        +
        NoSuchJobException - If the job is not known.
        +
        XenonException - If the status of the job could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        waitUntilDone

        +
        public JobStatus waitUntilDone(java.lang.String jobIdentifier,
+                               long timeout)
+                        throws XenonException
        +
        Description copied from class: Scheduler
        +
        Wait until a job is done or until a timeout expires. +

        + This method will wait until a job is done (either gracefully or by being killed or producing an error), or until the timeout expires, whichever comes + first. If the timeout expires, the job will continue to run. +

        +

        + The timeout is in milliseconds and must be >= 0. When timeout is 0, it will be ignored and this method will wait until the jobs is done. +

        +

        + A JobStatus is returned that can be used to determine why the call returned. +

        +
        +
        Specified by:
        +
        waitUntilDone in class Scheduler
        +
        Parameters:
        +
        jobIdentifier - the identifier of the to wait for.
        +
        timeout - the maximum time to wait for the job in milliseconds.
        +
        Returns:
        +
        the status of the Job.
        +
        Throws:
        +
        NoSuchJobException - If the job is not known.
        +
        XenonException - If the status of the job could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        waitUntilRunning

        +
        public JobStatus waitUntilRunning(java.lang.String jobIdentifier,
+                                  long timeout)
+                           throws XenonException
        +
        Description copied from class: Scheduler
        +
        Wait until a job starts running, or until a timeout expires. +

        + This method will return as soon as the job is no longer waiting in the queue, or when the timeout expires, whichever comes first. If the job is no longer + waiting in the queue, it may be running, but it may also be killed, finished or have produced an error. If the timeout expires, the job will continue to + be queued normally. +

        +

        + The timeout is in milliseconds and must be >= 0. When timeout is 0, it will be ignored and this method will wait until the job is no longer queued. +

        +

        + A JobStatus is returned that can be used to determine why the call returned. +

        +
        +
        Specified by:
        +
        waitUntilRunning in class Scheduler
        +
        Parameters:
        +
        jobIdentifier - the identifier of the to wait for.
        +
        timeout - the maximum time to wait in milliseconds.
        +
        Returns:
        +
        the status of the Job.
        +
        Throws:
        +
        NoSuchJobException - If the job is not known.
        +
        XenonException - If the status of the job could not be retrieved.
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + +
        +
      • +

        cancelJob

        +
        public JobStatus cancelJob(java.lang.String jobIdentifier)
+                    throws XenonException
        +
        Description copied from class: Scheduler
        +
        Cancel a job. +

        + A status is returned that indicates the state of the job after the cancel. If the job was already done it cannot be cancelled. +

        +

        + A JobStatus is returned that can be used to determine the state of the job after cancelJob returns. Note that it may take some time before the + job has actually terminated. The waitUntilDone method can be used to wait until the job is terminated. +

        +
        +
        Specified by:
        +
        cancelJob in class Scheduler
        +
        Parameters:
        +
        jobIdentifier - the identifier of job to kill.
        +
        Returns:
        +
        the status of the Job.
        +
        Throws:
        +
        NoSuchJobException - If the job is not known.
        +
        XenonException - If the status of the job could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        getQueueStatus

        +
        public QueueStatus getQueueStatus(java.lang.String queueName)
+                           throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get the status of the queue.
        +
        +
        Specified by:
        +
        getQueueStatus in class Scheduler
        +
        Parameters:
        +
        queueName - the name of the queue.
        +
        Returns:
        +
        the resulting QueueStatus.
        +
        Throws:
        +
        NoSuchQueueException - If the queue does not exist in the scheduler.
        +
        XenonException - If the Scheduler failed to get its status.
        +
        +
        • +
      + + + +
        +
      • +

        getQueueNames

        +
        public java.lang.String[] getQueueNames()
        +
        Description copied from class: Scheduler
        +
        Get the queue names supported by this Scheduler.
        +
        +
        Specified by:
        +
        getQueueNames in class Scheduler
        +
        Returns:
        +
        the queue names supported by this Scheduler.
        +
        +
        • +
      + + + +
        +
      • +

        getQueueStatuses

        +
        public QueueStatus[] getQueueStatuses(java.lang.String... queueNames)
+                               throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get the status of all queues. + + Note that this method will only throw an exception when this exception will influence all status requests. For example, if the scheduler is no longer + connected. + + Exceptions that only refer to a single queue are returned in the QueueStatus returned for that queue.
        +
        +
        Specified by:
        +
        getQueueStatuses in class Scheduler
        +
        Parameters:
        +
        queueNames - the names of the queues.
        +
        Returns:
        +
        an array containing the resulting QueueStatus.
        +
        Throws:
        +
        XenonException - If the Scheduler failed to get the statuses.
        +
        +
        • +
      + + + +
        +
      • +

        end

        +
        public void end()
        +
        • +
      + + + +
        +
      • +

        getFileSystem

        +
        public FileSystem getFileSystem()
+                         throws XenonException
        +
        Description copied from class: Scheduler
        +
        Retrieve the FileSystem used internally by this Scheduler. +

        + Often, a Scheduler needs to access files or directories on the machine it will schedule jobs. For example, to ensure a working directory + exists, or to redirect the stdin, stdout or stderr streams used by a job. +

        +

        + This method returns this FileSystem so it can also be used by the application to prepare input files for the jobs, or retrieve the output + files produced by the jobs. +

        +
        +
        Specified by:
        +
        getFileSystem in class Scheduler
        +
        Returns:
        +
        the FileSystem used by this Scheduler.
        +
        Throws:
        +
        XenonException - if this Scheduler does not use a FileSystem internally.
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws XenonException
        +
        Description copied from class: Scheduler
        +
        Close this Scheduler.
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Specified by:
        +
        close in class Scheduler
        +
        Throws:
        +
        XenonException - If the Scheduler failed to close.
        +
        +
        • +
      + + + +
        +
      • +

        isOpen

        +
        public boolean isOpen()
+               throws XenonException
        +
        Description copied from class: Scheduler
        +
        Test if the connection of this Scheduler is open.
        +
        +
        Specified by:
        +
        isOpen in class Scheduler
        +
        Returns:
        +
        true if the connection of this Scheduler is still open, false otherwise.
        +
        Throws:
        +
        XenonException - If an I/O error occurred.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobStatusImplementation.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobStatusImplementation.html new file mode 100644 index 000000000..d320338f7 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobStatusImplementation.html @@ -0,0 +1,695 @@ + + + + + +JobStatusImplementation (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class JobStatusImplementation

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.JobStatusImplementation
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    JobStatus
    +
    +
    +
    +
    public class JobStatusImplementation
+extends java.lang.Object
+implements JobStatus
    +
    JobStatus contains status information for a specific job.
    +
    +
    Since:
    +
    1.0
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      JobStatusImplementation(java.lang.String jobIdentifier, + java.lang.String name, + java.lang.String state, + java.lang.Integer exitCode, + XenonException exception, + boolean running, + boolean done, + java.util.Map<java.lang.String,java.lang.String> schedulerSpecificInformation) +
      Create a JobStatus.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object o) 
      XenonExceptiongetException() +
      Get the exception produced by the Job or while retrieving the status.
      +
      java.lang.IntegergetExitCode() +
      Get the exit code for the Job.
      +
      java.lang.StringgetJobIdentifier() +
      Get the job identifier of the Job for which this JobStatus was created.
      +
      java.lang.StringgetName() +
      Get the name of the Job for which this JobStatus was created.
      +
      java.util.Map<java.lang.String,java.lang.String>getSchedulerSpecificInformation() +
      Get scheduler specific information on the Job.
      +
      java.lang.StringgetState() +
      Get the state of the Job.
      +
      booleanhasException() +
      Has the Job or job retrieval produced a exception ?
      +
      inthashCode() 
      booleanisDone() +
      Is the Job done.
      +
      booleanisRunning() +
      Is the Job running.
      +
      voidmaybeThrowException() +
      Throws the exception produced by the Job or while retrieving the status, if it exists.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        jobIdentifier

        +
        private final java.lang.String jobIdentifier
        +
        • +
      + + + +
        +
      • +

        name

        +
        private final java.lang.String name
        +
        • +
      + + + +
        +
      • +

        state

        +
        private final java.lang.String state
        +
        • +
      + + + +
        +
      • +

        exitCode

        +
        private final java.lang.Integer exitCode
        +
        • +
      + + + + + + + +
        +
      • +

        running

        +
        private final boolean running
        +
        • +
      + + + +
        +
      • +

        done

        +
        private final boolean done
        +
        • +
      + + + +
        +
      • +

        schedulerSpecificInformation

        +
        private final java.util.Map<java.lang.String,java.lang.String> schedulerSpecificInformation
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        JobStatusImplementation

        +
        public JobStatusImplementation(java.lang.String jobIdentifier,
+                               java.lang.String name,
+                               java.lang.String state,
+                               java.lang.Integer exitCode,
+                               XenonException exception,
+                               boolean running,
+                               boolean done,
+                               java.util.Map<java.lang.String,java.lang.String> schedulerSpecificInformation)
        +
        Create a JobStatus.
        +
        +
        Parameters:
        +
        jobIdentifier - the identifier of the job for which this status was created.
        +
        name - the name of the job for which this status was created.
        +
        state - the state of the Job at the time this status was created.
        +
        exitCode - the exit code of the Job (if the jobs has finished).
        +
        exception - the exception produced when running Job (if the jobs has failed).
        +
        running - is the Job running ?
        +
        done - is the Job finished ?
        +
        schedulerSpecificInformation - a map of scheduler implementation specific information on the job.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getJobIdentifier

        +
        public java.lang.String getJobIdentifier()
        +
        Get the job identifier of the Job for which this JobStatus was created.
        +
        +
        Specified by:
        +
        getJobIdentifier in interface JobStatus
        +
        Returns:
        +
        the Job.
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Get the name of the Job for which this JobStatus was created.
        +
        +
        Specified by:
        +
        getName in interface JobStatus
        +
        Returns:
        +
        the Job.
        +
        +
        • +
      + + + +
        +
      • +

        getState

        +
        public java.lang.String getState()
        +
        Get the state of the Job.
        +
        +
        Specified by:
        +
        getState in interface JobStatus
        +
        Returns:
        +
        the state of the Job.
        +
        +
        • +
      + + + +
        +
      • +

        getExitCode

        +
        public java.lang.Integer getExitCode()
        +
        Get the exit code for the Job.
        +
        +
        Specified by:
        +
        getExitCode in interface JobStatus
        +
        Returns:
        +
        the exit code for the Job.
        +
        +
        • +
      + + + +
        +
      • +

        getException

        +
        public XenonException getException()
        +
        Get the exception produced by the Job or while retrieving the status. If a job was canceled, will return a JobCanceledException.
        +
        +
        Specified by:
        +
        getException in interface JobStatus
        +
        Returns:
        +
        the exception.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        isRunning

        +
        public boolean isRunning()
        +
        Is the Job running.
        +
        +
        Specified by:
        +
        isRunning in interface JobStatus
        +
        Returns:
        +
        if the Job is running.
        +
        +
        • +
      + + + +
        +
      • +

        isDone

        +
        public boolean isDone()
        +
        Is the Job done.
        +
        +
        Specified by:
        +
        isDone in interface JobStatus
        +
        Returns:
        +
        if the Job is done.
        +
        +
        • +
      + + + +
        +
      • +

        hasException

        +
        public boolean hasException()
        +
        Has the Job or job retrieval produced a exception ?
        +
        +
        Specified by:
        +
        hasException in interface JobStatus
        +
        Returns:
        +
        if the Job has an exception.
        +
        +
        • +
      + + + +
        +
      • +

        getSchedulerSpecificInformation

        +
        public java.util.Map<java.lang.String,java.lang.String> getSchedulerSpecificInformation()
        +
        Get scheduler specific information on the Job.
        +
        +
        Specified by:
        +
        getSchedulerSpecificInformation in interface JobStatus
        +
        Returns:
        +
        scheduler specific information on the Job.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/Process.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/Process.html new file mode 100644 index 000000000..9e54a2cd7 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/Process.html @@ -0,0 +1,252 @@ + + + + + +Process (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Interface Process

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isDone

        +
        boolean isDone()
        +
        • +
      + + + +
        +
      • +

        getExitStatus

        +
        int getExitStatus()
        +
        • +
      + + + +
        +
      • +

        destroy

        +
        void destroy()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/QueueStatusImplementation.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/QueueStatusImplementation.html new file mode 100644 index 000000000..497a2b9a2 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/QueueStatusImplementation.html @@ -0,0 +1,504 @@ + + + + + +QueueStatusImplementation (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class QueueStatusImplementation

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.QueueStatusImplementation
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    QueueStatus
    +
    +
    +
    +
    public class QueueStatusImplementation
+extends java.lang.Object
+implements QueueStatus
    +
    QueueStatus contains status information for a specific queue.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        scheduler

        +
        private final Scheduler scheduler
        +
        • +
      + + + +
        +
      • +

        queueName

        +
        private final java.lang.String queueName
        +
        • +
      + + + + + + + +
        +
      • +

        schedulerSpecificInformation

        +
        private final java.util.Map<java.lang.String,java.lang.String> schedulerSpecificInformation
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        QueueStatusImplementation

        +
        public QueueStatusImplementation(Scheduler scheduler,
+                                 java.lang.String queueName,
+                                 XenonException exception,
+                                 java.util.Map<java.lang.String,java.lang.String> schedulerSpecificInformation)
        +
        Create a Queue status.
        +
        +
        Parameters:
        +
        scheduler - the Scheduler to which the queue belongs.
        +
        queueName - the name of the queue.
        +
        exception - the exception produced when retrieving the queue status (if any).
        +
        schedulerSpecificInformation - scheduler implementation specific information on the status of the queue.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getScheduler

        +
        public Scheduler getScheduler()
        +
        Get the Scheduler that produced this QueueStatus.
        +
        +
        Specified by:
        +
        getScheduler in interface QueueStatus
        +
        Returns:
        +
        the Scheduler.
        +
        +
        • +
      + + + +
        +
      • +

        getQueueName

        +
        public java.lang.String getQueueName()
        +
        Get the queue name.
        +
        +
        Specified by:
        +
        getQueueName in interface QueueStatus
        +
        Returns:
        +
        the queue name.
        +
        +
        • +
      + + + +
        +
      • +

        hasException

        +
        public boolean hasException()
        +
        Did the queue produce an exception ?
        +
        +
        Specified by:
        +
        hasException in interface QueueStatus
        +
        Returns:
        +
        if the queue produced an exception ?
        +
        +
        • +
      + + + +
        +
      • +

        getException

        +
        public XenonException getException()
        +
        Get the exception produced by the queue, or null if hasException() returns false.
        +
        +
        Specified by:
        +
        getException in interface QueueStatus
        +
        Returns:
        +
        the exception.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getSchedulerSpecificInformation

        +
        public java.util.Map<java.lang.String,java.lang.String> getSchedulerSpecificInformation()
        +
        Get scheduler specific information on the queue.
        +
        +
        Specified by:
        +
        getSchedulerSpecificInformation in interface QueueStatus
        +
        Returns:
        +
        Scheduler specific information on the queue.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/RemoteCommandRunner.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/RemoteCommandRunner.html new file mode 100644 index 000000000..50190c56a --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/RemoteCommandRunner.html @@ -0,0 +1,419 @@ + + + + + +RemoteCommandRunner (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class RemoteCommandRunner

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.RemoteCommandRunner
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class RemoteCommandRunner
+extends java.lang.Object
    +
    Runs a command. Constructor waits for command to finish.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.lang.Stringerror 
      private intexitCode 
      private static org.slf4j.LoggerLOGGER 
      private java.lang.Stringoutput 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      RemoteCommandRunner(Scheduler scheduler, + java.lang.String stdin, + java.lang.String executable, + java.lang.String... arguments) +
      Run a command remotely, and save stdout, stderr, and exit code for later processing.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intgetExitCode() 
      java.lang.StringgetStderr() 
      java.lang.StringgetStdout() 
      booleansuccess() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        exitCode

        +
        private final int exitCode
        +
        • +
      + + + +
        +
      • +

        output

        +
        private final java.lang.String output
        +
        • +
      + + + +
        +
      • +

        error

        +
        private final java.lang.String error
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RemoteCommandRunner

        +
        public RemoteCommandRunner(Scheduler scheduler,
+                           java.lang.String stdin,
+                           java.lang.String executable,
+                           java.lang.String... arguments)
+                    throws XenonException
        +
        Run a command remotely, and save stdout, stderr, and exit code for later processing.
        +
        +
        Parameters:
        +
        scheduler - the scheduler to submit the job to
        +
        stdin - input to feed to the command
        +
        executable - command to run
        +
        arguments - arguments for the command
        +
        Throws:
        +
        XenonException - if the job could not be run successfully.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getStdout

        +
        public java.lang.String getStdout()
        +
        • +
      + + + +
        +
      • +

        getStderr

        +
        public java.lang.String getStderr()
        +
        • +
      + + + +
        +
      • +

        getExitCode

        +
        public int getExitCode()
        +
        • +
      + + + +
        +
      • +

        success

        +
        public boolean success()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/SchedulerAdaptor.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/SchedulerAdaptor.html new file mode 100644 index 000000000..373cc4ab9 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/SchedulerAdaptor.html @@ -0,0 +1,468 @@ + + + + + +SchedulerAdaptor (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class SchedulerAdaptor

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        ADAPTORS_PREFIX

        +
        public static final java.lang.String ADAPTORS_PREFIX
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SchedulerAdaptor

        +
        protected SchedulerAdaptor(java.lang.String name,
+                           java.lang.String description,
+                           java.lang.String[] locations,
+                           XenonPropertyDescription[] properties)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      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
        +
        Returns:
        +
        if this scheduler is embedded.
        +
        +
        • +
      + + + +
        +
      • +

        supportsBatch

        +
        public boolean supportsBatch()
        +
        Description copied from interface: SchedulerAdaptorDescription
        +
        Does this Scheduler support the submission of batch jobs ? + + For batch jobs the standard streams of the jobs are redirected from and to files.
        +
        +
        Specified by:
        +
        supportsBatch in interface SchedulerAdaptorDescription
        +
        Returns:
        +
        if this scheduler supports the submission of batch jobs ?
        +
        +
        • +
      + + + +
        +
      • +

        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
        +
        Returns:
        +
        if this scheduler supports the submission of interactive jobs ?
        +
        +
        • +
      + + + +
        +
      • +

        usesFileSystem

        +
        public boolean usesFileSystem()
        +
        Description copied from interface: SchedulerAdaptorDescription
        +
        Does this Scheduler create a FileSystem to support the submission of jobs ? + + Many scheduler implementations use a FileSystem internally to handle job submission, for example to store submission scripts or handle the standard I/O + streams of a process. This FileSystem can optionally be retrieved by the user to perform other tasks, such as staging in and output data of the job. To + do so use Scheduler.getFileSystem() method.
        +
        +
        Specified by:
        +
        usesFileSystem in interface SchedulerAdaptorDescription
        +
        Returns:
        +
        does this Scheduler create a FileSystem to support the submission of jobs ?
        +
        +
        • +
      + + + +
        +
      • +

        createScheduler

        +
        public abstract Scheduler createScheduler(java.lang.String location,
+                                          Credential credential,
+                                          java.util.Map<java.lang.String,java.lang.String> properties)
+                                   throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/SchedulerClosedException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/SchedulerClosedException.html new file mode 100644 index 000000000..6fee9d495 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/SchedulerClosedException.html @@ -0,0 +1,332 @@ + + + + + +SchedulerClosedException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class SchedulerClosedException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class SchedulerClosedException
+extends XenonException
    +
    Signals that a unknown Copy handle was provided.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      SchedulerClosedException(java.lang.String adaptorName, + java.lang.String message) 
      SchedulerClosedException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SchedulerClosedException

        +
        public SchedulerClosedException(java.lang.String adaptorName,
+                                java.lang.String message,
+                                java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        SchedulerClosedException

        +
        public SchedulerClosedException(java.lang.String adaptorName,
+                                java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingParser.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingParser.html new file mode 100644 index 000000000..2206ddba9 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingParser.html @@ -0,0 +1,640 @@ + + + + + +ScriptingParser (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class ScriptingParser

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.ScriptingParser
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class ScriptingParser
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      private ScriptingParser() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static intcheckIfContains(java.lang.String input, + java.lang.String adaptorName, + java.lang.String... options) +
      Checks if the given text contains any of the given options.
      +
      static java.lang.StringcleanValue(java.lang.String value, + java.lang.String... suffixes) +
      Remove suffix from a string if present.
      +
      static booleancontainsAny(java.lang.String input, + java.lang.String... options) +
      Returns if the given input String contains any of the option Strings given.
      +
      private static java.lang.String[]mergeTuples(java.lang.String[] values) 
      static java.lang.StringparseJobIDFromLine(java.lang.String input, + java.lang.String adaptorName, + java.lang.String... possiblePrefixes) +
      Get a JobID (number) from a line of input.
      +
      static java.util.Map<java.lang.String,java.lang.String>parseKeyValueLines(java.lang.String input, + java.util.regex.Pattern separatorRegEx, + java.lang.String adaptorName, + java.lang.String... ignoredLines) +
      Parses lines containing single key/value pairs separated by the given separator, possibly surrounded by whitespace.
      +
      static java.util.Map<java.lang.String,java.lang.String>parseKeyValuePairs(java.lang.String input, + java.lang.String adaptorName, + java.lang.String... ignoredLines) +
      Parses a output with key=value pairs separated by whitespace, on one or more lines.
      +
      static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>parseKeyValueRecords(java.lang.String input, + java.lang.String keyField, + java.util.regex.Pattern separatorRegEx, + java.lang.String adaptorName, + java.lang.String... ignoredLines) +
      Parses multiple key value records.
      +
      static java.lang.String[]parseList(java.lang.String input) +
      Parses a list of strings, separated by whitespace (including newlines) + Trailing empty strings are not included.
      +
      static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>parseTable(java.lang.String input, + java.lang.String keyField, + java.util.regex.Pattern fieldSeparatorRegEx, + java.lang.String adaptorName, + java.lang.String... valueSuffixes) +
      Parses lines containing multiple values.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        WHITESPACE_REGEX

        +
        public static final java.util.regex.Pattern WHITESPACE_REGEX
        +
        • +
      + + + +
        +
      • +

        BAR_REGEX

        +
        public static final java.util.regex.Pattern BAR_REGEX
        +
        • +
      + + + +
        +
      • +

        NEWLINE_REGEX

        +
        public static final java.util.regex.Pattern NEWLINE_REGEX
        +
        • +
      + + + +
        +
      • +

        EQUALS_REGEX

        +
        public static final java.util.regex.Pattern EQUALS_REGEX
        +
        • +
      + + + +
        +
      • +

        HORIZONTAL_LINE_REGEX

        +
        public static final java.util.regex.Pattern HORIZONTAL_LINE_REGEX
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ScriptingParser

        +
        private ScriptingParser()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        parseKeyValuePairs

        +
        public static java.util.Map<java.lang.String,java.lang.String> parseKeyValuePairs(java.lang.String input,
+                                                                                  java.lang.String adaptorName,
+                                                                                  java.lang.String... ignoredLines)
+                                                                           throws XenonException
        +
        Parses a output with key=value pairs separated by whitespace, on one or more lines. This function fails if there is any + whitespace between the key and value, or whitespace inside the values.
        +
        +
        Parameters:
        +
        input - the text to parse.
        +
        adaptorName - the adaptor name reported in case an exception occurs.
        +
        ignoredLines - lines exactly matching one of these strings will be ignored.
        +
        Returns:
        +
        a map containing all found key/value pairs.
        +
        Throws:
        +
        XenonException - if the input cannot be parsed.
        +
        +
        • +
      + + + +
        +
      • +

        containsAny

        +
        public static boolean containsAny(java.lang.String input,
+                                  java.lang.String... options)
        +
        Returns if the given input String contains any of the option Strings given.
        +
        +
        Parameters:
        +
        input - String to check on
        +
        options - Strings to check for
        +
        Returns:
        +
        is any of the Strings in options is contain in the input string
        +
        +
        • +
      + + + +
        +
      • +

        parseKeyValueLines

        +
        public static java.util.Map<java.lang.String,java.lang.String> parseKeyValueLines(java.lang.String input,
+                                                                                  java.util.regex.Pattern separatorRegEx,
+                                                                                  java.lang.String adaptorName,
+                                                                                  java.lang.String... ignoredLines)
+                                                                           throws XenonException
        +
        Parses lines containing single key/value pairs separated by the given separator, possibly surrounded by whitespace. Will + ignore empty lines.
        +
        +
        Parameters:
        +
        input - the input to parse
        +
        separatorRegEx - a regular expression for the separator between key and value
        +
        adaptorName - the adaptor name to report in case parsing failed
        +
        ignoredLines - lines containing any of the given strings will be ignored.
        +
        Returns:
        +
        a map containing all found key/value pairs.
        +
        Throws:
        +
        XenonException - if the input cannot be parsed
        +
        +
        • +
      + + + +
        +
      • +

        parseJobIDFromLine

        +
        public static java.lang.String parseJobIDFromLine(java.lang.String input,
+                                                  java.lang.String adaptorName,
+                                                  java.lang.String... possiblePrefixes)
+                                           throws XenonException
        +
        Get a JobID (number) from a line of input.
        +
        +
        Parameters:
        +
        input - the line containing the jobID
        +
        adaptorName - the adaptor name to report in case parsing failed
        +
        possiblePrefixes - a number of possible prefixes before the job ID.
        +
        Returns:
        +
        the job ID found on the input line.
        +
        Throws:
        +
        XenonException - if the input could not be parsed.
        +
        +
        • +
      + + + +
        +
      • +

        cleanValue

        +
        public static java.lang.String cleanValue(java.lang.String value,
+                                          java.lang.String... suffixes)
        +
        Remove suffix from a string if present. + + Although more than one possible suffix can be provided, only the first suffix encountered will be removed.
        +
        +
        Parameters:
        +
        value - the text to clean
        +
        suffixes - the possible suffixes to remove
        +
        Returns:
        +
        the cleaned text
        +
        +
        • +
      + + + +
        +
      • +

        parseTable

        +
        public static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> parseTable(java.lang.String input,
+                                                                                                          java.lang.String keyField,
+                                                                                                          java.util.regex.Pattern fieldSeparatorRegEx,
+                                                                                                          java.lang.String adaptorName,
+                                                                                                          java.lang.String... valueSuffixes)
+                                                                                                   throws XenonException
        +
        Parses lines containing multiple values. The first line of the output must contain a header with the field names.
        +
        +
        Parameters:
        +
        input - the input to parse
        +
        keyField - the field to use as the key in the result map. This field is mandatory in the output.
        +
        fieldSeparatorRegEx - a regular expression of the separator between fields. Usually whitespace.
        +
        adaptorName - the adaptor name to report in case parsing failed
        +
        valueSuffixes - suffixes to be removed from values in the table. Useful if the output contains special markers for defaults, + disabled queues, broken nodes, etc
        +
        Returns:
        +
        a map containing key/value maps of all records.
        +
        Throws:
        +
        XenonException - when parsing fails
        +
        +
        • +
      + + + +
        +
      • +

        mergeTuples

        +
        private static java.lang.String[] mergeTuples(java.lang.String[] values)
        +
        • +
      + + + +
        +
      • +

        checkIfContains

        +
        public static int checkIfContains(java.lang.String input,
+                                  java.lang.String adaptorName,
+                                  java.lang.String... options)
+                           throws XenonException
        +
        Checks if the given text contains any of the given options. Returns which option it contains, throws an exception if it + doesn't.
        +
        +
        Parameters:
        +
        input - the input text to check
        +
        adaptorName - the adaptor name to report in case no match was found
        +
        options - all possible options the input could contain
        +
        Returns:
        +
        the index of the matching option
        +
        Throws:
        +
        XenonException - in case the input does not contain any of the options given.
        +
        +
        • +
      + + + +
        +
      • +

        parseList

        +
        public static java.lang.String[] parseList(java.lang.String input)
        +
        Parses a list of strings, separated by whitespace (including newlines) + Trailing empty strings are not included.
        +
        +
        Parameters:
        +
        input - the input to parse
        +
        Returns:
        +
        an array of strings with no whitespace
        +
        +
        • +
      + + + +
        +
      • +

        parseKeyValueRecords

        +
        public static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> parseKeyValueRecords(java.lang.String input,
+                                                                                                                    java.lang.String keyField,
+                                                                                                                    java.util.regex.Pattern separatorRegEx,
+                                                                                                                    java.lang.String adaptorName,
+                                                                                                                    java.lang.String... ignoredLines)
+                                                                                                             throws XenonException
        +
        Parses multiple key value records. A new record begins when the given key field is found. Each line contains a single + key/value pair, separated by the given separator.
        +
        +
        Parameters:
        +
        input - the input to parse.
        +
        separatorRegEx - a regular expression for the separator between key and value
        +
        adaptorName - the adaptor name to report in case parsing failed
        +
        ignoredLines - lines containing any of the given strings will be ignored.
        +
        keyField - the header field which triggers a new record. the first line of the output must contain this key
        +
        Returns:
        +
        a map with all records found. The value of the key field is used as a key.
        +
        Throws:
        +
        XenonException - in case the output does not match the expected format
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingScheduler.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingScheduler.html new file mode 100644 index 000000000..38278ce26 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingScheduler.html @@ -0,0 +1,760 @@ + + + + + +ScriptingScheduler (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class ScriptingScheduler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.AutoCloseable
    +
    +
    +
    Direct Known Subclasses:
    +
    GridEngineScheduler, SlurmScheduler, TorqueScheduler
    +
    +
    +
    +
    public abstract class ScriptingScheduler
+extends Scheduler
    +
    Connection to a remote scheduler, implemented by calling command line commands over a ssh connection.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        subScheduler

        +
        protected final Scheduler subScheduler
        +
        • +
      + + + +
        +
      • +

        subFileSystem

        +
        protected final FileSystem subFileSystem
        +
        • +
      + + + +
        +
      • +

        pollDelay

        +
        protected final long pollDelay
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ScriptingScheduler

        +
        protected ScriptingScheduler(java.lang.String uniqueID,
+                             java.lang.String adaptor,
+                             java.lang.String location,
+                             Credential credential,
+                             java.util.Map<java.lang.String,java.lang.String> prop,
+                             XenonPropertyDescription[] validProperties,
+                             java.lang.String pollDelayProperty)
+                      throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getWorkingDirectory

        +
        protected Path getWorkingDirectory()
        +
        • +
      + + + +
        +
      • +

        getQueueStatuses

        +
        protected QueueStatus[] getQueueStatuses(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> all,
+                                         java.lang.String... queueNames)
        +
        • +
      + + + +
        +
      • +

        runCommand

        +
        public RemoteCommandRunner runCommand(java.lang.String stdin,
+                                      java.lang.String executable,
+                                      java.lang.String... arguments)
+                               throws XenonException
        +
        Run a command on the remote scheduler machine.
        +
        +
        Parameters:
        +
        stdin - the text to write to the input of the executable.
        +
        executable - the executable to run
        +
        arguments - the arguments to the executable
        +
        Returns:
        +
        a RemoteCommandRunner that can be used to monitor the running command
        +
        Throws:
        +
        XenonException - if an error occurs
        +
        +
        • +
      + + + + + + + +
        +
      • +

        runCheckedCommand

        +
        public java.lang.String runCheckedCommand(java.lang.String stdin,
+                                          java.lang.String executable,
+                                          java.lang.String... arguments)
+                                   throws XenonException
        +
        Run a command until completion. Throw an exception if the command returns a non-zero exit code, or prints to stderr.
        +
        +
        Parameters:
        +
        stdin - the text to write to the input of the executable.
        +
        executable - the executable to run
        +
        arguments - the arguments to the executable
        +
        Returns:
        +
        the text produced by the executable on the stdout stream.
        +
        Throws:
        +
        XenonException - if an error occurred
        +
        +
        • +
      + + + +
        +
      • +

        startInteractiveCommand

        +
        public Streams startInteractiveCommand(java.lang.String executable,
+                                       java.lang.String... arguments)
+                                throws XenonException
        +
        Start an interactive command on the remote machine (usually via ssh).
        +
        +
        Parameters:
        +
        executable - the executable to start
        +
        arguments - the arguments to pass to the executable
        +
        Returns:
        +
        the job identifier that represents the interactive command
        +
        Throws:
        +
        XenonException - if an error occurred
        +
        +
        • +
      + + + +
        +
      • +

        checkQueueNames

        +
        protected void checkQueueNames(java.lang.String[] givenQueueNames)
+                        throws XenonException
        +
        Checks if the queue names given are valid, and throw an exception otherwise. Checks against the list of queues when the scheduler was created.
        +
        +
        Parameters:
        +
        givenQueueNames - the queue names to check for validity
        +
        Throws:
        +
        NoSuchQueueException - if one or more of the queue names is not known in the scheduler
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        sleep

        +
        protected boolean sleep(long pollDelay)
        +
        • +
      + + + +
        +
      • +

        waitUntilDone

        +
        public JobStatus waitUntilDone(java.lang.String jobIdentifier,
+                               long timeout)
+                        throws XenonException
        +
        Wait until a Job is done, or until the give timeout expires (whichever comes first). + + A timeout of 0 will result in an infinite timeout, a negative timeout will result in an exception.
        +
        +
        Specified by:
        +
        waitUntilDone in class Scheduler
        +
        Parameters:
        +
        jobIdentifier - the Job to wait for
        +
        timeout - the maximum number of milliseconds to wait, 0 to wait forever, or negative to return immediately.
        +
        Returns:
        +
        the status of the job
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the value to timeout is negative
        +
        XenonException - if an error occurs
        +
        +
        • +
      + + + +
        +
      • +

        waitUntilRunning

        +
        public JobStatus waitUntilRunning(java.lang.String jobIdentifier,
+                                  long timeout)
+                           throws XenonException
        +
        Wait until a Job is running (or already done), or until the given timeout expires, whichever comes first. + + A timeout of 0 will result in an infinite timeout. A negative timeout will result in an exception.
        +
        +
        Specified by:
        +
        waitUntilRunning in class Scheduler
        +
        Parameters:
        +
        jobIdentifier - the Job to wait for
        +
        timeout - the maximum number of milliseconds to wait, 0 to wait forever, or negative to return immediately.
        +
        Returns:
        +
        the status of the job
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the value of timeout was negative
        +
        XenonException - if an error occurs
        +
        +
        • +
      + + + +
        +
      • +

        checkQueue

        +
        protected void checkQueue(java.lang.String[] queueNames,
+                          java.lang.String queueName)
+                   throws NoSuchQueueException
        +
        Check if the given queueName is presents in queueNames. + + If queueName is null or queueName is present in queueNames this method will return. Otherwise it will + throw a NoSuchQueueException.
        +
        +
        Parameters:
        +
        queueNames - the valid queue names.
        +
        queueName - the queueName to check.
        +
        Throws:
        +
        NoSuchQueueException - if workingDirectory does not exist, or an error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        checkWorkingDirectory

        +
        protected void checkWorkingDirectory(java.lang.String workingDirectory)
+                              throws XenonException
        +
        Check if the given working directory exists. Useful for schedulers that do not check this (like Slurm)
        +
        +
        Parameters:
        +
        workingDirectory - the working directory (either absolute or relative) as given by the user.
        +
        Throws:
        +
        XenonException - if workingDirectory does not exist, or an error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        isOpen

        +
        public boolean isOpen()
+               throws XenonException
        +
        Description copied from class: Scheduler
        +
        Test if the connection of this Scheduler is open.
        +
        +
        Specified by:
        +
        isOpen in class Scheduler
        +
        Returns:
        +
        true if the connection of this Scheduler is still open, false otherwise.
        +
        Throws:
        +
        XenonException - If an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws XenonException
        +
        Description copied from class: Scheduler
        +
        Close this Scheduler.
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Specified by:
        +
        close in class Scheduler
        +
        Throws:
        +
        XenonException - If the Scheduler failed to close.
        +
        +
        • +
      + + + +
        +
      • +

        getFileSystem

        +
        public FileSystem getFileSystem()
+                         throws XenonException
        +
        Description copied from class: Scheduler
        +
        Retrieve the FileSystem used internally by this Scheduler. +

        + Often, a Scheduler needs to access files or directories on the machine it will schedule jobs. For example, to ensure a working directory + exists, or to redirect the stdin, stdout or stderr streams used by a job. +

        +

        + This method returns this FileSystem so it can also be used by the application to prepare input files for the jobs, or retrieve the output + files produced by the jobs. +

        +
        +
        Specified by:
        +
        getFileSystem in class Scheduler
        +
        Returns:
        +
        the FileSystem used by this Scheduler.
        +
        Throws:
        +
        XenonException - if this Scheduler does not use a FileSystem internally.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingSchedulerAdaptor.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingSchedulerAdaptor.html new file mode 100644 index 000000000..cba0a1c82 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingSchedulerAdaptor.html @@ -0,0 +1,343 @@ + + + + + +ScriptingSchedulerAdaptor (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class ScriptingSchedulerAdaptor

+
+
+ +
+ +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        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.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingUtils.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingUtils.html new file mode 100644 index 000000000..8edc5c9e8 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingUtils.html @@ -0,0 +1,403 @@ + + + + + +ScriptingUtils (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class ScriptingUtils

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.ScriptingUtils
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class ScriptingUtils
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      private ScriptingUtils() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static XenonPropertiesgetProperties(XenonPropertyDescription[] validProperties, + java.lang.String location, + java.util.Map<java.lang.String,java.lang.String> properties) 
      static booleanisLocal(java.lang.String location) 
      static booleanisSSH(java.lang.String location) 
      static XenonPropertyDescription[]mergeValidProperties(XenonPropertyDescription[]... prop) 
      static voidverifyJobDescription(JobDescription description, + java.lang.String adaptorName) +
      Do some checks on a job description.
      +
      static voidverifyJobInfo(java.util.Map<java.lang.String,java.lang.String> jobInfo, + java.lang.String jobIdentifier, + java.lang.String adaptorName, + java.lang.String jobIDField, + java.lang.String... additionalFields) +
      Check if the info map for a job exists, contains the expected job ID, and contains the given additional fields
      +
      static voidverifyJobOptions(java.util.Map<java.lang.String,java.lang.String> options, + java.lang.String[] validOptions, + java.lang.String adaptorName) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ScriptingUtils

        +
        private ScriptingUtils()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isLocal

        +
        public static boolean isLocal(java.lang.String location)
        +
        • +
      + + + +
        +
      • +

        isSSH

        +
        public static boolean isSSH(java.lang.String location)
        +
        • +
      + + + + + + + + + + + + + + + + + + + +
        +
      • +

        verifyJobInfo

        +
        public static void verifyJobInfo(java.util.Map<java.lang.String,java.lang.String> jobInfo,
+                                 java.lang.String jobIdentifier,
+                                 java.lang.String adaptorName,
+                                 java.lang.String jobIDField,
+                                 java.lang.String... additionalFields)
+                          throws XenonException
        +
        Check if the info map for a job exists, contains the expected job ID, and contains the given additional fields
        +
        +
        Parameters:
        +
        jobInfo - the info map to check.
        +
        jobIdentifier - the unique identifier of the job.
        +
        adaptorName - name of the current adaptor for error reporting.
        +
        jobIDField - the field which contains the job id.
        +
        additionalFields - any additional fields to check the presence of.
        +
        Throws:
        +
        XenonException - if any fields are missing or incorrect
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/StreamsImplementation.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/StreamsImplementation.html new file mode 100644 index 000000000..9fe7f97e2 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/StreamsImplementation.html @@ -0,0 +1,476 @@ + + + + + +StreamsImplementation (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers
+

Class StreamsImplementation

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.StreamsImplementation
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Streams
    +
    +
    +
    +
    public class StreamsImplementation
+extends java.lang.Object
+implements Streams
    +
    Streams is a container for the standard input, output and error streams of a job. + + Note that these standard streams are only available for interactive jobs.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.lang.StringjobIdentifier 
      private java.io.InputStreamstderr 
      private java.io.OutputStreamstdin 
      private java.io.InputStreamstdout 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      StreamsImplementation(java.lang.String jobIdentifier, + java.io.InputStream stdout, + java.io.OutputStream stdin, + java.io.InputStream stderr) +
      Create a Streams containing the job and its standard streams.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object o) 
      java.lang.StringgetJobIdentifier() +
      Get the identifier of the job for which this Streams was created.
      +
      java.io.InputStreamgetStderr() +
      Returns the standard error stream of job.
      +
      java.io.OutputStreamgetStdin() +
      Returns the standard input stream of job.
      +
      java.io.InputStreamgetStdout() +
      Returns the standard output stream of job.
      +
      inthashCode() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        jobIdentifier

        +
        private final java.lang.String jobIdentifier
        +
        • +
      + + + +
        +
      • +

        stdout

        +
        private final java.io.InputStream stdout
        +
        • +
      + + + +
        +
      • +

        stderr

        +
        private final java.io.InputStream stderr
        +
        • +
      + + + +
        +
      • +

        stdin

        +
        private final java.io.OutputStream stdin
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StreamsImplementation

        +
        public StreamsImplementation(java.lang.String jobIdentifier,
+                             java.io.InputStream stdout,
+                             java.io.OutputStream stdin,
+                             java.io.InputStream stderr)
        +
        Create a Streams containing the job and its standard streams.
        +
        +
        Parameters:
        +
        jobIdentifier - the identifier of the job.
        +
        stdout - the standard output stream.
        +
        stdin - the standard input stream.
        +
        stderr - the standard error stream.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getJobIdentifier

        +
        public java.lang.String getJobIdentifier()
        +
        Get the identifier of the job for which this Streams was created.
        +
        +
        Specified by:
        +
        getJobIdentifier in interface Streams
        +
        Returns:
        +
        the identifier of the ob.
        +
        +
        • +
      + + + +
        +
      • +

        getStdout

        +
        public java.io.InputStream getStdout()
        +
        Returns the standard output stream of job.
        +
        +
        Specified by:
        +
        getStdout in interface Streams
        +
        Returns:
        +
        the standard output stream of job.
        +
        +
        • +
      + + + +
        +
      • +

        getStderr

        +
        public java.io.InputStream getStderr()
        +
        Returns the standard error stream of job.
        +
        +
        Specified by:
        +
        getStderr in interface Streams
        +
        Returns:
        +
        the standard error stream of job.
        +
        +
        • +
      + + + +
        +
      • +

        getStdin

        +
        public java.io.OutputStream getStdin()
        +
        Returns the standard input stream of job.
        +
        +
        Specified by:
        +
        getStdin in interface Streams
        +
        Returns:
        +
        the standard input stream of this job.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineScheduler.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineScheduler.html new file mode 100644 index 000000000..848fc787c --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineScheduler.html @@ -0,0 +1,859 @@ + + + + + +GridEngineScheduler (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+

Class GridEngineScheduler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.AutoCloseable
    +
    +
    +
    +
    public class GridEngineScheduler
+extends ScriptingScheduler
    +
    Interface to the GridEngine command line tools. Will run commands to submit/list/cancel jobs and get the status of queues.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        accountingGraceTime

        +
        private final long accountingGraceTime
        +
        • +
      + + + +
        +
      • +

        lastSeenMap

        +
        private final java.util.Map<java.lang.String,java.lang.Long> lastSeenMap
        +
        Map with the last seen time of jobs. There is a delay between jobs disappearing from the qstat queue output, and information about this job appearing in + the qacct output. Instead of throwing an exception, we allow for a certain grace time. Jobs will report the status "pending" during this time. Typical + delays are in the order of seconds.
        +
        • +
      + + + +
        +
      • +

        deletedJobs

        +
        private final java.util.Set<java.lang.Long> deletedJobs
        +
        • +
      + + + + + + + + +
      • +
    + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getQueueNames

        +
        public java.lang.String[] getQueueNames()
        +
        Description copied from class: Scheduler
        +
        Get the queue names supported by this Scheduler.
        +
        +
        Specified by:
        +
        getQueueNames in class Scheduler
        +
        Returns:
        +
        the queue names supported by this Scheduler.
        +
        +
        • +
      + + + +
        +
      • +

        getDefaultQueueName

        +
        public java.lang.String getDefaultQueueName()
        +
        Description copied from class: Scheduler
        +
        Get the name of the default queue.
        +
        +
        Specified by:
        +
        getDefaultQueueName in class Scheduler
        +
        Returns:
        +
        the name of the default queue for this scheduler, or null if no default queue is available.
        +
        +
        • +
      + + + +
        +
      • +

        updateJobsSeenMap

        +
        private void updateJobsSeenMap(java.util.Set<java.lang.String> identifiers)
        +
        • +
      + + + +
        +
      • +

        haveRecentlySeen

        +
        private boolean haveRecentlySeen(java.lang.String identifier)
        +
        • +
      + + + +
        +
      • +

        addDeletedJob

        +
        private void addDeletedJob(java.lang.String jobIdentifier)
        +
        • +
      + + + +
        +
      • +

        jobWasDeleted

        +
        private boolean jobWasDeleted(java.lang.String jobIdentifier)
        +
        • +
      + + + +
        +
      • +

        jobsFromStatus

        +
        private void jobsFromStatus(java.lang.String statusOutput,
+                            java.util.List<java.lang.String> result)
+                     throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        getJobs

        +
        public java.lang.String[] getJobs(java.lang.String... queueNames)
+                           throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get all job identifier of jobs currently in (one ore more) queues. + + If no queue names are specified, the job identifiers for all queues are returned. + + Note that job identifiers of jobs submitted by other users or other schedulers may also be returned.
        +
        +
        Specified by:
        +
        getJobs in class Scheduler
        +
        Parameters:
        +
        queueNames - the names of the queues.
        +
        Returns:
        +
        an array containing the resulting job identifiers .
        +
        Throws:
        +
        NotConnectedException - If scheduler is closed.
        +
        NoSuchQueueException - If the queue does not exist in the scheduler.
        +
        XenonException - If the Scheduler failed to get jobs.
        +
        +
        • +
      + + + +
        +
      • +

        getQueueStatus

        +
        public QueueStatus getQueueStatus(java.lang.String queueName)
+                           throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get the status of the queue.
        +
        +
        Specified by:
        +
        getQueueStatus in class Scheduler
        +
        Parameters:
        +
        queueName - the name of the queue.
        +
        Returns:
        +
        the resulting QueueStatus.
        +
        Throws:
        +
        NoSuchQueueException - If the queue does not exist in the scheduler.
        +
        XenonException - If the Scheduler failed to get its status.
        +
        +
        • +
      + + + +
        +
      • +

        getQueueStatuses

        +
        public QueueStatus[] getQueueStatuses(java.lang.String... queueNames)
+                               throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get the status of all queues. + + Note that this method will only throw an exception when this exception will influence all status requests. For example, if the scheduler is no longer + connected. + + Exceptions that only refer to a single queue are returned in the QueueStatus returned for that queue.
        +
        +
        Specified by:
        +
        getQueueStatuses in class Scheduler
        +
        Parameters:
        +
        queueNames - the names of the queues.
        +
        Returns:
        +
        an array containing the resulting QueueStatus.
        +
        Throws:
        +
        XenonException - If the Scheduler failed to get the statuses.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        cancelJob

        +
        public JobStatus cancelJob(java.lang.String jobIdentifier)
+                    throws XenonException
        +
        Description copied from class: Scheduler
        +
        Cancel a job. +

        + A status is returned that indicates the state of the job after the cancel. If the job was already done it cannot be cancelled. +

        +

        + A JobStatus is returned that can be used to determine the state of the job after cancelJob returns. Note that it may take some time before the + job has actually terminated. The waitUntilDone method can be used to wait until the job is terminated. +

        +
        +
        Specified by:
        +
        cancelJob in class Scheduler
        +
        Parameters:
        +
        jobIdentifier - the identifier of job to kill.
        +
        Returns:
        +
        the status of the Job.
        +
        Throws:
        +
        NoSuchJobException - If the job is not known.
        +
        XenonException - If the status of the job could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        getQstatInfo

        +
        private java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getQstatInfo()
+                                                                                               throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        getQacctInfo

        +
        private java.util.Map<java.lang.String,java.lang.String> getQacctInfo(java.lang.String jobIdentifier)
+                                                               throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        getJobStatus

        +
        private JobStatus getJobStatus(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> qstatInfo,
+                               java.lang.String jobIdentifier)
+                        throws XenonException
        +
        Get job status. First checks given qstat info map, but also runs additional qacct and qdel commands if needed.
        +
        +
        Parameters:
        +
        qstatInfo - the info to get the job status from.
        +
        jobIdentifier - the job to get the status for.
        +
        Returns:
        +
        the JobStatus of the job.
        +
        Throws:
        +
        XenonException - in case the info is not valid.
        +
        XenonException - in case an additional command fails to run.
        +
        +
        • +
      + + + +
        +
      • +

        getJobStatus

        +
        public JobStatus getJobStatus(java.lang.String jobIdentifier)
+                       throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get the status of a Job.
        +
        +
        Specified by:
        +
        getJobStatus in class Scheduler
        +
        Parameters:
        +
        jobIdentifier - the job identifier of the job to get the status for.
        +
        Returns:
        +
        the status of the Job.
        +
        Throws:
        +
        NoSuchJobException - If the job is not known.
        +
        XenonException - If the status of the job could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        getJobStatuses

        +
        public JobStatus[] getJobStatuses(java.lang.String... jobs)
+                           throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get the status of all specified jobs. +

        + The array of JobStatus contains one entry for each of the jobs. The order of the elements in the returned + JobStatus array corresponds to the order in which the jobs are passed as parameters. If a job is + null, the corresponding entry in the JobStatus array will also be null. If the retrieval of the + JobStatus fails for a job, the exception will be stored in the corresponding JobsStatus entry. +

        +
        +
        Overrides:
        +
        getJobStatuses in class Scheduler
        +
        Parameters:
        +
        jobs - the job identifiers for which to retrieve the status.
        +
        Returns:
        +
        an array of the resulting JobStatuses.
        +
        Throws:
        +
        XenonException - If an I/O error occurred
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineSchedulerAdaptor.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineSchedulerAdaptor.html new file mode 100644 index 000000000..401225a0b --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineSchedulerAdaptor.html @@ -0,0 +1,513 @@ + + + + + +GridEngineSchedulerAdaptor (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+

Class GridEngineSchedulerAdaptor

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        ADAPTOR_NAME

        +
        public static final java.lang.String ADAPTOR_NAME
        +
        The name of this adaptor
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PREFIX

        +
        public static final java.lang.String PREFIX
        +
        The prefix used by all properties related to this adaptor
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        IGNORE_VERSION_PROPERTY

        +
        public static final java.lang.String IGNORE_VERSION_PROPERTY
        +
        Should the grid engine version on the target machine be ignored ?
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ACCOUNTING_GRACE_TIME_PROPERTY

        +
        public static final java.lang.String ACCOUNTING_GRACE_TIME_PROPERTY
        +
        Timeout for waiting for the accounting info of a job to appear
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        POLL_DELAY_PROPERTY

        +
        public static final java.lang.String POLL_DELAY_PROPERTY
        +
        Polling delay for jobs started by this adaptor.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ADAPTOR_DESCRIPTION

        +
        public static final java.lang.String ADAPTOR_DESCRIPTION
        +
        Human readable description of 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 all properties supported by this adaptor
        +
        • +
      +
      • +
    + + + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineSetup.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineSetup.html new file mode 100644 index 000000000..51881af37 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineSetup.html @@ -0,0 +1,474 @@ + + + + + +GridEngineSetup (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+

Class GridEngineSetup

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class GridEngineSetup
+extends java.lang.Object
    +
    Holds some info on the specifics of the machine we are connected to, such as queues and parallel environments.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        queueNames

        +
        private final java.lang.String[] queueNames
        +
        • +
      + + + +
        +
      • +

        queues

        +
        private final java.util.Map<java.lang.String,QueueInfo> queues
        +
        • +
      + + + +
        +
      • +

        parallelEnvironments

        +
        private final java.util.Map<java.lang.String,ParallelEnvironmentInfo> parallelEnvironments
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + + + + + +
        +
      • +

        GridEngineSetup

        +
        GridEngineSetup(java.lang.String[] queueNames,
+                java.util.Map<java.lang.String,QueueInfo> queues,
+                java.util.Map<java.lang.String,ParallelEnvironmentInfo> parallelEnvironments)
        +
        Testing constructor.
        +
        +
        Parameters:
        +
        queueNames - queue names to use.
        +
        queues - queues to use.
        +
        parallelEnvironments - parallel environments to use.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        qconfPeDetailsArguments

        +
        protected static java.lang.String[] qconfPeDetailsArguments(java.lang.String[] parallelEnvironmentNames)
        +
        generate arguments to list details of all parallel environments given
        +
        +
        Parameters:
        +
        parallelEnvironmentNames - names of parallel environments to list
        +
        Returns:
        +
        a list of all qconf arguments needed to list all parallel environments
        +
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        getQueueNames

        +
        public java.lang.String[] getQueueNames()
        +
        • +
      + + + +
        +
      • +

        calculateSlots

        +
        protected int calculateSlots(java.lang.String parallelEnvironmentName,
+                             java.lang.String queueName,
+                             int nodeCount)
+                      throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineUtils.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineUtils.html new file mode 100644 index 000000000..6844b7318 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineUtils.html @@ -0,0 +1,541 @@ + + + + + +GridEngineUtils (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+

Class GridEngineUtils

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    final class GridEngineUtils
+extends java.lang.Object
    +
    Generator for GridEngine job script.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        JOB_OPTION_JOB_SCRIPT

        +
        public static final java.lang.String JOB_OPTION_JOB_SCRIPT
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        JOB_OPTION_PARALLEL_ENVIRONMENT

        +
        public static final java.lang.String JOB_OPTION_PARALLEL_ENVIRONMENT
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        JOB_OPTION_PARALLEL_SLOTS

        +
        public static final java.lang.String JOB_OPTION_PARALLEL_SLOTS
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        JOB_OPTION_RESOURCES

        +
        public static final java.lang.String JOB_OPTION_RESOURCES
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        VALID_JOB_OPTIONS

        +
        private static final java.lang.String[] VALID_JOB_OPTIONS
        +
        • +
      + + + +
        +
      • +

        QACCT_HEADER

        +
        public static final java.lang.String QACCT_HEADER
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        MINUTES_PER_HOUR

        +
        private static final int MINUTES_PER_HOUR
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GridEngineUtils

        +
        private GridEngineUtils()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        generateSerialScriptContent

        +
        protected static void generateSerialScriptContent(JobDescription description,
+                                                  java.util.Formatter script)
        +
        • +
      + + + +
        +
      • +

        generateParallelScriptContent

        +
        protected static void generateParallelScriptContent(JobDescription description,
+                                                    java.util.Formatter script)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getJobStatusFromQacctInfo

        +
        protected static JobStatus getJobStatusFromQacctInfo(java.util.Map<java.lang.String,java.lang.String> info,
+                                                     java.lang.String jobIdentifier)
+                                              throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        getJobStatusFromQstatInfo

        +
        protected static JobStatus getJobStatusFromQstatInfo(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> info,
+                                                     java.lang.String jobIdentifier)
+                                              throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineXmlParser.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineXmlParser.html new file mode 100644 index 000000000..f0d119d51 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineXmlParser.html @@ -0,0 +1,459 @@ + + + + + +GridEngineXmlParser (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+

Class GridEngineXmlParser

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineXmlParser
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class GridEngineXmlParser
+extends java.lang.Object
    +
    Parses xml output from various grid engine command line tools. For more info on the output, see the + "N1 Grid Engine 6 User's Guide". Retrieved from: http://docs.oracle.com/cd/E19080-01/n1.grid.eng6/817-6117/chp11-1/index.html
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      GridEngineXmlParser(boolean ignoreVersion) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private voidcheckVersion(org.w3c.dom.Document document) 
      private java.util.Map<java.lang.String,java.lang.String>mapFromElement(org.w3c.dom.Element root) 
      protected org.w3c.dom.DocumentparseDocument(java.lang.String data) 
      protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>parseJobInfos(java.lang.String data) +
      Parses job info from "qstat -xml"
      +
      protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>parseQueueInfos(java.lang.String input) +
      Parses queue info from "qstat -g c -xml"
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        SGE62_SCHEMA_ATTRIBUTE

        +
        private static final java.lang.String SGE62_SCHEMA_ATTRIBUTE
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        SGE62_SCHEMA_VALUE

        +
        private static final java.lang.String SGE62_SCHEMA_VALUE
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        documentBuilder

        +
        private final javax.xml.parsers.DocumentBuilder documentBuilder
        +
        • +
      + + + +
        +
      • +

        ignoreVersion

        +
        private final boolean ignoreVersion
        +
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        parseDocument

        +
        protected org.w3c.dom.Document parseDocument(java.lang.String data)
+                                      throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        mapFromElement

        +
        private java.util.Map<java.lang.String,java.lang.String> mapFromElement(org.w3c.dom.Element root)
        +
        • +
      + + + +
        +
      • +

        parseQueueInfos

        +
        protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> parseQueueInfos(java.lang.String input)
+                                                                                                    throws XenonException
        +
        Parses queue info from "qstat -g c -xml"
        +
        +
        Parameters:
        +
        input - the stream to get the xml data from
        +
        Returns:
        +
        a list containing all queue names found
        +
        Throws:
        +
        XenonException - if the file could not be parsed
        +
        XenonException - if the server version is not compatible with this adaptor
        +
        +
        • +
      + + + +
        +
      • +

        parseJobInfos

        +
        protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> parseJobInfos(java.lang.String data)
+                                                                                                  throws XenonException
        +
        Parses job info from "qstat -xml"
        +
        +
        Parameters:
        +
        data - the stream to get the xml data from
        +
        Returns:
        +
        a list containing all queue names found
        +
        Throws:
        +
        XenonException - if the file could not be parsed
        +
        XenonException - if the server version is not compatible with this adaptor
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/ParallelEnvironmentInfo.AllocationRule.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/ParallelEnvironmentInfo.AllocationRule.html new file mode 100644 index 000000000..b62ab5a62 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/ParallelEnvironmentInfo.AllocationRule.html @@ -0,0 +1,366 @@ + + + + + +ParallelEnvironmentInfo.AllocationRule (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+

Enum ParallelEnvironmentInfo.AllocationRule

+
+
+ +
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static ParallelEnvironmentInfo.AllocationRulevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ParallelEnvironmentInfo.AllocationRule[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ParallelEnvironmentInfo.AllocationRule[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (ParallelEnvironmentInfo.AllocationRule c : ParallelEnvironmentInfo.AllocationRule.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ParallelEnvironmentInfo.AllocationRule valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/ParallelEnvironmentInfo.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/ParallelEnvironmentInfo.html new file mode 100644 index 000000000..270b136cf --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/ParallelEnvironmentInfo.html @@ -0,0 +1,493 @@ + + + + + +ParallelEnvironmentInfo (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+

Class ParallelEnvironmentInfo

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    class ParallelEnvironmentInfo
+extends java.lang.Object
    +
    Class that holds some info on parallel environments used in Grid Engine.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        ALLOCATION_PE_SLOTS

        +
        private static final java.lang.String ALLOCATION_PE_SLOTS
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ALLOCATION_ROUND_ROBIN

        +
        private static final java.lang.String ALLOCATION_ROUND_ROBIN
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ALLOCATION_FILL_UP

        +
        private static final java.lang.String ALLOCATION_FILL_UP
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        name

        +
        private final java.lang.String name
        +
        • +
      + + + +
        +
      • +

        slots

        +
        private final int slots
        +
        • +
      + + + + + + + +
        +
      • +

        ppn

        +
        private final int ppn
        +
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        • +
      + + + +
        +
      • +

        getSlots

        +
        public int getSlots()
        +
        • +
      + + + + + + + +
        +
      • +

        getPpn

        +
        public int getPpn()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/QueueInfo.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/QueueInfo.html new file mode 100644 index 000000000..7c1b31456 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/QueueInfo.html @@ -0,0 +1,404 @@ + + + + + +QueueInfo (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+

Class QueueInfo

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.gridengine.QueueInfo
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    class QueueInfo
+extends java.lang.Object
    +
    Class that holds some info on queues used in Grid Engine.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.lang.Stringname 
      private java.lang.String[]parallelEnvironments 
      private intslots 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      QueueInfo(java.util.Map<java.lang.String,java.lang.String> info) 
      QueueInfo(java.lang.String name, + int slots, + java.lang.String... parallelEnvironments) +
      Testing constructor
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        name

        +
        private final java.lang.String name
        +
        • +
      + + + +
        +
      • +

        slots

        +
        private final int slots
        +
        • +
      + + + +
        +
      • +

        parallelEnvironments

        +
        private final java.lang.String[] parallelEnvironments
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + + + + + +
        +
      • +

        QueueInfo

        +
        QueueInfo(java.lang.String name,
+          int slots,
+          java.lang.String... parallelEnvironments)
        +
        Testing constructor
        +
        +
        Parameters:
        +
        name - name of the queue
        +
        slots - number of slots
        +
        parallelEnvironments - parallel environment names
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        • +
      + + + +
        +
      • +

        getSlots

        +
        public int getSlots()
        +
        • +
      + + + +
        +
      • +

        getParallelEnvironments

        +
        public java.lang.String[] getParallelEnvironments()
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/package-frame.html new file mode 100644 index 000000000..505209863 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/package-frame.html @@ -0,0 +1,29 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.gridengine (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.adaptors.schedulers.gridengine

+
+

Classes

+ +

Enums

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/package-summary.html new file mode 100644 index 000000000..b5aa1457b --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/package-summary.html @@ -0,0 +1,190 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.gridengine (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.adaptors.schedulers.gridengine

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/package-tree.html new file mode 100644 index 000000000..8486178b2 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/package-tree.html @@ -0,0 +1,172 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.gridengine Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.schedulers.gridengine

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Enum Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/CommandNotFoundException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/CommandNotFoundException.html new file mode 100644 index 000000000..d2ac08278 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/CommandNotFoundException.html @@ -0,0 +1,332 @@ + + + + + +CommandNotFoundException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.local
+

Class CommandNotFoundException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class CommandNotFoundException
+extends XenonException
    +
    Signals that a command could not be found.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      CommandNotFoundException(java.lang.String adaptorName, + java.lang.String message) 
      CommandNotFoundException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CommandNotFoundException

        +
        public CommandNotFoundException(java.lang.String adaptorName,
+                                java.lang.String message,
+                                java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        CommandNotFoundException

        +
        public CommandNotFoundException(java.lang.String adaptorName,
+                                java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/CommandRunner.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/CommandRunner.html new file mode 100644 index 000000000..01694c8cf --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/CommandRunner.html @@ -0,0 +1,409 @@ + + + + + +CommandRunner (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.local
+

Class CommandRunner

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.local.CommandRunner
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class CommandRunner
+extends java.lang.Object
    +
    Runs a command. Constructor waits for command to finish.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      CommandRunner(java.lang.String... command) 
      CommandRunner(java.lang.String stdin, + java.io.File workingDir, + java.lang.String... command) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private static java.lang.StringgetExeFile(java.lang.String exe) 
      intgetExitCode() 
      java.lang.StringgetStderr() 
      java.lang.StringgetStdout() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        exitCode

        +
        private final int exitCode
        +
        • +
      + + + + + + + + +
      • +
    + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getExeFile

        +
        private static java.lang.String getExeFile(java.lang.String exe)
        +
        • +
      + + + +
        +
      • +

        getStdout

        +
        public java.lang.String getStdout()
        +
        • +
      + + + +
        +
      • +

        getStderr

        +
        public java.lang.String getStderr()
        +
        • +
      + + + +
        +
      • +

        getExitCode

        +
        public int getExitCode()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalInteractiveProcess.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalInteractiveProcess.html new file mode 100644 index 000000000..2d7893c12 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalInteractiveProcess.html @@ -0,0 +1,421 @@ + + + + + +LocalInteractiveProcess (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.local
+

Class LocalInteractiveProcess

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcess
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private booleandone 
      private intexitCode 
      private java.lang.Processprocess 
      private Streamsstreams 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      LocalInteractiveProcess(JobDescription description, + java.lang.String workdir, + java.lang.String jobIdentifier) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        process

        +
        private final java.lang.Process process
        +
        • +
      + + + +
        +
      • +

        exitCode

        +
        private int exitCode
        +
        • +
      + + + +
        +
      • +

        done

        +
        private boolean done
        +
        • +
      + + + +
        +
      • +

        streams

        +
        private final Streams streams
        +
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        isDone

        +
        public boolean isDone()
        +
        +
        Specified by:
        +
        isDone in interface Process
        +
        +
        • +
      + + + +
        +
      • +

        getExitStatus

        +
        public int getExitStatus()
        +
        +
        Specified by:
        +
        getExitStatus in interface Process
        +
        +
        • +
      + + + +
        +
      • +

        destroy

        +
        public void destroy()
        +
        Destroy (stop) process. Does nothing if the process has already finished. Does not re-evaluate whether process has finished. Will run the kill command on + Unix, and Process.destroy() if that does not work or does not apply.
        +
        +
        Specified by:
        +
        destroy in interface Process
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalInteractiveProcessFactory.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalInteractiveProcessFactory.html new file mode 100644 index 000000000..55633a47b --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalInteractiveProcessFactory.html @@ -0,0 +1,362 @@ + + + + + +LocalInteractiveProcessFactory (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.local
+

Class LocalInteractiveProcessFactory

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcessFactory
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private booleanopen 
      +
      • +
    + + + + +
    • +
+
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalSchedulerAdaptor.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalSchedulerAdaptor.html new file mode 100644 index 000000000..4fa50f892 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalSchedulerAdaptor.html @@ -0,0 +1,686 @@ + + + + + +LocalSchedulerAdaptor (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.local
+

Class LocalSchedulerAdaptor

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.lang.StringADAPTOR_DESCRIPTION +
      Description of the adaptor
      +
      private static java.lang.String[]ADAPTOR_LOCATIONS +
      The locations supported by the adaptor
      +
      static java.lang.StringADAPTOR_NAME +
      Name of the local adaptor is defined in the engine.
      +
      static java.lang.StringINFO +
      Local queue information start with this prefix.
      +
      static java.lang.StringJOBS +
      Local job information start with this prefix.
      +
      static java.lang.StringMAX_HISTORY +
      Property for maximum history length for finished jobs
      +
      static java.lang.StringMULTIQ +
      Local multi queue properties start with this prefix.
      +
      static java.lang.StringMULTIQ_MAX_CONCURRENT +
      Property for the maximum number of concurrent jobs in the multi queue.
      +
      static java.lang.StringPOLLING_DELAY +
      Property for maximum history length for finished jobs
      +
      static java.lang.StringPREFIX +
      Local properties start with this prefix.
      +
      static java.lang.StringQUEUE +
      Local queue properties start with this prefix.
      +
      static java.lang.StringSUBMITTED +
      How many jobs have been submitted locally.
      +
      private static XenonPropertyDescription[]VALID_PROPERTIES +
      The properties supported by this adaptor
      +
      + +
      • +
    + + + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        ADAPTOR_NAME

        +
        public static final java.lang.String ADAPTOR_NAME
        +
        Name of the local adaptor is defined in the engine.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PREFIX

        +
        public static final java.lang.String PREFIX
        +
        Local properties start with this prefix.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ADAPTOR_DESCRIPTION

        +
        public static final java.lang.String ADAPTOR_DESCRIPTION
        +
        Description of the adaptor
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        QUEUE

        +
        public static final java.lang.String QUEUE
        +
        Local queue properties start with this prefix.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        MAX_HISTORY

        +
        public static final java.lang.String MAX_HISTORY
        +
        Property for 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
        +
        Local queue information start with this prefix.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        JOBS

        +
        public static final java.lang.String JOBS
        +
        Local 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 locally.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ADAPTOR_LOCATIONS

        +
        private static final java.lang.String[] ADAPTOR_LOCATIONS
        +
        The locations supported by the adaptor
        +
        • +
      + + + +
        +
      • +

        VALID_PROPERTIES

        +
        private static final XenonPropertyDescription[] VALID_PROPERTIES
        +
        The properties supported by this adaptor
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LocalSchedulerAdaptor

        +
        public LocalSchedulerAdaptor()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      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.
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/package-frame.html new file mode 100644 index 000000000..eeae3bb5a --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/package-frame.html @@ -0,0 +1,26 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.local (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.adaptors.schedulers.local

+
+

Classes

+ +

Exceptions

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/package-summary.html new file mode 100644 index 000000000..ba7c01b59 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/package-summary.html @@ -0,0 +1,174 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.local (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.adaptors.schedulers.local

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/package-tree.html new file mode 100644 index 000000000..13e330a47 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/package-tree.html @@ -0,0 +1,158 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.local Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.schedulers.local

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/package-frame.html new file mode 100644 index 000000000..d19d74294 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/package-frame.html @@ -0,0 +1,45 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.adaptors.schedulers

+
+

Interfaces

+ +

Classes

+ +

Exceptions

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/package-summary.html new file mode 100644 index 000000000..20c9ba83a --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/package-summary.html @@ -0,0 +1,263 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.adaptors.schedulers

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/package-tree.html new file mode 100644 index 000000000..fb5b5dade --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/package-tree.html @@ -0,0 +1,184 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.schedulers

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmScheduler.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmScheduler.html new file mode 100644 index 000000000..2d8a45b95 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmScheduler.html @@ -0,0 +1,792 @@ + + + + + +SlurmScheduler (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.slurm
+

Class SlurmScheduler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.AutoCloseable
    +
    +
    +
    +
    public class SlurmScheduler
+extends ScriptingScheduler
    +
    Interface to the GridEngine command line tools. Will run commands to submit/list/cancel jobs and get the status of queues.
    +
    +
    Since:
    +
    1.0
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        queueNames

        +
        private final java.lang.String[] queueNames
        +
        • +
      + + + +
        +
      • +

        defaultQueueName

        +
        private final java.lang.String defaultQueueName
        +
        • +
      + + + + +
      • +
    + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getQueueNames

        +
        public java.lang.String[] getQueueNames()
        +
        Description copied from class: Scheduler
        +
        Get the queue names supported by this Scheduler.
        +
        +
        Specified by:
        +
        getQueueNames in class Scheduler
        +
        Returns:
        +
        the queue names supported by this Scheduler.
        +
        +
        • +
      + + + +
        +
      • +

        getDefaultQueueName

        +
        public java.lang.String getDefaultQueueName()
        +
        Description copied from class: Scheduler
        +
        Get the name of the default queue.
        +
        +
        Specified by:
        +
        getDefaultQueueName in class Scheduler
        +
        Returns:
        +
        the name of the default queue for this scheduler, or null if no default queue is available.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        findInteractiveJobInMap

        +
        private java.lang.String findInteractiveJobInMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> queueInfo,
+                                                 java.lang.String tag)
        +
        • +
      + + + +
        +
      • +

        findInteractiveJob

        +
        private java.lang.String findInteractiveJob(java.lang.String tag)
+                                     throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + + + + + +
        +
      • +

        cancelJob

        +
        public JobStatus cancelJob(java.lang.String jobIdentifier)
+                    throws XenonException
        +
        Description copied from class: Scheduler
        +
        Cancel a job. +

        + A status is returned that indicates the state of the job after the cancel. If the job was already done it cannot be cancelled. +

        +

        + A JobStatus is returned that can be used to determine the state of the job after cancelJob returns. Note that it may take some time before the + job has actually terminated. The waitUntilDone method can be used to wait until the job is terminated. +

        +
        +
        Specified by:
        +
        cancelJob in class Scheduler
        +
        Parameters:
        +
        jobIdentifier - the identifier of job to kill.
        +
        Returns:
        +
        the status of the Job.
        +
        Throws:
        +
        NoSuchJobException - If the job is not known.
        +
        XenonException - If the status of the job could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        getJobs

        +
        public java.lang.String[] getJobs(java.lang.String... queueNames)
+                           throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get all job identifier of jobs currently in (one ore more) queues. + + If no queue names are specified, the job identifiers for all queues are returned. + + Note that job identifiers of jobs submitted by other users or other schedulers may also be returned.
        +
        +
        Specified by:
        +
        getJobs in class Scheduler
        +
        Parameters:
        +
        queueNames - the names of the queues.
        +
        Returns:
        +
        an array containing the resulting job identifiers .
        +
        Throws:
        +
        NotConnectedException - If scheduler is closed.
        +
        NoSuchQueueException - If the queue does not exist in the scheduler.
        +
        XenonException - If the Scheduler failed to get jobs.
        +
        +
        • +
      + + + +
        +
      • +

        getSControlInfo

        +
        private java.util.Map<java.lang.String,java.lang.String> getSControlInfo(java.lang.String jobIdentifier)
+                                                                  throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        getSqueueInfo

        +
        private java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getSqueueInfo(java.lang.String... jobs)
+                                                                                                throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        getSinfoInfo

        +
        private java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getSinfoInfo(java.lang.String... partitions)
+                                                                                               throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        getSacctInfo

        +
        private java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getSacctInfo(java.lang.String... jobs)
+                                                                                               throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        getJobStatus

        +
        public JobStatus getJobStatus(java.lang.String jobIdentifier)
+                       throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get the status of a Job.
        +
        +
        Specified by:
        +
        getJobStatus in class Scheduler
        +
        Parameters:
        +
        jobIdentifier - the job identifier of the job to get the status for.
        +
        Returns:
        +
        the status of the Job.
        +
        Throws:
        +
        NoSuchJobException - If the job is not known.
        +
        XenonException - If the status of the job could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        getQueueStatus

        +
        public QueueStatus getQueueStatus(java.lang.String queueName)
+                           throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get the status of the queue.
        +
        +
        Specified by:
        +
        getQueueStatus in class Scheduler
        +
        Parameters:
        +
        queueName - the name of the queue.
        +
        Returns:
        +
        the resulting QueueStatus.
        +
        Throws:
        +
        NoSuchQueueException - If the queue does not exist in the scheduler.
        +
        XenonException - If the Scheduler failed to get its status.
        +
        +
        • +
      + + + +
        +
      • +

        getQueueStatuses

        +
        public QueueStatus[] getQueueStatuses(java.lang.String... requestedQueueNames)
+                               throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get the status of all queues. + + Note that this method will only throw an exception when this exception will influence all status requests. For example, if the scheduler is no longer + connected. + + Exceptions that only refer to a single queue are returned in the QueueStatus returned for that queue.
        +
        +
        Specified by:
        +
        getQueueStatuses in class Scheduler
        +
        Parameters:
        +
        requestedQueueNames - the names of the queues.
        +
        Returns:
        +
        an array containing the resulting QueueStatus.
        +
        Throws:
        +
        XenonException - If the Scheduler failed to get the statuses.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmSchedulerAdaptor.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmSchedulerAdaptor.html new file mode 100644 index 000000000..db0d6c751 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmSchedulerAdaptor.html @@ -0,0 +1,570 @@ + + + + + +SlurmSchedulerAdaptor (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.slurm
+

Class SlurmSchedulerAdaptor

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        ADAPTOR_NAME

        +
        public static final java.lang.String ADAPTOR_NAME
        +
        The name of this adaptor
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PREFIX

        +
        public static final java.lang.String PREFIX
        +
        The prefix used by all properties related to this adaptor
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        DISABLE_ACCOUNTING_USAGE

        +
        public static final java.lang.String DISABLE_ACCOUNTING_USAGE
        +
        Should the accounting usage be disabled?
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        POLL_DELAY_PROPERTY

        +
        public static final java.lang.String POLL_DELAY_PROPERTY
        +
        Polling delay for jobs started by this adaptor.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ADAPTOR_DESCRIPTION

        +
        public static final java.lang.String ADAPTOR_DESCRIPTION
        +
        Human readable description of this adaptor
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        SLURM_UPDATE_TIMEOUT

        +
        public static final long SLURM_UPDATE_TIMEOUT
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        SLURM_UPDATE_SLEEP

        +
        public static final long SLURM_UPDATE_SLEEP
        +
        +
        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 all properties supported by this adaptor
        +
        • +
      + + + +
        +
      • +

        SUPPORTED_VERSIONS

        +
        protected static final java.lang.String[] SUPPORTED_VERSIONS
        +
        • +
      +
      • +
    + + + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmSetup.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmSetup.html new file mode 100644 index 000000000..891a8afcf --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmSetup.html @@ -0,0 +1,367 @@ + + + + + +SlurmSetup (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.slurm
+

Class SlurmSetup

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSetup
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class SlurmSetup
+extends java.lang.Object
    +
    +
    Since:
    +
    1.0
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private booleanaccountingAvailable 
      private static org.slf4j.LoggerLOGGER 
      private java.lang.Stringversion 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      SlurmSetup(java.util.Map<java.lang.String,java.lang.String> info, + boolean disableAccounting) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        accountingAvailable

        +
        private final boolean accountingAvailable
        +
        • +
      + + + +
        +
      • +

        version

        +
        private final java.lang.String version
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SlurmSetup

        +
        SlurmSetup(java.util.Map<java.lang.String,java.lang.String> info,
+           boolean disableAccounting)
+    throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        checkVersion

        +
        public boolean checkVersion()
        +
        • +
      + + + +
        +
      • +

        accountingAvailable

        +
        public boolean accountingAvailable()
        +
        • +
      + + + +
        +
      • +

        version

        +
        public java.lang.String version()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmUtils.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmUtils.html new file mode 100644 index 000000000..ba51d0a34 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmUtils.html @@ -0,0 +1,690 @@ + + + + + +SlurmUtils (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.slurm
+

Class SlurmUtils

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public final class SlurmUtils
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static java.lang.StringDONE_STATE +
      In completed state, the job has terminated and all processes have returned exit code 0.
      +
      private static java.lang.String[]FAILED_STATES +
      These are the states a job can be in when it has failed: FAILED: the job terminated with non-zero exit code or other failure condition.
      +
      static java.lang.StringJOB_OPTION_JOB_SCRIPT 
      private static org.slf4j.LoggerLOGGER 
      private static java.lang.String[]PENDING_STATES +
      These are the states a job can be in when it is pending: + + PENDING: the job is awaiting resource allocation.
      +
      private static java.lang.String[]RUNNING_STATES +
      These are the states a job can be in when it is running: + + CONFIGURING: the resources are available and being preparing to run the job (for example by booting).
      +
      private static java.lang.String[]VALID_JOB_OPTIONS 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      private SlurmUtils() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected static java.lang.IntegerexitcodeFromString(java.lang.String value) 
      static java.lang.Stringgenerate(JobDescription description, + Path fsEntryPath) 
      static java.lang.String[]generateInteractiveArguments(JobDescription description, + Path fsEntryPath, + java.util.UUID tag) 
      protected static JobStatusgetJobStatusFromSacctInfo(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> info, + java.lang.String jobIdentifier) 
      protected static JobStatusgetJobStatusFromScontrolInfo(java.util.Map<java.lang.String,java.lang.String> jobInfo, + java.lang.String jobIdentifier) 
      protected static JobStatusgetJobStatusFromSqueueInfo(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> info, + java.lang.String jobIdentifier) 
      protected static QueueStatusgetQueueStatusFromSInfo(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> info, + java.lang.String queueName, + Scheduler scheduler) 
      private static java.lang.StringgetWorkingDirPath(JobDescription description, + Path fsEntryPath) 
      protected static java.lang.StringidentifiersAsCSList(java.lang.String[] jobs) 
      protected static booleanisDoneOrFailedState(java.lang.String state) +
      Is the given state a done or failed state ?
      +
      protected static booleanisDoneState(java.lang.String state) +
      Is the given state a done state ?
      +
      protected static booleanisFailedState(java.lang.String state) +
      Is the given state a failed state ?
      +
      protected static booleanisPendingState(java.lang.String state) +
      Is the given state a pending state ?
      +
      protected static booleanisRunningState(java.lang.String state) +
      Is the given state a running state ?
      +
      protected static voidverifyJobDescription(JobDescription description, + boolean interactive) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        JOB_OPTION_JOB_SCRIPT

        +
        public static final java.lang.String JOB_OPTION_JOB_SCRIPT
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        VALID_JOB_OPTIONS

        +
        private static final java.lang.String[] VALID_JOB_OPTIONS
        +
        • +
      + + + +
        +
      • +

        FAILED_STATES

        +
        private static final java.lang.String[] FAILED_STATES
        +
        These are the states a job can be in when it has failed: FAILED: the job terminated with non-zero exit code or other failure condition. CANCELLED: the + job was explicitly cancelled by the user or system administrator. NODE_FAIL: the job terminated due to failure of one or more allocated nodes. TIMEOUT: + the job terminated upon reaching its time limit. PREEMPTED: the job terminated due to preemption (a more important job took its place). BOOT_FAIL: the + job terminated due to a launch failure (typically a hardware failure).
        +
        • +
      + + + +
        +
      • +

        RUNNING_STATES

        +
        private static final java.lang.String[] RUNNING_STATES
        +
        These are the states a job can be in when it is running: + + CONFIGURING: the resources are available and being preparing to run the job (for example by booting). RUNNING: the resources are running the job. + COMPLETING: the job is in process of completing. Some processes may have completed, others may still be running.
        +
        • +
      + + + +
        +
      • +

        PENDING_STATES

        +
        private static final java.lang.String[] PENDING_STATES
        +
        These are the states a job can be in when it is pending: + + PENDING: the job is awaiting resource allocation. STOPPED: the job has an allocation, but execution has been stopped with SIGSTOP signal (allocation is + retained). SUSPENDED: the job has an allocation, but execution has been suspended (resources have been released for other jobs). SPECIAL_EXIT: The job + was requeued in a special state.
        +
        • +
      + + + +
        +
      • +

        DONE_STATE

        +
        private static final java.lang.String DONE_STATE
        +
        In completed state, the job has terminated and all processes have returned exit code 0.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SlurmUtils

        +
        private SlurmUtils()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        identifiersAsCSList

        +
        protected static java.lang.String identifiersAsCSList(java.lang.String[] jobs)
        +
        • +
      + + + +
        +
      • +

        exitcodeFromString

        +
        protected static java.lang.Integer exitcodeFromString(java.lang.String value)
+                                               throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        getJobStatusFromSacctInfo

        +
        protected static JobStatus getJobStatusFromSacctInfo(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> info,
+                                                     java.lang.String jobIdentifier)
+                                              throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        getJobStatusFromScontrolInfo

        +
        protected static JobStatus getJobStatusFromScontrolInfo(java.util.Map<java.lang.String,java.lang.String> jobInfo,
+                                                        java.lang.String jobIdentifier)
+                                                 throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        getJobStatusFromSqueueInfo

        +
        protected static JobStatus getJobStatusFromSqueueInfo(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> info,
+                                                      java.lang.String jobIdentifier)
+                                               throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        getQueueStatusFromSInfo

        +
        protected static QueueStatus getQueueStatusFromSInfo(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> info,
+                                                     java.lang.String queueName,
+                                                     Scheduler scheduler)
        +
        • +
      + + + +
        +
      • +

        isRunningState

        +
        protected static boolean isRunningState(java.lang.String state)
        +
        Is the given state a running state ?
        +
        +
        Parameters:
        +
        state - the state to check
        +
        Returns:
        +
        if the state is a running state.
        +
        +
        • +
      + + + +
        +
      • +

        isPendingState

        +
        protected static boolean isPendingState(java.lang.String state)
        +
        Is the given state a pending state ?
        +
        +
        Parameters:
        +
        state - the state to check
        +
        Returns:
        +
        if the state is a pending state.
        +
        +
        • +
      + + + +
        +
      • +

        isDoneOrFailedState

        +
        protected static boolean isDoneOrFailedState(java.lang.String state)
        +
        Is the given state a done or failed state ?
        +
        +
        Parameters:
        +
        state - the state to check
        +
        Returns:
        +
        if the state is a done or failed state.
        +
        +
        • +
      + + + +
        +
      • +

        isDoneState

        +
        protected static boolean isDoneState(java.lang.String state)
        +
        Is the given state a done state ?
        +
        +
        Parameters:
        +
        state - the state to check
        +
        Returns:
        +
        if the state is a done state.
        +
        +
        • +
      + + + +
        +
      • +

        isFailedState

        +
        protected static boolean isFailedState(java.lang.String state)
        +
        Is the given state a failed state ?
        +
        +
        Parameters:
        +
        state - the state to check
        +
        Returns:
        +
        if the state is failed state.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getWorkingDirPath

        +
        private static java.lang.String getWorkingDirPath(JobDescription description,
+                                                  Path fsEntryPath)
        +
        • +
      + + + +
        +
      • +

        generateInteractiveArguments

        +
        public static java.lang.String[] generateInteractiveArguments(JobDescription description,
+                                                              Path fsEntryPath,
+                                                              java.util.UUID tag)
        +
        • +
      + + + +
        +
      • +

        generate

        +
        public static java.lang.String generate(JobDescription description,
+                                        Path fsEntryPath)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/package-frame.html new file mode 100644 index 000000000..48b6d101d --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/package-frame.html @@ -0,0 +1,22 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.slurm (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.adaptors.schedulers.slurm

+
+

Classes

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/package-summary.html new file mode 100644 index 000000000..278532093 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/package-summary.html @@ -0,0 +1,155 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.slurm (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.adaptors.schedulers.slurm

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/package-tree.html new file mode 100644 index 000000000..5da75cf27 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/package-tree.html @@ -0,0 +1,157 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.slurm Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.schedulers.slurm

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshInteractiveProcess.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshInteractiveProcess.html new file mode 100644 index 000000000..a48e21ad8 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshInteractiveProcess.html @@ -0,0 +1,454 @@ + + + + + +SshInteractiveProcess (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.ssh
+

Class SshInteractiveProcess

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcess
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private org.apache.sshd.client.channel.ChannelExecchannel 
      private booleandone 
      private static org.slf4j.LoggerLOGGER 
      private org.apache.sshd.client.session.ClientSessionsession 
      private Streamsstreams 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      SshInteractiveProcess(org.apache.sshd.client.session.ClientSession session, + JobDescription description, + java.lang.String jobIdentifier, + long timeoutInMillis) 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        session

        +
        private final org.apache.sshd.client.session.ClientSession session
        +
        • +
      + + + +
        +
      • +

        channel

        +
        private final org.apache.sshd.client.channel.ChannelExec channel
        +
        • +
      + + + +
        +
      • +

        streams

        +
        private final Streams streams
        +
        • +
      + + + +
        +
      • +

        done

        +
        private boolean done
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SshInteractiveProcess

        +
        SshInteractiveProcess(org.apache.sshd.client.session.ClientSession session,
+                      JobDescription description,
+                      java.lang.String jobIdentifier,
+                      long timeoutInMillis)
+               throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      +
      • +
    + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshInteractiveProcessFactory.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshInteractiveProcessFactory.html new file mode 100644 index 000000000..0c5258641 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshInteractiveProcessFactory.html @@ -0,0 +1,364 @@ + + + + + +SshInteractiveProcessFactory (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.ssh
+

Class SshInteractiveProcessFactory

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcessFactory
      • +
    +
    • +
+
+ +
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshSchedulerAdaptor.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshSchedulerAdaptor.html new file mode 100644 index 000000000..0ae475efd --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshSchedulerAdaptor.html @@ -0,0 +1,892 @@ + + + + + +SshSchedulerAdaptor (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.ssh
+

Class SshSchedulerAdaptor

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.lang.StringADAPTOR_DESCRIPTION +
      A description of this adaptor
      +
      private static java.lang.String[]ADAPTOR_LOCATIONS +
      The locations supported by this adaptor
      +
      static java.lang.StringADAPTOR_NAME +
      The name of this adaptor
      +
      static java.lang.StringAGENT +
      Enable the use of an ssh-agent
      +
      static java.lang.StringAGENT_FORWARDING +
      Enable the use of ssh-agent-forwarding
      +
      static java.lang.StringAUTOMATICALLY_ADD_HOST_KEY +
      Enable strict host key checking.
      +
      static intDEFAULT_PORT +
      The default SSH port
      +
      static java.lang.StringGATEWAY +
      Add gateway to access machine.
      +
      static java.lang.StringINFO +
      Ssh adaptor information start with this prefix.
      +
      static java.lang.StringJOBS +
      Ssh job information start with this prefix.
      +
      static java.lang.StringLOAD_SSH_CONFIG +
      Load the OpenSSH config file by default.
      +
      static java.lang.StringLOAD_STANDARD_KNOWN_HOSTS +
      Load the known_hosts file by default.
      +
      private static org.slf4j.LoggerLOGGER 
      static java.lang.StringMAX_HISTORY +
      Maximum history length for finished jobs
      +
      static java.lang.StringMULTIQ +
      Local multi queue properties start with this prefix.
      +
      static java.lang.StringMULTIQ_MAX_CONCURRENT +
      Property for the maximum number of concurrent jobs in the multi queue.
      +
      static java.lang.StringPOLLING_DELAY +
      Property for maximum history length for finished jobs
      +
      static java.lang.StringPREFIX +
      All our own properties start with this prefix.
      +
      static java.lang.StringQUEUE +
      All our own queue properties start with this prefix.
      +
      static java.lang.StringSSH_CONFIG_FILE +
      OpenSSH config filename.
      +
      static java.lang.StringSTRICT_HOST_KEY_CHECKING +
      Enable strict host key checking.
      +
      static java.lang.StringSUBMITTED +
      How many jobs have been submitted using this adaptor.
      +
      static java.lang.StringTIMEOUT +
      Add gateway to access machine.
      +
      private static XenonPropertyDescription[]VALID_PROPERTIES +
      List of properties supported by this SSH adaptor
      +
      + +
      • +
    + + + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      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.
        +
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/package-frame.html new file mode 100644 index 000000000..abdf5d5b2 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/package-frame.html @@ -0,0 +1,21 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.ssh (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.adaptors.schedulers.ssh

+
+

Classes

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/package-summary.html new file mode 100644 index 000000000..72e4b9273 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/package-summary.html @@ -0,0 +1,149 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.ssh (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.adaptors.schedulers.ssh

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/package-tree.html new file mode 100644 index 000000000..e4b0365ea --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/package-tree.html @@ -0,0 +1,144 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.ssh Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.schedulers.ssh

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueScheduler.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueScheduler.html new file mode 100644 index 000000000..6e42908f2 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueScheduler.html @@ -0,0 +1,874 @@ + + + + + +TorqueScheduler (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.torque
+

Class TorqueScheduler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.AutoCloseable
    +
    +
    +
    +
    public class TorqueScheduler
+extends ScriptingScheduler
    +
    Interface to the TORQUE command line tools. Will run commands to submit/list/cancel jobs and get the status of queues.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        accountingGraceTime

        +
        private final long accountingGraceTime
        +
        • +
      + + + +
        +
      • +

        lastSeenMap

        +
        private final java.util.Map<java.lang.String,java.lang.Long> lastSeenMap
        +
        Map with the last seen time of jobs. There is a delay between jobs disappearing from the qstat queue output. Instead of throwing an exception, we allow + for a certain grace time. Jobs will report the status "pending" during this time. Typical delays are in the order of seconds.
        +
        • +
      + + + +
        +
      • +

        deletedJobs

        +
        private final java.util.Set<java.lang.String> deletedJobs
        +
        • +
      + + + + + + + +
        +
      • +

        queueNames

        +
        private final java.lang.String[] queueNames
        +
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getQueueNames

        +
        public java.lang.String[] getQueueNames()
        +
        Description copied from class: Scheduler
        +
        Get the queue names supported by this Scheduler.
        +
        +
        Specified by:
        +
        getQueueNames in class Scheduler
        +
        Returns:
        +
        the queue names supported by this Scheduler.
        +
        +
        • +
      + + + +
        +
      • +

        getDefaultQueueName

        +
        public java.lang.String getDefaultQueueName()
        +
        Description copied from class: Scheduler
        +
        Get the name of the default queue.
        +
        +
        Specified by:
        +
        getDefaultQueueName in class Scheduler
        +
        Returns:
        +
        the name of the default queue for this scheduler, or null if no default queue is available.
        +
        +
        • +
      + + + +
        +
      • +

        updateJobsSeenMap

        +
        private void updateJobsSeenMap(java.util.Set<java.lang.String> identifiers)
        +
        • +
      + + + +
        +
      • +

        haveRecentlySeen

        +
        private boolean haveRecentlySeen(java.lang.String identifier)
        +
        • +
      + + + +
        +
      • +

        addDeletedJob

        +
        private void addDeletedJob(java.lang.String jobIdentifier)
        +
        • +
      + + + +
        +
      • +

        jobWasDeleted

        +
        private boolean jobWasDeleted(java.lang.String jobIdentifier)
        +
        • +
      + + + +
        +
      • +

        jobsFromStatus

        +
        private void jobsFromStatus(java.lang.String statusOutput,
+                            java.util.List<java.lang.String> result)
+                     throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        getJobs

        +
        public java.lang.String[] getJobs(java.lang.String... queueNames)
+                           throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get all job identifier of jobs currently in (one ore more) queues. + + If no queue names are specified, the job identifiers for all queues are returned. + + Note that job identifiers of jobs submitted by other users or other schedulers may also be returned.
        +
        +
        Specified by:
        +
        getJobs in class Scheduler
        +
        Parameters:
        +
        queueNames - the names of the queues.
        +
        Returns:
        +
        an array containing the resulting job identifiers .
        +
        Throws:
        +
        NotConnectedException - If scheduler is closed.
        +
        NoSuchQueueException - If the queue does not exist in the scheduler.
        +
        XenonException - If the Scheduler failed to get jobs.
        +
        +
        • +
      + + + +
        +
      • +

        getQueueStatus

        +
        public QueueStatus getQueueStatus(java.lang.String queueName)
+                           throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get the status of the queue.
        +
        +
        Specified by:
        +
        getQueueStatus in class Scheduler
        +
        Parameters:
        +
        queueName - the name of the queue.
        +
        Returns:
        +
        the resulting QueueStatus.
        +
        Throws:
        +
        NoSuchQueueException - If the queue does not exist in the scheduler.
        +
        XenonException - If the Scheduler failed to get its status.
        +
        +
        • +
      + + + +
        +
      • +

        getQueueStatuses

        +
        public QueueStatus[] getQueueStatuses(java.lang.String... queueNames)
+                               throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get the status of all queues. + + Note that this method will only throw an exception when this exception will influence all status requests. For example, if the scheduler is no longer + connected. + + Exceptions that only refer to a single queue are returned in the QueueStatus returned for that queue.
        +
        +
        Specified by:
        +
        getQueueStatuses in class Scheduler
        +
        Parameters:
        +
        queueNames - the names of the queues.
        +
        Returns:
        +
        an array containing the resulting QueueStatus.
        +
        Throws:
        +
        XenonException - If the Scheduler failed to get the statuses.
        +
        +
        • +
      + + + +
        +
      • +

        queryQueues

        +
        protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> queryQueues(java.lang.String... queueNames)
+                                                                                                throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        cancelJob

        +
        public JobStatus cancelJob(java.lang.String jobIdentifier)
+                    throws XenonException
        +
        Description copied from class: Scheduler
        +
        Cancel a job. +

        + A status is returned that indicates the state of the job after the cancel. If the job was already done it cannot be cancelled. +

        +

        + A JobStatus is returned that can be used to determine the state of the job after cancelJob returns. Note that it may take some time before the + job has actually terminated. The waitUntilDone method can be used to wait until the job is terminated. +

        +
        +
        Specified by:
        +
        cancelJob in class Scheduler
        +
        Parameters:
        +
        jobIdentifier - the identifier of job to kill.
        +
        Returns:
        +
        the status of the Job.
        +
        Throws:
        +
        NoSuchJobException - If the job is not known.
        +
        XenonException - If the status of the job could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        getQstatInfo

        +
        private java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getQstatInfo()
+                                                                                               throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        getJobStatus

        +
        private JobStatus getJobStatus(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> qstatInfo,
+                               java.lang.String job)
+                        throws XenonException
        +
        Get job status. First checks given qstat info map, but also runs additional qacct and qdel commands if needed.
        +
        +
        Parameters:
        +
        qstatInfo - the info to get the job status from.
        +
        job - the job to get the status for.
        +
        Returns:
        +
        the JobStatus of the job.
        +
        Throws:
        +
        XenonException - in case the info is not valid.
        +
        XenonException - in case an additional command fails to run.
        +
        +
        • +
      + + + +
        +
      • +

        getJobStatus

        +
        public JobStatus getJobStatus(java.lang.String jobIdentifier)
+                       throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get the status of a Job.
        +
        +
        Specified by:
        +
        getJobStatus in class Scheduler
        +
        Parameters:
        +
        jobIdentifier - the job identifier of the job to get the status for.
        +
        Returns:
        +
        the status of the Job.
        +
        Throws:
        +
        NoSuchJobException - If the job is not known.
        +
        XenonException - If the status of the job could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        getJobStatuses

        +
        public JobStatus[] getJobStatuses(java.lang.String... jobs)
+                           throws XenonException
        +
        Description copied from class: Scheduler
        +
        Get the status of all specified jobs. +

        + The array of JobStatus contains one entry for each of the jobs. The order of the elements in the returned + JobStatus array corresponds to the order in which the jobs are passed as parameters. If a job is + null, the corresponding entry in the JobStatus array will also be null. If the retrieval of the + JobStatus fails for a job, the exception will be stored in the corresponding JobsStatus entry. +

        +
        +
        Overrides:
        +
        getJobStatuses in class Scheduler
        +
        Parameters:
        +
        jobs - the job identifiers for which to retrieve the status.
        +
        Returns:
        +
        an array of the resulting JobStatuses.
        +
        Throws:
        +
        XenonException - If an I/O error occurred
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueSchedulerAdaptor.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueSchedulerAdaptor.html new file mode 100644 index 000000000..2576961ff --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueSchedulerAdaptor.html @@ -0,0 +1,518 @@ + + + + + +TorqueSchedulerAdaptor (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.torque
+

Class TorqueSchedulerAdaptor

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        ADAPTOR_NAME

        +
        public static final java.lang.String ADAPTOR_NAME
        +
        The name of this adaptor
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        PREFIX

        +
        public static final java.lang.String PREFIX
        +
        The prefix used by all properties related to this adaptor
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        IGNORE_VERSION_PROPERTY

        +
        public static final java.lang.String IGNORE_VERSION_PROPERTY
        +
        Should the grid engine version on the target machine be ignored ?
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ACCOUNTING_GRACE_TIME_PROPERTY

        +
        public static final java.lang.String ACCOUNTING_GRACE_TIME_PROPERTY
        +
        Timeout for waiting for the accounting info of a job to appear
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        POLL_DELAY_PROPERTY

        +
        public static final java.lang.String POLL_DELAY_PROPERTY
        +
        Polling delay for jobs started by this adaptor.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        ADAPTOR_DESCRIPTION

        +
        public static final java.lang.String ADAPTOR_DESCRIPTION
        +
        Human readable description of 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 all properties supported by this adaptor
        +
        • +
      +
      • +
    + + + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueUtils.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueUtils.html new file mode 100644 index 000000000..14acf37e6 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueUtils.html @@ -0,0 +1,456 @@ + + + + + +TorqueUtils (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.torque
+

Class TorqueUtils

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueUtils
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    final class TorqueUtils
+extends java.lang.Object
    +
    Generator for GridEngine job script.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        MINUTES_PER_HOUR

        +
        private static final int MINUTES_PER_HOUR
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        QUEUE_INFO_NAME

        +
        public static final java.util.regex.Pattern QUEUE_INFO_NAME
        +
        • +
      + + + +
        +
      • +

        JOB_OPTION_JOB_SCRIPT

        +
        public static final java.lang.String JOB_OPTION_JOB_SCRIPT
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        JOB_OPTION_JOB_CONTENTS

        +
        public static final java.lang.String JOB_OPTION_JOB_CONTENTS
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        JOB_OPTION_RESOURCES

        +
        public static final java.lang.String JOB_OPTION_RESOURCES
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        VALID_JOB_OPTIONS

        +
        private static final java.lang.String[] VALID_JOB_OPTIONS
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TorqueUtils

        +
        private TorqueUtils()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getJobStatusFromQstatInfo

        +
        protected static JobStatus getJobStatusFromQstatInfo(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> info,
+                                                     java.lang.String jobIdentifier)
+                                              throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        generateScriptContent

        +
        public static void generateScriptContent(JobDescription description,
+                                         java.util.Formatter script)
        +
        • +
      + + + +
        +
      • +

        generate

        +
        public static java.lang.String generate(JobDescription description,
+                                        Path workdir)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueXmlParser.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueXmlParser.html new file mode 100644 index 000000000..8dc8b777a --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueXmlParser.html @@ -0,0 +1,382 @@ + + + + + +TorqueXmlParser (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.schedulers.torque
+

Class TorqueXmlParser

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueXmlParser
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    final class TorqueXmlParser
+extends java.lang.Object
    +
    Parses xml output from TORQUE batch system.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private javax.xml.parsers.DocumentBuilderdocumentBuilder 
      private static org.slf4j.LoggerLOGGER 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      TorqueXmlParser() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected org.w3c.dom.DocumentparseDocument(java.lang.String data) 
      protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>parseJobInfos(java.lang.String data) +
      Parses job info from "qstat -x"
      +
      protected voidrecursiveMapFromElement(org.w3c.dom.Node root, + java.util.Map<java.lang.String,java.lang.String> result) +
      Create a Map from the tag names and text values of child nodes.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        documentBuilder

        +
        private final javax.xml.parsers.DocumentBuilder documentBuilder
        +
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        parseDocument

        +
        protected org.w3c.dom.Document parseDocument(java.lang.String data)
+                                      throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        recursiveMapFromElement

        +
        protected void recursiveMapFromElement(org.w3c.dom.Node root,
+                                       java.util.Map<java.lang.String,java.lang.String> result)
        +
        Create a Map from the tag names and text values of child nodes. + If a child node also has tags, those tags and their text values will also + be added. If multiple of the same tag names occur, the value of the last + occurrence will be stored.
        +
        +
        Parameters:
        +
        root - XML element of which the children will be added to the map
        +
        result - a mutable map that will have added to it tag names as keys and text values as values
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if root is not an XML element
        +
        +
        • +
      + + + +
        +
      • +

        parseJobInfos

        +
        protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> parseJobInfos(java.lang.String data)
+                                                                                                  throws XenonException
        +
        Parses job info from "qstat -x"
        +
        +
        Parameters:
        +
        data - the stream to get the xml data from
        +
        Returns:
        +
        a list containing all queue names found
        +
        Throws:
        +
        XenonException - if the file could not be parsed
        +
        XenonException - if the server version is not compatible with this adaptor
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/package-frame.html new file mode 100644 index 000000000..548adc2c3 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/package-frame.html @@ -0,0 +1,22 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.torque (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.adaptors.schedulers.torque

+
+

Classes

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/package-summary.html new file mode 100644 index 000000000..3517c15f7 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/package-summary.html @@ -0,0 +1,159 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.torque (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.adaptors.schedulers.torque

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    TorqueScheduler +
    Interface to the TORQUE command line tools.
    +
    TorqueSchedulerAdaptor +
    Adaptor for TORQUE batch system.
    +
    TorqueUtils +
    Generator for GridEngine job script.
    +
    TorqueXmlParser +
    Parses xml output from TORQUE batch system.
    +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/package-tree.html new file mode 100644 index 000000000..c204b2b4a --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/package-tree.html @@ -0,0 +1,157 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.torque Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.schedulers.torque

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/CertificateNotFoundException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/CertificateNotFoundException.html new file mode 100644 index 000000000..b9afea323 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/CertificateNotFoundException.html @@ -0,0 +1,330 @@ + + + + + +CertificateNotFoundException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.shared.ssh
+

Class CertificateNotFoundException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class CertificateNotFoundException
+extends XenonException
    +
    Signals that a certificate file could not be found.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      CertificateNotFoundException(java.lang.String adaptorName, + java.lang.String message) 
      CertificateNotFoundException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CertificateNotFoundException

        +
        public CertificateNotFoundException(java.lang.String adaptorName,
+                                    java.lang.String message,
+                                    java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        CertificateNotFoundException

        +
        public CertificateNotFoundException(java.lang.String adaptorName,
+                                    java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/CredentialNotFoundException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/CredentialNotFoundException.html new file mode 100644 index 000000000..bfcb11d09 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/CredentialNotFoundException.html @@ -0,0 +1,330 @@ + + + + + +CredentialNotFoundException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.shared.ssh
+

Class CredentialNotFoundException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class CredentialNotFoundException
+extends XenonException
    +
    Signals that a credential could not be found.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      CredentialNotFoundException(java.lang.String adaptorName, + java.lang.String message) 
      CredentialNotFoundException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CredentialNotFoundException

        +
        public CredentialNotFoundException(java.lang.String adaptorName,
+                                   java.lang.String message,
+                                   java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        CredentialNotFoundException

        +
        public CredentialNotFoundException(java.lang.String adaptorName,
+                                   java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHConnection.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHConnection.html new file mode 100644 index 000000000..c6fd8c9eb --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHConnection.html @@ -0,0 +1,454 @@ + + + + + +SSHConnection (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.shared.ssh
+

Class SSHConnection

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.shared.ssh.SSHConnection
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.AutoCloseable
    +
    +
    +
    +
    public class SSHConnection
+extends java.lang.Object
+implements java.lang.AutoCloseable
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private booleanclosed 
      private inthops 
      private org.apache.sshd.client.session.ClientSessionsession 
      private org.apache.sshd.client.session.ClientSession[]sessions 
      private SSHUtil.Tunnel[]tunnels 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected SSHConnection(int hops) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected voidaddHop(int hop, + org.apache.sshd.client.session.ClientSession session, + SSHUtil.Tunnel tunnel) 
      voidclose() 
      org.apache.sshd.client.subsystem.sftp.SftpClientcreateSftpClient() 
      org.apache.sshd.client.session.ClientSessiongetSession() 
      booleanisClosed() 
      booleanisOpen() 
      protected voidsetSession(org.apache.sshd.client.session.ClientSession session) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        sessions

        +
        private org.apache.sshd.client.session.ClientSession[] sessions
        +
        • +
      + + + + + + + +
        +
      • +

        hops

        +
        private final int hops
        +
        • +
      + + + +
        +
      • +

        closed

        +
        private boolean closed
        +
        • +
      + + + +
        +
      • +

        session

        +
        private org.apache.sshd.client.session.ClientSession session
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SSHConnection

        +
        protected SSHConnection(int hops)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addHop

        +
        protected void addHop(int hop,
+                      org.apache.sshd.client.session.ClientSession session,
+                      SSHUtil.Tunnel tunnel)
        +
        • +
      + + + +
        +
      • +

        setSession

        +
        protected void setSession(org.apache.sshd.client.session.ClientSession session)
        +
        • +
      + + + +
        +
      • +

        createSftpClient

        +
        public org.apache.sshd.client.subsystem.sftp.SftpClient createSftpClient()
+                                                                  throws java.io.IOException
        +
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      + + + +
        +
      • +

        getSession

        +
        public org.apache.sshd.client.session.ClientSession getSession()
        +
        • +
      + + + +
        +
      • +

        isClosed

        +
        public boolean isClosed()
        +
        • +
      + + + +
        +
      • +

        isOpen

        +
        public boolean isOpen()
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.PasswordProvider.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.PasswordProvider.html new file mode 100644 index 000000000..75a053ced --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.PasswordProvider.html @@ -0,0 +1,334 @@ + + + + + +SSHUtil.PasswordProvider (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.shared.ssh
+

Class SSHUtil.PasswordProvider

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil.PasswordProvider
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    org.apache.sshd.common.config.keys.FilePasswordProvider
    +
    +
    +
    Enclosing class:
    +
    SSHUtil
    +
    +
    +
    +
    static class SSHUtil.PasswordProvider
+extends java.lang.Object
+implements org.apache.sshd.common.config.keys.FilePasswordProvider
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private char[]password 
      +
        +
      • + + +

        Fields inherited from interface org.apache.sshd.common.config.keys.FilePasswordProvider

        +EMPTY
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      PasswordProvider(char[] password) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetPassword(java.lang.String resourceKey) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface org.apache.sshd.common.config.keys.FilePasswordProvider

        +of
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        password

        +
        private final char[] password
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PasswordProvider

        +
        public PasswordProvider(char[] password)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPassword

        +
        public java.lang.String getPassword(java.lang.String resourceKey)
+                             throws java.io.IOException
        +
        +
        Specified by:
        +
        getPassword in interface org.apache.sshd.common.config.keys.FilePasswordProvider
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.Tunnel.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.Tunnel.html new file mode 100644 index 000000000..2792a57a6 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.Tunnel.html @@ -0,0 +1,447 @@ + + + + + +SSHUtil.Tunnel (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.shared.ssh
+

Class SSHUtil.Tunnel

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Thread
      • +
    • +
        +
      • nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil.Tunnel
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Runnable
    +
    +
    +
    Enclosing class:
    +
    SSHUtil
    +
    +
    +
    +
    static class SSHUtil.Tunnel
+extends java.lang.Thread
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class java.lang.Thread

        +java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private intbufferSize 
      private org.apache.sshd.client.channel.ChannelDirectTcpipchannel 
      private java.lang.Exceptionex 
      private java.net.ServerSocketserver 
      private java.net.Socketsocket 
      +
        +
      • + + +

        Fields inherited from class java.lang.Thread

        +MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Tunnel(java.net.ServerSocket ss, + org.apache.sshd.client.channel.ChannelDirectTcpip tmp, + int bufferSize) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidclose() 
      private voidcloseServer() 
      java.lang.ExceptiongetException() 
      voidrun() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Thread

        +activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        server

        +
        private final java.net.ServerSocket server
        +
        • +
      + + + +
        +
      • +

        channel

        +
        private final org.apache.sshd.client.channel.ChannelDirectTcpip channel
        +
        • +
      + + + +
        +
      • +

        bufferSize

        +
        private final int bufferSize
        +
        • +
      + + + +
        +
      • +

        socket

        +
        private java.net.Socket socket
        +
        • +
      + + + +
        +
      • +

        ex

        +
        private java.lang.Exception ex
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Tunnel

        +
        Tunnel(java.net.ServerSocket ss,
+       org.apache.sshd.client.channel.ChannelDirectTcpip tmp,
+       int bufferSize)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getException

        +
        public java.lang.Exception getException()
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +
        • +
      + + + +
        +
      • +

        closeServer

        +
        private void closeServer()
        +
        • +
      + + + +
        +
      • +

        run

        +
        public void run()
        +
        +
        Specified by:
        +
        run in interface java.lang.Runnable
        +
        Overrides:
        +
        run in class java.lang.Thread
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.html new file mode 100644 index 000000000..87dc92cc1 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.html @@ -0,0 +1,671 @@ + + + + + +SSHUtil (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.adaptors.shared.ssh
+

Class SSHUtil

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class SSHUtil
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      (package private) static class SSHUtil.PasswordProvider 
      (package private) static class SSHUtil.Tunnel 
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static intDEFAULT_SSH_PORT 
      private static org.slf4j.LoggerLOGGER 
      private static java.lang.StringVIA_TAG 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      SSHUtil() +
      This constructor is only needed for testing.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static SSHConnectionconnect(java.lang.String adaptorName, + org.apache.sshd.client.SshClient client, + java.lang.String location, + Credential credential, + int bufferSize, + long timeout) +
      Connect an existing SshClient to the server at location and authenticate using the given credential.
      +
      private static org.apache.sshd.client.session.ClientSessionconnectAndAuthenticate(java.lang.String adaptorName, + org.apache.sshd.client.SshClient client, + java.lang.String host, + int port, + UserCredential credential, + long timeout) 
      static org.apache.sshd.client.SshClientcreateSSHClient() +
      Create a new SshClient with a default configuration similar to a stand-alone SSH client.
      +
      static org.apache.sshd.client.SshClientcreateSSHClient(boolean useKnownHosts, + boolean loadSSHConfig, + boolean stricHostCheck, + boolean useSSHAgent, + boolean useAgentForwarding) +
      Create a new SshClient with the desired configuration.
      +
      static UserCredentialextractCredential(org.apache.sshd.common.util.net.SshdSocketAddress location, + Credential credential) 
      static UserCredential[]extractCredentials(java.lang.String adaptorName, + org.apache.sshd.common.util.net.SshdSocketAddress[] locations, + Credential credentials) 
      static org.apache.sshd.common.util.net.SshdSocketAddress[]extractLocations(java.lang.String adaptorName, + java.lang.String location) +
      Extract a series of locations from a location string.
      +
      private static org.apache.sshd.common.util.net.SshdSocketAddressextractSocketAddress(java.lang.String adaptorName, + java.lang.String location) 
      static java.lang.StringgetHost(java.lang.String adaptorName, + java.lang.String location) 
      static intgetPort(java.lang.String adaptorName, + java.lang.String location) 
      static java.util.Map<java.lang.String,java.lang.String>translateProperties(java.util.Map<java.lang.String,java.lang.String> providedProperties, + java.lang.String orginalPrefix, + XenonPropertyDescription[] supportedProperties, + java.lang.String newPrefix) 
      static java.lang.StringvalidateHost(java.lang.String adaptorName, + java.lang.String host) +
      Weak validation of a host string containing either a hostame of IP adres.
      +
      static java.util.Set<java.lang.String>validProperties(XenonPropertyDescription[] properties) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + + + + + +
        +
      • +

        DEFAULT_SSH_PORT

        +
        public static final int DEFAULT_SSH_PORT
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SSHUtil

        +
        public SSHUtil()
        +
        This constructor is only needed for testing. Users should use the static methods instead.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createSSHClient

        +
        public static org.apache.sshd.client.SshClient createSSHClient()
        +
        Create a new SshClient with a default configuration similar to a stand-alone SSH client. +

        + The default configuration loads the SSH known_hosts and config file and uses strict host key checking. +

        +
        +
        Returns:
        +
        the configured SshClient
        +
        +
        • +
      + + + +
        +
      • +

        createSSHClient

        +
        public static org.apache.sshd.client.SshClient createSSHClient(boolean useKnownHosts,
+                                                               boolean loadSSHConfig,
+                                                               boolean stricHostCheck,
+                                                               boolean useSSHAgent,
+                                                               boolean useAgentForwarding)
        +
        Create a new SshClient with the desired configuration. +

        + SSH clients have a significant number of options. This method will create a SshClient providing the most important settings. +

        +
        +
        Parameters:
        +
        useKnownHosts - Load the SSH known_hosts file from the default location (for OpenSSH this is typically found in $HOME/.ssh/known_hosts).
        +
        loadSSHConfig - Load the SSH config file from the default location (for OpenSSH this is typically found in $HOME/.ssh/config).
        +
        stricHostCheck - Perform a strict host key check. When setting up a connection, the key presented by the server is compared to the default known_hosts file + (for OpenSSH this is typically found in $HOME/.ssh/known_hosts).
        +
        useSSHAgent - When setting up a connection, handoff authentication to a separate SSH agent process.
        +
        useAgentForwarding - Support agent forwarding, allowing remote SSH servers to use the local SSH agent process to authenticate connections to other servers.
        +
        Returns:
        +
        the configured SshClient
        +
        +
        • +
      + + + +
        +
      • +

        validateHost

        +
        public static java.lang.String validateHost(java.lang.String adaptorName,
+                                            java.lang.String host)
+                                     throws InvalidLocationException
        +
        Weak validation of a host string containing either a hostame of IP adres.
        +
        +
        Parameters:
        +
        adaptorName - the name of the adaptor using this method.
        +
        host - the hostname to validate
        +
        Returns:
        +
        the value of host if the validation succeeded.
        +
        Throws:
        +
        InvalidLocationException - if the validation failed
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        extractCredential

        +
        public static UserCredential extractCredential(org.apache.sshd.common.util.net.SshdSocketAddress location,
+                                               Credential credential)
        +
        • +
      + + + + + + + +
        +
      • +

        extractLocations

        +
        public static org.apache.sshd.common.util.net.SshdSocketAddress[] extractLocations(java.lang.String adaptorName,
+                                                                                   java.lang.String location)
+                                                                            throws InvalidLocationException
        +
        Extract a series of locations from a location string. + + This method will split the location string into the destination and any number of intermediate hops. The accepted format is: +

        + "host[:port][/workdir] [via:otherhost[:port]]*" +

        + The locations will be returned in connection setup order, which is the reverse order in which they are listed in the location string.
        +
        +
        Parameters:
        +
        adaptorName - the adaptor calling this method (used in exceptions).
        +
        location - the location to parse
        +
        Returns:
        +
        the location string split into its individual locations.
        +
        Throws:
        +
        InvalidLocationException - if the provided location is could not be parsed.
        +
        +
        • +
      + + + +
        +
      • +

        extractSocketAddress

        +
        private static org.apache.sshd.common.util.net.SshdSocketAddress extractSocketAddress(java.lang.String adaptorName,
+                                                                                      java.lang.String location)
+                                                                               throws InvalidLocationException
        +
        +
        Throws:
        +
        InvalidLocationException
        +
        +
        • +
      + + + +
        +
      • +

        connectAndAuthenticate

        +
        private static org.apache.sshd.client.session.ClientSession connectAndAuthenticate(java.lang.String adaptorName,
+                                                                                   org.apache.sshd.client.SshClient client,
+                                                                                   java.lang.String host,
+                                                                                   int port,
+                                                                                   UserCredential credential,
+                                                                                   long timeout)
+                                                                            throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        connect

        +
        public static SSHConnection connect(java.lang.String adaptorName,
+                                    org.apache.sshd.client.SshClient client,
+                                    java.lang.String location,
+                                    Credential credential,
+                                    int bufferSize,
+                                    long timeout)
+                             throws XenonException
        +
        Connect an existing SshClient to the server at location and authenticate using the given credential.
        +
        +
        Parameters:
        +
        adaptorName - the adaptor where this method was called from.
        +
        client - the client to connect.
        +
        location - the server to connect to
        +
        credential - the credential to authenticate with.
        +
        bufferSize - the buffer size used for the (optional) SSH tunnels.
        +
        timeout - the timeout to use in connection setup (in milliseconds).
        +
        Returns:
        +
        the connected ClientSession
        +
        Throws:
        +
        XenonException - if the connection setup or authentication failed.
        +
        +
        • +
      + + + +
        +
      • +

        translateProperties

        +
        public static java.util.Map<java.lang.String,java.lang.String> translateProperties(java.util.Map<java.lang.String,java.lang.String> providedProperties,
+                                                                                   java.lang.String orginalPrefix,
+                                                                                   XenonPropertyDescription[] supportedProperties,
+                                                                                   java.lang.String newPrefix)
        +
        • +
      + + + +
        +
      • +

        validProperties

        +
        public static java.util.Set<java.lang.String> validProperties(XenonPropertyDescription[] properties)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/package-frame.html new file mode 100644 index 000000000..dee53961f --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/package-frame.html @@ -0,0 +1,27 @@ + + + + + +nl.esciencecenter.xenon.adaptors.shared.ssh (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.adaptors.shared.ssh

+
+

Classes

+ +

Exceptions

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/package-summary.html new file mode 100644 index 000000000..38b9f95c3 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/package-summary.html @@ -0,0 +1,174 @@ + + + + + +nl.esciencecenter.xenon.adaptors.shared.ssh (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.adaptors.shared.ssh

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/package-tree.html new file mode 100644 index 000000000..b099119cc --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/package-tree.html @@ -0,0 +1,155 @@ + + + + + +nl.esciencecenter.xenon.adaptors.shared.ssh Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.shared.ssh

+Package Hierarchies: + +
+
+

Class Hierarchy

+
    +
  • java.lang.Object +
      +
    • nl.esciencecenter.xenon.adaptors.shared.ssh.SSHConnection (implements java.lang.AutoCloseable)
      • +
    • nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil
      • +
    • nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil.PasswordProvider (implements org.apache.sshd.common.config.keys.FilePasswordProvider)
      • +
    • java.lang.Thread (implements java.lang.Runnable) + +
      • +
    • java.lang.Throwable (implements java.io.Serializable) + +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/CertificateCredential.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/CertificateCredential.html new file mode 100644 index 000000000..f837f94dd --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/CertificateCredential.html @@ -0,0 +1,395 @@ + + + + + +CertificateCredential (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.credentials
+

Class CertificateCredential

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.lang.Stringcertfile +
      This member variables holds the URI of the file containing the certificate.
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      CertificateCredential(java.lang.String username, + java.lang.String certfile, + char[] passphrase) +
      Constructs a CertificateCredential out of a username, a certificate file containing a private key, and an optional passphrase.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        certfile

        +
        private java.lang.String certfile
        +
        This member variables holds the URI of the file containing the certificate.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CertificateCredential

        +
        public CertificateCredential(java.lang.String username,
+                             java.lang.String certfile,
+                             char[] passphrase)
        +
        Constructs a CertificateCredential out of a username, a certificate file containing a private key, and an optional passphrase.
        +
        +
        Parameters:
        +
        username - the username for this certificate
        +
        certfile - the certification file
        +
        passphrase - the optional passphrase needed to decrypt for this certificate
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCertificateFile

        +
        public java.lang.String getCertificateFile()
        +
        Returns the certificate file.
        +
        +
        Returns:
        +
        the certificate file.
        +
        +
        • +
      + + + + + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/Credential.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/Credential.html new file mode 100644 index 000000000..d7ea02ca8 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/Credential.html @@ -0,0 +1,173 @@ + + + + + +Credential (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
nl.esciencecenter.xenon.credentials
+

Interface Credential

+
+
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/CredentialMap.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/CredentialMap.html new file mode 100644 index 000000000..a89bbc5e2 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/CredentialMap.html @@ -0,0 +1,482 @@ + + + + + +CredentialMap (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.credentials
+

Class CredentialMap

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.credentials.CredentialMap
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Credential
    +
    +
    +
    +
    public class CredentialMap
+extends java.lang.Object
+implements Credential
    +
    A Credential consisting of a collection of Credentials each uniquely identified by a String (typically a host name or host alias). + + A default Credential can be set that will be returned if by get if a key is not found.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CredentialMap

        +
        public CredentialMap()
        +
        Create a new CredentialMap using null as the default credential.
        +
        • +
      + + + +
        +
      • +

        CredentialMap

        +
        public CredentialMap(UserCredential defaultCredential)
        +
        Creates a new CredentialMap and set the default credential to defaultCredential.
        +
        +
        Parameters:
        +
        defaultCredential - the default credential to return by get if a key is not found.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        put

        +
        public UserCredential put(java.lang.String key,
+                          UserCredential credential)
        +
        Add a Credential to the CredentialMap using key as a unique key. + + If the key already exists in the CredentialMap, the stored UserCredential will be replaced by credential.
        +
        +
        Parameters:
        +
        key - the unique key used to store the credential.
        +
        credential - the UserCredential to store.
        +
        Returns:
        +
        the UserCredential previously stored using the key or null if the key was not used before.
        +
        +
        • +
      + + + +
        +
      • +

        containsCredential

        +
        public boolean containsCredential(java.lang.String key)
        +
        Check if the key is stored in this CredentialMap.
        +
        +
        Parameters:
        +
        key - the key to check.
        +
        Returns:
        +
        if key is stored in this CredentialMap
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public UserCredential get(java.lang.String key)
        +
        Retrieve the UserCredential stored using the key. + + If the key is not found in the map, the default credential is returned (if provided when the CredentialMap was created) or null if no + default is set.
        +
        +
        Parameters:
        +
        key - the key of the UserCredential to retrieve.
        +
        Returns:
        +
        the UserCredential stored using key or the default credential if the key is not found.
        +
        +
        • +
      + + + +
        +
      • +

        keySet

        +
        public java.util.Set<java.lang.String> keySet()
        +
        Returns a Set view of the keys contained in this map.
        +
        +
        Returns:
        +
        a set view of the keys contained in this map
        +
        +
        • +
      + + + +
        +
      • +

        getDefault

        +
        public UserCredential getDefault()
        +
        Returns the default UserCredential.
        +
        +
        Returns:
        +
        the default credential to return by get if a key is not found.
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/DefaultCredential.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/DefaultCredential.html new file mode 100644 index 000000000..90c2c2714 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/DefaultCredential.html @@ -0,0 +1,368 @@ + + + + + +DefaultCredential (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.credentials
+

Class DefaultCredential

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.credentials.DefaultCredential
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Credential, UserCredential
    +
    +
    +
    +
    public class DefaultCredential
+extends java.lang.Object
+implements UserCredential
    +
    This class represents the default credential that may be used by the various adaptors. + + It mainly serves as a placeholder to indicate that the adaptor must revert to whatever default behavior it defines.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.lang.Stringusername 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object o) 
      java.lang.StringgetUsername() +
      Returns the user name associated with this credential.
      +
      inthashCode() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        username

        +
        private final java.lang.String username
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DefaultCredential

        +
        public DefaultCredential()
        +
        • +
      + + + +
        +
      • +

        DefaultCredential

        +
        public DefaultCredential(java.lang.String username)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getUsername

        +
        public java.lang.String getUsername()
        +
        Description copied from interface: UserCredential
        +
        Returns the user name associated with this credential.
        +
        +
        Specified by:
        +
        getUsername in interface UserCredential
        +
        Returns:
        +
        the user name associated with this credential.
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/KeytabCredential.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/KeytabCredential.html new file mode 100644 index 000000000..d21312543 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/KeytabCredential.html @@ -0,0 +1,381 @@ + + + + + +KeytabCredential (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.credentials
+

Class KeytabCredential

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.credentials.KeytabCredential
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.lang.StringkeytabFile 
      private java.lang.Stringusername 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      KeytabCredential(java.lang.String username, + java.lang.String keytabFile) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object o) 
      java.lang.StringgetKeytabFile() 
      java.lang.StringgetUsername() +
      Returns the user name associated with this credential.
      +
      inthashCode() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        username

        +
        private final java.lang.String username
        +
        • +
      + + + +
        +
      • +

        keytabFile

        +
        private final java.lang.String keytabFile
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        KeytabCredential

        +
        public KeytabCredential(java.lang.String username,
+                        java.lang.String keytabFile)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getUsername

        +
        public java.lang.String getUsername()
        +
        Description copied from interface: UserCredential
        +
        Returns the user name associated with this credential.
        +
        +
        Specified by:
        +
        getUsername in interface UserCredential
        +
        Returns:
        +
        the user name associated with this credential.
        +
        +
        • +
      + + + +
        +
      • +

        getKeytabFile

        +
        public java.lang.String getKeytabFile()
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/PasswordCredential.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/PasswordCredential.html new file mode 100644 index 000000000..037ce1c42 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/PasswordCredential.html @@ -0,0 +1,448 @@ + + + + + +PasswordCredential (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.credentials
+

Class PasswordCredential

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.credentials.PasswordCredential
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private char[]password +
      Must be char array for security!! (Strings end up in the constant pool, etc.)
      +
      private java.lang.Stringusername +
      The user name associated with the credential.
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PasswordCredential(java.lang.String username, + char[] password) +
      Create a new PasswordCredential using a char array as password.
      +
      PasswordCredential(java.lang.String username, + java.lang.String password) +
      Create a new PasswordCredential using a String as password.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object o) 
      char[]getPassword() +
      Gets the password.
      +
      java.lang.StringgetUsername() +
      Returns the user name associated with this credential.
      +
      inthashCode() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        username

        +
        private final java.lang.String username
        +
        The user name associated with the credential.
        +
        • +
      + + + +
        +
      • +

        password

        +
        private final char[] password
        +
        Must be char array for security!! (Strings end up in the constant pool, etc.)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PasswordCredential

        +
        public PasswordCredential(java.lang.String username,
+                          java.lang.String password)
        +
        Create a new PasswordCredential using a String as password. + + This String will immediately be converted into a char array internally.
        +
        +
        Parameters:
        +
        username - the user name of the credential.
        +
        password - the password of the credential.
        +
        +
        • +
      + + + +
        +
      • +

        PasswordCredential

        +
        public PasswordCredential(java.lang.String username,
+                          char[] password)
        +
        Create a new PasswordCredential using a char array as password.
        +
        +
        Parameters:
        +
        username - the user name of the credential.
        +
        password - the password of the credential.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPassword

        +
        public char[] getPassword()
        +
        Gets the password.
        +
        +
        Returns:
        +
        the password
        +
        +
        • +
      + + + +
        +
      • +

        getUsername

        +
        public java.lang.String getUsername()
        +
        Description copied from interface: UserCredential
        +
        Returns the user name associated with this credential.
        +
        +
        Specified by:
        +
        getUsername in interface UserCredential
        +
        Returns:
        +
        the user name associated with this credential.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/UserCredential.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/UserCredential.html new file mode 100644 index 000000000..cca0c6970 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/UserCredential.html @@ -0,0 +1,234 @@ + + + + + +UserCredential (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
nl.esciencecenter.xenon.credentials
+

Interface UserCredential

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getUsername

        +
        java.lang.String getUsername()
        +
        Returns the user name associated with this credential.
        +
        +
        Returns:
        +
        the user name associated with this credential.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/package-frame.html new file mode 100644 index 000000000..638e35ca8 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/package-frame.html @@ -0,0 +1,28 @@ + + + + + +nl.esciencecenter.xenon.credentials (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.credentials

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/package-summary.html new file mode 100644 index 000000000..f63c6f9c8 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/package-summary.html @@ -0,0 +1,193 @@ + + + + + +nl.esciencecenter.xenon.credentials (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.credentials

+
+
This package contains classes and interfaces for managing credentials.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    Credential +
    Credential represents a user credential uses to gain access to a resource.
    +
    UserCredential 
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    CertificateCredential +
    A container for security Information based upon certificates.
    +
    CredentialMap +
    A Credential consisting of a collection of Credentials each uniquely identified by a String (typically a host name or host alias).
    +
    DefaultCredential +
    This class represents the default credential that may be used by the various adaptors.
    +
    KeytabCredential 
    PasswordCredential +
    A Credential consisting of a username + password combination.
    +
    +
    • +
+ + + +

Package nl.esciencecenter.xenon.credentials Description

+
This package contains classes and interfaces for managing credentials.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/package-tree.html new file mode 100644 index 000000000..2cf45c3b4 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/credentials/package-tree.html @@ -0,0 +1,149 @@ + + + + + +nl.esciencecenter.xenon.credentials Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.credentials

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/AttributeNotSupportedException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/AttributeNotSupportedException.html new file mode 100644 index 000000000..608a8543a --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/AttributeNotSupportedException.html @@ -0,0 +1,332 @@ + + + + + +AttributeNotSupportedException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Class AttributeNotSupportedException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class AttributeNotSupportedException
+extends XenonException
    +
    Signals that a requested file attribute is not supported by the underlying file system implementation.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AttributeNotSupportedException

        +
        public AttributeNotSupportedException(java.lang.String adaptorName,
+                                      java.lang.String message,
+                                      java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        AttributeNotSupportedException

        +
        public AttributeNotSupportedException(java.lang.String adaptorName,
+                                      java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyCancelledException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyCancelledException.html new file mode 100644 index 000000000..8355407f3 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyCancelledException.html @@ -0,0 +1,273 @@ + + + + + +CopyCancelledException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Class CopyCancelledException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class CopyCancelledException
+extends XenonException
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      CopyCancelledException(java.lang.String adaptorName, + java.lang.String s) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CopyCancelledException

        +
        public CopyCancelledException(java.lang.String adaptorName,
+                              java.lang.String s)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyMode.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyMode.html new file mode 100644 index 000000000..4cf9d9d04 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyMode.html @@ -0,0 +1,366 @@ + + + + + +CopyMode (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Enum CopyMode

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<CopyMode>
      • +
    • +
        +
      • nl.esciencecenter.xenon.filesystems.CopyMode
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<CopyMode>
    +
    +
    +
    +
    public enum CopyMode
+extends java.lang.Enum<CopyMode>
    +
    CopyOption is an enumeration containing all possible options for copying a file. + + Note that the CREATE, REPLACE and IGNORE options are mutually exclusive.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      CREATE +
      Copy to a new destination file, failing if the file already exists.
      +
      IGNORE +
      Skip the copy if the destination file if it already exists.
      +
      REPLACE +
      If the source and destination are a regular file, the destination file will be replaced.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static CopyModevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static CopyMode[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        CREATE

        +
        public static final CopyMode CREATE
        +
        Copy to a new destination file, failing if the file already exists.
        +
        • +
      + + + +
        +
      • +

        REPLACE

        +
        public static final CopyMode REPLACE
        +
        If the source and destination are a regular file, the destination file will be replaced. If the destination exists and is not a file and the source is a + file, then the destination will be (recursively) deleted before copying. + + + If the source and destination are directories then additional files in the destination directory are not touched.
        +
        • +
      + + + +
        +
      • +

        IGNORE

        +
        public static final CopyMode IGNORE
        +
        Skip the copy if the destination file if it already exists.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static CopyMode[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (CopyMode c : CopyMode.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static CopyMode valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyStatus.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyStatus.html new file mode 100644 index 000000000..b902f8286 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyStatus.html @@ -0,0 +1,397 @@ + + + + + +CopyStatus (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Interface CopyStatus

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    FileSystem.CopyStatusImplementation
    +
    +
    +
    +
    public interface CopyStatus
    +
    CopyStatus contains status information for a specific copy operation.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      longbytesCopied() +
      Get the number of bytes that have been copied.
      +
      longbytesToCopy() +
      Get the number of bytes that need to be copied for the entire copy operation.
      +
      java.lang.StringgetCopyIdentifier() +
      Get the copy identifier for which this CopyStatus was created.
      +
      XenonExceptiongetException() +
      Get the exception produced by the Copy or while retrieving the status.
      +
      java.lang.StringgetState() +
      Get the state of the Copy operation.
      +
      booleanhasException() +
      Has the Copy or status retrieval produced a exception ?
      +
      booleanisDone() +
      Is the Copy done?
      +
      booleanisRunning() +
      Is the Copy still running?
      +
      voidmaybeThrowException() +
      Throws the exception that occured during copying, if it exists.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCopyIdentifier

        +
        java.lang.String getCopyIdentifier()
        +
        Get the copy identifier for which this CopyStatus was created.
        +
        +
        Returns:
        +
        the Copy.
        +
        +
        • +
      + + + +
        +
      • +

        getState

        +
        java.lang.String getState()
        +
        Get the state of the Copy operation.
        +
        +
        Returns:
        +
        the state of the Copy operation.
        +
        +
        • +
      + + + +
        +
      • +

        getException

        +
        XenonException getException()
        +
        Get the exception produced by the Copy or while retrieving the status. If there was no exception, null will be returned. + + See maybeThrowException() for the possible exceptions.
        +
        +
        Returns:
        +
        the exception.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        isRunning

        +
        boolean isRunning()
        +
        Is the Copy still running?
        +
        +
        Returns:
        +
        if the Copy is running.
        +
        +
        • +
      + + + +
        +
      • +

        isDone

        +
        boolean isDone()
        +
        Is the Copy done?
        +
        +
        Returns:
        +
        if the Copy is done.
        +
        +
        • +
      + + + +
        +
      • +

        hasException

        +
        boolean hasException()
        +
        Has the Copy or status retrieval produced a exception ?
        +
        +
        Returns:
        +
        if the Copy or status retrieval produced a exception.
        +
        +
        • +
      + + + +
        +
      • +

        bytesToCopy

        +
        long bytesToCopy()
        +
        Get the number of bytes that need to be copied for the entire copy operation.
        +
        +
        Returns:
        +
        the number of bytes that need to be copied.
        +
        +
        • +
      + + + +
        +
      • +

        bytesCopied

        +
        long bytesCopied()
        +
        Get the number of bytes that have been copied.
        +
        +
        Returns:
        +
        the number of bytes that have been copied.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/DirectoryNotEmptyException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/DirectoryNotEmptyException.html new file mode 100644 index 000000000..bc742a2b0 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/DirectoryNotEmptyException.html @@ -0,0 +1,332 @@ + + + + + +DirectoryNotEmptyException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Class DirectoryNotEmptyException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class DirectoryNotEmptyException
+extends XenonException
    +
    Signals that directory is not empty.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      DirectoryNotEmptyException(java.lang.String adaptorName, + java.lang.String message) 
      DirectoryNotEmptyException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DirectoryNotEmptyException

        +
        public DirectoryNotEmptyException(java.lang.String adaptorName,
+                                  java.lang.String message,
+                                  java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        DirectoryNotEmptyException

        +
        public DirectoryNotEmptyException(java.lang.String adaptorName,
+                                  java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.CopyCallback.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.CopyCallback.html new file mode 100644 index 000000000..1d7431f96 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.CopyCallback.html @@ -0,0 +1,399 @@ + + + + + +FileSystem.CopyCallback (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Class FileSystem.CopyCallback

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.filesystems.FileSystem.CopyCallback
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    FileSystem
    +
    +
    +
    +
    class FileSystem.CopyCallback
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      (package private) longbytesCopied 
      (package private) longbytesToCopy 
      (package private) booleancancelled 
      (package private) booleanstarted 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      CopyCallback() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      (package private) voidaddBytesCopied(long bytes) 
      (package private) voidcancel() 
      (package private) booleanisCancelled() 
      (package private) booleanisStarted() 
      (package private) voidstart(long bytesToCopy) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        bytesToCopy

        +
        long bytesToCopy
        +
        • +
      + + + +
        +
      • +

        bytesCopied

        +
        long bytesCopied
        +
        • +
      + + + +
        +
      • +

        started

        +
        boolean started
        +
        • +
      + + + +
        +
      • +

        cancelled

        +
        boolean cancelled
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CopyCallback

        +
        CopyCallback()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        start

        +
        void start(long bytesToCopy)
        +
        • +
      + + + +
        +
      • +

        isStarted

        +
        boolean isStarted()
        +
        • +
      + + + +
        +
      • +

        addBytesCopied

        +
        void addBytesCopied(long bytes)
        +
        • +
      + + + +
        +
      • +

        cancel

        +
        void cancel()
        +
        • +
      + + + +
        +
      • +

        isCancelled

        +
        boolean isCancelled()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.CopyStatusImplementation.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.CopyStatusImplementation.html new file mode 100644 index 000000000..498a74558 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.CopyStatusImplementation.html @@ -0,0 +1,626 @@ + + + + + +FileSystem.CopyStatusImplementation (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Class FileSystem.CopyStatusImplementation

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    CopyStatus
    +
    +
    +
    Enclosing class:
    +
    FileSystem
    +
    +
    +
    +
    static class FileSystem.CopyStatusImplementation
+extends java.lang.Object
+implements CopyStatus
    +
    CopyStatus contains status information for a specific copy operation.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      CopyStatusImplementation(java.lang.String copyIdentifier, + java.lang.String state, + long bytesToCopy, + long bytesCopied, + XenonException exception) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      longbytesCopied() +
      Get the number of bytes that have been copied.
      +
      longbytesToCopy() +
      Get the number of bytes that need to be copied for the entire copy operation.
      +
      booleanequals(java.lang.Object o) 
      java.lang.StringgetCopyIdentifier() +
      Get the copy identifier for which this CopyStatus was created.
      +
      XenonExceptiongetException() +
      Get the exception produced by the Copy or while retrieving the status.
      +
      java.lang.StringgetState() +
      Get the state of the Copy operation.
      +
      booleanhasException() +
      Has the Copy or status retrieval produced a exception ?
      +
      inthashCode() 
      booleanisDone() +
      Is the Copy done?
      +
      booleanisRunning() +
      Is the Copy still running?
      +
      voidmaybeThrowException() +
      Throws the exception that occured during copying, if it exists.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        copyIdentifier

        +
        private final java.lang.String copyIdentifier
        +
        • +
      + + + +
        +
      • +

        state

        +
        private final java.lang.String state
        +
        • +
      + + + + + + + +
        +
      • +

        bytesToCopy

        +
        private final long bytesToCopy
        +
        • +
      + + + +
        +
      • +

        bytesCopied

        +
        private final long bytesCopied
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CopyStatusImplementation

        +
        public CopyStatusImplementation(java.lang.String copyIdentifier,
+                                java.lang.String state,
+                                long bytesToCopy,
+                                long bytesCopied,
+                                XenonException exception)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCopyIdentifier

        +
        public java.lang.String getCopyIdentifier()
        +
        Description copied from interface: CopyStatus
        +
        Get the copy identifier for which this CopyStatus was created.
        +
        +
        Specified by:
        +
        getCopyIdentifier in interface CopyStatus
        +
        Returns:
        +
        the Copy.
        +
        +
        • +
      + + + +
        +
      • +

        getState

        +
        public java.lang.String getState()
        +
        Description copied from interface: CopyStatus
        +
        Get the state of the Copy operation.
        +
        +
        Specified by:
        +
        getState in interface CopyStatus
        +
        Returns:
        +
        the state of the Copy operation.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        isRunning

        +
        public boolean isRunning()
        +
        Description copied from interface: CopyStatus
        +
        Is the Copy still running?
        +
        +
        Specified by:
        +
        isRunning in interface CopyStatus
        +
        Returns:
        +
        if the Copy is running.
        +
        +
        • +
      + + + +
        +
      • +

        isDone

        +
        public boolean isDone()
        +
        Description copied from interface: CopyStatus
        +
        Is the Copy done?
        +
        +
        Specified by:
        +
        isDone in interface CopyStatus
        +
        Returns:
        +
        if the Copy is done.
        +
        +
        • +
      + + + +
        +
      • +

        hasException

        +
        public boolean hasException()
        +
        Description copied from interface: CopyStatus
        +
        Has the Copy or status retrieval produced a exception ?
        +
        +
        Specified by:
        +
        hasException in interface CopyStatus
        +
        Returns:
        +
        if the Copy or status retrieval produced a exception.
        +
        +
        • +
      + + + +
        +
      • +

        bytesToCopy

        +
        public long bytesToCopy()
        +
        Description copied from interface: CopyStatus
        +
        Get the number of bytes that need to be copied for the entire copy operation.
        +
        +
        Specified by:
        +
        bytesToCopy in interface CopyStatus
        +
        Returns:
        +
        the number of bytes that need to be copied.
        +
        +
        • +
      + + + +
        +
      • +

        bytesCopied

        +
        public long bytesCopied()
        +
        Description copied from interface: CopyStatus
        +
        Get the number of bytes that have been copied.
        +
        +
        Specified by:
        +
        bytesCopied in interface CopyStatus
        +
        Returns:
        +
        the number of bytes that have been copied.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.PendingCopy.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.PendingCopy.html new file mode 100644 index 000000000..41b03fc1c --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.PendingCopy.html @@ -0,0 +1,289 @@ + + + + + +FileSystem.PendingCopy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Class FileSystem.PendingCopy

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.filesystems.FileSystem.PendingCopy
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    FileSystem
    +
    +
    +
    +
    private class FileSystem.PendingCopy
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      (package private) FileSystem.CopyCallbackcallback 
      (package private) java.util.concurrent.Future<java.lang.Void>future 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      PendingCopy(java.util.concurrent.Future<java.lang.Void> future, + FileSystem.CopyCallback callback) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        PendingCopy

        +
        public PendingCopy(java.util.concurrent.Future<java.lang.Void> future,
+                   FileSystem.CopyCallback callback)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.html new file mode 100644 index 000000000..160231f45 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.html @@ -0,0 +1,2192 @@ + + + + + +FileSystem (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Class FileSystem

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.filesystems.FileSystem
      • +
    +
    • +
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        COMPONENT_NAME

        +
        private static final java.lang.String COMPONENT_NAME
        +
        The name of this component, for use in exceptions
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        adaptors

        +
        private static final java.util.HashMap<java.lang.String,FileAdaptor> adaptors
        +
        • +
      + + + +
        +
      • +

        uniqueID

        +
        private final java.lang.String uniqueID
        +
        • +
      + + + +
        +
      • +

        adaptor

        +
        private final java.lang.String adaptor
        +
        • +
      + + + +
        +
      • +

        location

        +
        private final java.lang.String location
        +
        • +
      + + + +
        +
      • +

        credential

        +
        private final Credential credential
        +
        • +
      + + + + + + + +
        +
      • +

        pool

        +
        private final java.util.concurrent.ExecutorService pool
        +
        • +
      + + + +
        +
      • +

        workingDirectory

        +
        private Path workingDirectory
        +
        • +
      + + + +
        +
      • +

        nextCopyID

        +
        private long nextCopyID
        +
        • +
      + + + +
        +
      • +

        bufferSize

        +
        private int bufferSize
        +
        • +
      + + + +
        +
      • +

        pendingCopies

        +
        private final java.util.HashMap<java.lang.String,FileSystem.PendingCopy> pendingCopies
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FileSystem

        +
        protected FileSystem(java.lang.String uniqueID,
+                     java.lang.String adaptor,
+                     java.lang.String location,
+                     Credential credential,
+                     Path workDirectory,
+                     int bufferSize,
+                     XenonProperties properties)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addAdaptor

        +
        private static void addAdaptor(FileAdaptor adaptor)
        +
        • +
      + + + + + + + +
        +
      • +

        getAdaptorNames

        +
        public static java.lang.String[] getAdaptorNames()
        +
        Gives a list names of the available adaptors.
        +
        +
        Returns:
        +
        the list
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getAdaptorDescriptions

        +
        public static FileSystemAdaptorDescription[] getAdaptorDescriptions()
        +
        Gives a list of the descriptions of the available adaptors.
        +
        +
        Returns:
        +
        the list
        +
        +
        • +
      + + + +
        +
      • +

        create

        +
        public static FileSystem create(java.lang.String adaptor,
+                                java.lang.String location,
+                                Credential credential,
+                                java.util.Map<java.lang.String,java.lang.String> properties)
+                         throws XenonException
        +
        Create a new FileSystem using the adaptor that connects to a data store at location using the credentials to get + access. Use properties to (optionally) configure the FileSystem when it is created. + + Make sure to always close FileSystem instances by calling close(FileSystem) when you no longer need them, otherwise their associated + resources remain allocated.
        +
        +
        Parameters:
        +
        adaptor - the type of file system to connect to (e.g. "sftp" or "webdav")
        +
        location - the location of the FileSystem.
        +
        credential - the Credentials to use to get access to the FileSystem.
        +
        properties - optional properties to use when creating the FileSystem.
        +
        Returns:
        +
        the new FileSystem.
        +
        Throws:
        +
        UnknownPropertyException - If a unknown property was provided.
        +
        InvalidPropertyException - If a known property was provided with an invalid value.
        +
        UnknownAdaptorException - If the adaptor was invalid.
        +
        InvalidLocationException - If the location was invalid.
        +
        InvalidCredentialException - If the credential is invalid to access the location.
        +
        XenonException - If the creation of the FileSystem failed.
        +
        java.lang.IllegalArgumentException - If adaptor is null.
        +
        See Also:
        +
        Documentation on the supported adaptors and locations.
        +
        +
        • +
      + + + +
        +
      • +

        create

        +
        public static FileSystem create(java.lang.String adaptor,
+                                java.lang.String location,
+                                Credential credential)
+                         throws XenonException
        +
        Create a new FileSystem using the adaptor that connects to a data store at location using the credentials to get + access. + + Make sure to always close FileSystem instances by calling close(FileSystem) when you no longer need them, otherwise their associated + resources remain allocated.
        +
        +
        Parameters:
        +
        adaptor - the type of file system to connect to (e.g. "sftp" or "webdav")
        +
        location - the location of the FileSystem.
        +
        credential - the Credentials to use to get access to the FileSystem.
        +
        Returns:
        +
        the new FileSystem.
        +
        Throws:
        +
        UnknownPropertyException - If a unknown property was provided.
        +
        InvalidPropertyException - If a known property was provided with an invalid value.
        +
        UnknownAdaptorException - If the adaptor was invalid.
        +
        InvalidLocationException - If the location was invalid.
        +
        InvalidCredentialException - If the credential is invalid to access the location.
        +
        XenonException - If the creation of the FileSystem failed.
        +
        java.lang.IllegalArgumentException - If adaptor is null.
        +
        See Also:
        +
        Documentation on the supported adaptors and locations.
        +
        +
        • +
      + + + +
        +
      • +

        create

        +
        public static FileSystem create(java.lang.String adaptor,
+                                java.lang.String location)
+                         throws XenonException
        +
        Create a new FileSystem using the adaptor that connects to a data store at location using the default credentials to get + access. + + Make sure to always close FileSystem instances by calling close(FileSystem) when you no longer need them, otherwise their associated + resources remain allocated.
        +
        +
        Parameters:
        +
        adaptor - the type of file system to connect to (e.g. "sftp" or "webdav")
        +
        location - the location of the FileSystem.
        +
        Returns:
        +
        the new FileSystem.
        +
        Throws:
        +
        UnknownPropertyException - If a unknown property was provided.
        +
        InvalidPropertyException - If a known property was provided with an invalid value.
        +
        UnknownAdaptorException - If the adaptor was invalid.
        +
        InvalidLocationException - If the location was invalid.
        +
        InvalidCredentialException - If the credential is invalid to access the location.
        +
        XenonException - If the creation of the FileSystem failed.
        +
        java.lang.IllegalArgumentException - If adaptor is null.
        +
        See Also:
        +
        Documentation on the supported adaptors and locations.
        +
        +
        • +
      + + + +
        +
      • +

        create

        +
        public static FileSystem create(java.lang.String adaptor)
+                         throws XenonException
        +
        Create a new FileSystem using the adaptor that connects to a data store at the default location using the default credentials to get access. + + Note that there are very few filesystem adaptors that support a default location. The local filesystem adaptor is the prime example. + + Make sure to always close FileSystem instances by calling close(FileSystem) when you no longer need them, otherwise their associated + resources remain allocated.
        +
        +
        Parameters:
        +
        adaptor - the type of file system to connect to (e.g. "sftp" or "webdav")
        +
        Returns:
        +
        the new FileSystem.
        +
        Throws:
        +
        UnknownPropertyException - If a unknown property was provided.
        +
        InvalidPropertyException - If a known property was provided with an invalid value.
        +
        UnknownAdaptorException - If the adaptor was invalid.
        +
        InvalidLocationException - If the location was invalid.
        +
        InvalidCredentialException - If the credential is invalid to access the location.
        +
        XenonException - If the creation of the FileSystem failed.
        +
        java.lang.IllegalArgumentException - If adaptor is null.
        +
        See Also:
        +
        Documentation on the supported adaptors and locations.
        +
        +
        • +
      + + + +
        +
      • +

        getNextCopyID

        +
        private java.lang.String getNextCopyID()
        +
        • +
      + + + +
        +
      • +

        getAdaptorName

        +
        public java.lang.String getAdaptorName()
        +
        Get the name of the adaptor that created this FileSystem.
        +
        +
        Returns:
        +
        the name of the adaptor.
        +
        +
        • +
      + + + +
        +
      • +

        getLocation

        +
        public java.lang.String getLocation()
        +
        Get the location of the FileSystem.
        +
        +
        Returns:
        +
        the location of the FileSystem.
        +
        +
        • +
      + + + +
        +
      • +

        getCredential

        +
        public Credential getCredential()
        +
        Get the credential that this FileSystem is using.
        +
        +
        Returns:
        +
        the credential this FileSystem is using.
        +
        +
        • +
      + + + +
        +
      • +

        getProperties

        +
        public java.util.Map<java.lang.String,java.lang.String> getProperties()
        +
        Get the properties used to create this FileSystem.
        +
        +
        Returns:
        +
        the properties used to create this FileSystem.
        +
        +
        • +
      + + + +
        +
      • +

        getWorkingDirectory

        +
        public Path getWorkingDirectory()
        +
        Get the current working directory of this file system. + + All relative paths provided to FileSystem methods are resolved against this current working directory. + + The current working directory is set when a FileSystem is created using the path specified in the location. If no path is specified in the location, an + adaptor specific default path is used, for example "/home/username".
        +
        +
        Returns:
        +
        the current working directory of this file system.
        +
        +
        • +
      + + + +
        +
      • +

        getPathSeparator

        +
        public java.lang.String getPathSeparator()
        +
        Get the path separator used by this file system. + + The path separator is set when a FileSystem is created.
        +
        +
        Returns:
        +
        the path separator used by this file system.
        +
        +
        • +
      + + + +
        +
      • +

        setWorkingDirectory

        +
        public void setWorkingDirectory(Path directory)
+                         throws XenonException
        +
        Set the current working directory of this file system to directory. + + The provided directory must exist and be a directory. Both an absolute or relative path may be provided. In the latter case, the path will + be resolved against the current working directory.
        +
        +
        Parameters:
        +
        directory - a path to which the current working directory must be set.
        +
        Throws:
        +
        NoSuchPathException - if the directory does not exist
        +
        InvalidPathException - if directory is not a directory
        +
        NotConnectedException - if file system is closed.
        +
        java.lang.IllegalArgumentException - if the argument is null.
        +
        XenonException - if an I/O error occurred
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws XenonException
        +
        Close this FileSystem. If the adaptor does not support closing this is a no-op.
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Throws:
        +
        XenonException - If the FileSystem failed to close or if an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        isOpen

        +
        public abstract boolean isOpen()
+                        throws XenonException
        +
        Return if the connection to the FileSystem is open. An adaptor which does not support closing is always open.
        +
        +
        Returns:
        +
        if the connection to the FileSystem is open.
        +
        Throws:
        +
        XenonException - if the test failed or an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        rename

        +
        public abstract void rename(Path source,
+                            Path target)
+                     throws XenonException
        +
        Rename an existing source path to a non-existing target path (optional operation). +

        + + This method only implements a rename operation, not a move operation. Hence, this method will not copy files and should return (almost) + instantaneously. + + The parent of the target path (e.g. target.getParent) must exist. + + If the target is equal to the source this method has no effect. + + If the source is a link, the link itself will be renamed, not the path to which it refers. + + If the source is a directory, it will be renamed to the target. This implies that a moving a directory between physical locations may fail. +

        +
        +
        Parameters:
        +
        source - the existing source path.
        +
        target - the non existing target path.
        +
        Throws:
        +
        UnsupportedOperationException - If the adapter does not support renaming.
        +
        NoSuchPathException - If the source file does not exist or the target parent directory does not exist.
        +
        PathAlreadyExistsException - If the target file already exists.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - If the move failed.
        +
        java.lang.IllegalArgumentException - If one or both of the arguments are null.
        +
        +
        • +
      + + + +
        +
      • +

        createDirectories

        +
        public void createDirectories(Path dir)
+                       throws XenonException
        +
        Creates a new directory, failing if the directory already exists. All nonexistent parent directories are also created.
        +
        +
        Parameters:
        +
        dir - the directory to create.
        +
        Throws:
        +
        PathAlreadyExistsException - If the directory already exists or if a parent directory could not be created because a file with the same name already exists.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - If an I/O error occurred.
        +
        java.lang.IllegalArgumentException - If one or both of the arguments are null.
        +
        +
        • +
      + + + +
        +
      • +

        createDirectory

        +
        public abstract void createDirectory(Path dir)
+                              throws XenonException
        +
        Creates a new directory, failing if the directory already exists. + + The parent directory of the file must already exists.
        +
        +
        Parameters:
        +
        dir - the directory to create.
        +
        Throws:
        +
        PathAlreadyExistsException - If the directory already exists.
        +
        NoSuchPathException - If the parent directory does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - If an I/O error occurred.
        +
        java.lang.IllegalArgumentException - If the argument is null.
        +
        +
        • +
      + + + +
        +
      • +

        createFile

        +
        public abstract void createFile(Path file)
+                         throws XenonException
        +
        Creates a new empty file, failing if the file already exists. + + The parent directory of the file must already exists.
        +
        +
        Parameters:
        +
        file - a path referring to the file to create.
        +
        Throws:
        +
        PathAlreadyExistsException - If the file already exists.
        +
        NoSuchPathException - If the parent directory does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - If an I/O error occurred.
        +
        java.lang.IllegalArgumentException - If one or both of the arguments are null.
        +
        +
        • +
      + + + +
        +
      • +

        createSymbolicLink

        +
        public abstract void createSymbolicLink(Path link,
+                                        Path target)
+                                 throws XenonException
        +
        Creates a new symbolic link, failing if the link already exists (optional operation). + + The target is taken as is. It may be absolute, relative path and/or non-normalized path and may or may not exist.
        +
        +
        Parameters:
        +
        link - the symbolic link to create.
        +
        target - the target the symbolic link should refer to.
        +
        Throws:
        +
        PathAlreadyExistsException - If the link already exists.
        +
        NoSuchPathException - If the target or parent directory of link does not exist
        +
        InvalidPathException - If parent of link is not a directory
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - If an I/O error occurred.
        +
        java.lang.IllegalArgumentException - If one or both of the arguments are null.
        +
        +
        • +
      + + + +
        +
      • +

        delete

        +
        public void delete(Path path,
+                   boolean recursive)
+            throws XenonException
        +
        Deletes an existing path. + + If path is a symbolic link the symbolic link is removed and the symbolic link's target is not deleted. + + If the path is a directory and recursive is set to true, the contents of the directory will also be deleted. If recursive is + set to false, a directory will only be removed if it is empty.
        +
        +
        Parameters:
        +
        path - the path to delete.
        +
        recursive - if the delete must be done recursively
        +
        Throws:
        +
        DirectoryNotEmptyException - if the directory was not empty (and the delete was not recursive).
        +
        NoSuchPathException - if the provided path does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        java.lang.IllegalArgumentException - If path is null.
        +
        +
        • +
      + + + +
        +
      • +

        exists

        +
        public abstract boolean exists(Path path)
+                        throws XenonException
        +
        Tests if a path exists.
        +
        +
        Parameters:
        +
        path - the path to test.
        +
        Returns:
        +
        If the path exists.
        +
        Throws:
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        java.lang.IllegalArgumentException - If path is null.
        +
        +
        • +
      + + + +
        +
      • +

        list

        +
        public java.lang.Iterable<PathAttributes> list(Path dir,
+                                               boolean recursive)
+                                        throws XenonException
        +
        List all entries in the directory dir. + + All entries in the directory are returned, but subdirectories will not be traversed by default. Set recursive to true, include + the listing of all subdirectories. + + Symbolic links are not followed.
        +
        +
        Parameters:
        +
        dir - the target directory.
        +
        recursive - should the list recursively traverse the subdirectories ?
        +
        Returns:
        +
        a List of PathAttributes that iterates over all entries in the directory dir.
        +
        Throws:
        +
        NoSuchPathException - If a directory does not exists.
        +
        InvalidPathException - If dir is not a directory.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        java.lang.IllegalArgumentException - If path is null.
        +
        +
        • +
      + + + +
        +
      • +

        readFromFile

        +
        public abstract java.io.InputStream readFromFile(Path file)
+                                          throws XenonException
        +
        Open an existing file and return an InputStream to read from this file.
        +
        +
        Parameters:
        +
        file - the to read.
        +
        Returns:
        +
        the InputStream to read from the file.
        +
        Throws:
        +
        NoSuchPathException - If the file does not exists.
        +
        InvalidPathException - If the file is not regular file.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        java.lang.IllegalArgumentException - If path is null.
        +
        +
        • +
      + + + +
        +
      • +

        writeToFile

        +
        public abstract java.io.OutputStream writeToFile(Path path,
+                                                 long size)
+                                          throws XenonException
        +
        Open a file and return an OutputStream to write to this file. +

        + + The size of the file (once all data has been written) must be specified using the size parameter. This is required by some implementations + (typically blob-stores). + +

        +
        +
        Parameters:
        +
        path - the target file for the OutputStream.
        +
        size - the size of the file once fully written.
        +
        Returns:
        +
        the OutputStream to write to the file.
        +
        Throws:
        +
        PathAlreadyExistsException - If the target existed.
        +
        NoSuchPathException - if a parent directory does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        java.lang.IllegalArgumentException - If path is null.
        +
        +
        • +
      + + + +
        +
      • +

        writeToFile

        +
        public abstract java.io.OutputStream writeToFile(Path file)
+                                          throws XenonException
        +
        Open a file and return an OutputStream to write to this file. (optional operation) +

        + If the file already exists it will be replaced and its data will be lost. + + The amount of data that will be written to the file is not specified in advance. This operation may not be supported by all implementations. + +

        +
        +
        Parameters:
        +
        file - the target file for the OutputStream.
        +
        Returns:
        +
        the OutputStream to write to the file.
        +
        Throws:
        +
        PathAlreadyExistsException - If the target existed.
        +
        NoSuchPathException - if a parent directory does not exist.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        java.lang.IllegalArgumentException - If path is null.
        +
        +
        • +
      + + + +
        +
      • +

        appendToFile

        +
        public abstract java.io.OutputStream appendToFile(Path file)
+                                           throws XenonException
        +
        Open an existing file and return an OutputStream to append data to this file. (optional operation) +

        + If the file does not exist, an exception will be thrown. + + This operation may not be supported by all implementations. + +

        +
        +
        Parameters:
        +
        file - the target file for the OutputStream.
        +
        Returns:
        +
        the OutputStream to write to the file.
        +
        Throws:
        +
        PathAlreadyExistsException - If the target existed.
        +
        NoSuchPathException - if a parent directory does not exist.
        +
        InvalidPathException - if not a regular file
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        java.lang.IllegalArgumentException - If path is null.
        +
        UnsupportedOperationException - if the adaptor does not support appending
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        setPosixFilePermissions

        +
        public abstract void setPosixFilePermissions(Path path,
+                                             java.util.Set<PosixFilePermission> permissions)
+                                      throws XenonException
        +
        Sets the POSIX permissions of a path (optional operation).
        +
        +
        Parameters:
        +
        path - the target path.
        +
        permissions - the permissions to set.
        +
        Throws:
        +
        NoSuchPathException - If the target path does not exists.
        +
        UnsupportedOperationException - If this FileSystem does not support symbolic links.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        java.lang.IllegalArgumentException - If path is null.
        +
        +
        • +
      + + + +
        +
      • +

        toAbsolutePath

        +
        protected Path toAbsolutePath(Path path)
        +
        Convert the provided path to an absolute path by (if necessary) resolving a relative path against the working directory of this FileSystem. The resulting + path is also normalized.
        +
        +
        Parameters:
        +
        path - the path to convert
        +
        Returns:
        +
        an absolute path
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if path is null.
        +
        +
        • +
      + + + +
        +
      • +

        streamCopy

        +
        protected void streamCopy(java.io.InputStream in,
+                          java.io.OutputStream out,
+                          int buffersize,
+                          FileSystem.CopyCallback callback)
+                   throws java.io.IOException,
+                          CopyCancelledException
        +
        Copy data from in to out using a buffer size of buffersize. + + After each buffersize block of data, callback.addBytesCopied will be invoked to report the number of bytes copied and + callback.isCancelled will be invoked to determine if the copy should continue.
        +
        +
        Parameters:
        +
        in - the stream to copy the data from.
        +
        out - the stream to copy the data to.
        +
        buffersize - the buffer size to use for copying.
        +
        callback - the callback to report bytes copied to and check cancellation from.
        +
        Throws:
        +
        java.io.IOException - if an I/O exception occurred.
        +
        CopyCancelledException - if the copy was cancelled by the user.
        +
        +
        • +
      + + + +
        +
      • +

        copySymbolicLink

        +
        protected void copySymbolicLink(Path source,
+                                FileSystem destinationFS,
+                                Path destination,
+                                CopyMode mode,
+                                FileSystem.CopyCallback callback)
+                         throws XenonException
        +
        Copy a symbolic link to another file system (optional operation). + + This is a blocking copy operation. It only returns once the link has been copied or the copy has failed. + + This operation may be re-implemented by the various implementations of FileSystem. + + This default implementation is based on a creating a new link on the destination filesystem. Note that the file the link is referring to is not copied. + Only the link itself is copied.
        +
        +
        Parameters:
        +
        source - the link to copy.
        +
        destinationFS - the destination FileSystem to copy to.
        +
        destination - the destination link on the destination file system.
        +
        mode - selects what should happen if the destination link already exists
        +
        callback - a FileSystem.CopyCallback used to update the status of the copy, or cancel it while in progress.
        +
        Throws:
        +
        InvalidPathException - if the provide source is not a link.
        +
        NoSuchPathException - if the source link does not exist or the destination parent directory does not exist.
        +
        PathAlreadyExistsException - if the destination link already exists.
        +
        UnsupportedOperationException - if the destination FileSystem does not support symbolic links.
        +
        XenonException - if the link could not be copied.
        +
        +
        • +
      + + + +
        +
      • +

        copyFile

        +
        protected void copyFile(Path source,
+                        FileSystem destinationFS,
+                        Path destination,
+                        CopyMode mode,
+                        FileSystem.CopyCallback callback)
+                 throws XenonException
        +
        Copy a single file to another file system. + + This is a blocking copy operation. It only returns once the file has been copied or the copy has failed. + + This operation may be re-implemented by the various implementations of FileSystem. This default implementation is based on a simple stream based copy.
        +
        +
        Parameters:
        +
        source - the file to copy.
        +
        destinationFS - the destination FileSystem to copy to.
        +
        destination - the destination file on the destination file system.
        +
        mode - selects what should happen if the destination file already exists
        +
        callback - a FileSystem.CopyCallback used to update the status of the copy, or cancel it while in progress.
        +
        Throws:
        +
        InvalidPathException - if the provide source is not a regular file.
        +
        NoSuchPathException - if the source file does not exist or the destination parent directory does not exist.
        +
        PathAlreadyExistsException - if the destination file already exists.
        +
        XenonException - If the file could not be copied.
        +
        +
        • +
      + + + +
        +
      • +

        performCopy

        +
        protected void performCopy(Path source,
+                           FileSystem destinationFS,
+                           Path destination,
+                           CopyMode mode,
+                           boolean recursive,
+                           FileSystem.CopyCallback callback)
+                    throws XenonException
        +
        Perform a (possibly) recursive copy from a path on this filesystem to a path on destinationFS.
        +
        +
        Parameters:
        +
        source - the source path on this FileSystem.
        +
        destinationFS - the destination FileSystem.
        +
        destination - the destination path.
        +
        mode - the copy mode that determines how to react if the destination already exists.
        +
        recursive - should the copy be performed recursively ?
        +
        callback - a FileSystem.CopyCallback used to return status information on the copy.
        +
        Throws:
        +
        XenonException - if an error occurred.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        deleteFile

        +
        protected abstract void deleteFile(Path file)
+                            throws XenonException
        +
        Delete a file. Is only called on existing files + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Parameters:
        +
        file - the file to remove
        +
        Throws:
        +
        InvalidPathException - if the provided path is not a file.
        +
        NoSuchPathException - if the provided file does not exist.
        +
        XenonException - If the file could not be removed.
        +
        +
        • +
      + + + +
        +
      • +

        deleteDirectory

        +
        protected abstract void deleteDirectory(Path path)
+                                 throws XenonException
        +
        Delete an empty directory. Is only called on empty directories + + This operation can only delete empty directories (analogous to rmdir in Linux). + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Parameters:
        +
        path - the directory to remove
        +
        Throws:
        +
        InvalidPathException - if the provided path is not a directory.
        +
        NoSuchPathException - if the provided path does not exist.
        +
        XenonException - If the directory could not be removed.
        +
        +
        • +
      + + + +
        +
      • +

        listDirectory

        +
        protected abstract java.lang.Iterable<PathAttributes> listDirectory(Path dir)
+                                                             throws XenonException
        +
        Return the list of entries in a directory. + + This operation is non-recursive; any subdirectories in dir will be returned as part of the list, but they will not be listed themselves. + + This operation must be implemented by the various implementations of FileSystem.
        +
        +
        Parameters:
        +
        dir - the directory to list
        +
        Returns:
        +
        a Iterable that iterates over all entries in dir
        +
        Throws:
        +
        XenonException - If the list could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        list

        +
        protected void list(Path dir,
+                    java.util.ArrayList<PathAttributes> list,
+                    boolean recursive)
+             throws XenonException
        +
        Returns an (optionally recursive) listing of the entries in a directory dir. + + This is a generic implementation which relies on listDirectory to provide listings of individual directories.
        +
        +
        Parameters:
        +
        dir - the directory to list.
        +
        list - the list to which the directory entries will be added.
        +
        recursive - if the listing should be done recursively.
        +
        Throws:
        +
        XenonException - If the list could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        copy

        +
        public java.lang.String copy(Path source,
+                             FileSystem destinationFS,
+                             Path destination,
+                             CopyMode mode,
+                             boolean recursive)
        +
        Asynchronously Copy an existing source path to a target path on a different file system. + + If the source path is a file, it will be copied to the destination file on the target file system. + + If the source path is a directory, it will only be copied if recursive is set to true. Otherwise, an exception will be thrown. + When copying recursively, the directory and its content (both files and subdirectories with content), will be copied to destination. + + Exceptions that occur during copying will not be thrown by this function, but instead are contained in a CopyStatus object which can be obtained + with getStatus(String)
        +
        +
        Parameters:
        +
        source - the source path (on this filesystem) to copy from.
        +
        destinationFS - the destination filesystem to copy to.
        +
        destination - the destination path (on the destination filesystem) to copy to.
        +
        mode - how to react if the destination already exists.
        +
        recursive - if the copy should be recursive.
        +
        Returns:
        +
        a String that identifies this copy and be used to inspect its progress.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If source, destinationFS, destination or mode is null.
        +
        +
        • +
      + + + +
        +
      • +

        cancel

        +
        public CopyStatus cancel(java.lang.String copyIdentifier)
+                  throws XenonException
        +
        Cancel a copy operation. Afterwards, the copy is forgotten and subsequent queries with this copy string will lead to NoSuchCopyException
        +
        +
        Parameters:
        +
        copyIdentifier - the identifier of the copy operation which to cancel.
        +
        Returns:
        +
        a CopyStatus containing the status of the copy.
        +
        Throws:
        +
        NoSuchCopyException - If the copy is not known.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        java.lang.IllegalArgumentException - If the copyIdentifier is null.
        +
        +
        • +
      + + + +
        +
      • +

        waitUntilDone

        +
        public CopyStatus waitUntilDone(java.lang.String copyIdentifier,
+                                long timeout)
+                         throws XenonException
        +
        Wait until a copy operation is done or until a timeout expires. +

        + This method will wait until a copy operation is done (either gracefully or by producing an error), or until the timeout expires, whichever comes first. + If the timeout expires, the copy operation will continue to run. +

        +

        + The timeout is in milliseconds and must be >= 0. When timeout is 0, it will be ignored and this method will wait until the copy operation is done. +

        + After this operation, the copy is forgotten and subsequent queries with this copy string will lead to NoSuchCopyException +

        + A CopyStatus is returned that can be used to determine why the call returned. +

        +
        +
        Parameters:
        +
        copyIdentifier - the identifier of the copy operation to wait for.
        +
        timeout - the maximum time to wait for the copy operation in milliseconds.
        +
        Returns:
        +
        a CopyStatus containing the status of the copy.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If argument is illegal.
        +
        NoSuchCopyException - If the copy handle is not known.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        java.lang.IllegalArgumentException - If the copyIdentifier is null or if the value of timeout is negative.
        +
        +
        • +
      + + + +
        +
      • +

        getStatus

        +
        public CopyStatus getStatus(java.lang.String copyIdentifier)
+                     throws XenonException
        +
        Retrieve the status of an copy. After obtaining the status of a completed copy, the copy is forgotten and subsequent queries with this copy string will + lead to NoSuchCopyException.
        +
        +
        Parameters:
        +
        copyIdentifier - the identifier of the copy for which to retrieve the status.
        +
        Returns:
        +
        a CopyStatus containing the status of the asynchronous copy.
        +
        Throws:
        +
        NoSuchCopyException - If the copy is not known.
        +
        NotConnectedException - If file system is closed.
        +
        XenonException - if an I/O error occurred.
        +
        java.lang.IllegalArgumentException - If the copyIdentifier is null.
        +
        +
        • +
      + + + +
        +
      • +

        assertNotNull

        +
        protected void assertNotNull(Path path)
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        areSamePaths

        +
        protected boolean areSamePaths(Path source,
+                               Path target)
        +
        • +
      + + + +
        +
      • +

        isDotDot

        +
        protected boolean isDotDot(Path path)
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystemAdaptorDescription.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystemAdaptorDescription.html new file mode 100644 index 000000000..0cf98c557 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystemAdaptorDescription.html @@ -0,0 +1,367 @@ + + + + + +FileSystemAdaptorDescription (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Interface FileSystemAdaptorDescription

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        supportsThirdPartyCopy

        +
        boolean supportsThirdPartyCopy()
        +
        Does this adaptor support third party copy ? + + In third party copy, a file is copied between two remote locations, without passing through the local machine first.
        +
        +
        Returns:
        +
        if this adaptor supports third party copy.
        +
        +
        • +
      + + + +
        +
      • +

        canReadSymboliclinks

        +
        boolean canReadSymboliclinks()
        +
        Can this adaptor read symbolic links ?
        +
        +
        Returns:
        +
        if this adaptor can read symbolic links.
        +
        +
        • +
      + + + +
        +
      • +

        canCreateSymboliclinks

        +
        boolean canCreateSymboliclinks()
        +
        Can this adaptor create symbolic links ? + + In third party copy, a file is copied between two remote locations, without passing through the local machine first.
        +
        +
        Returns:
        +
        if this adaptor can create symbolic links.
        +
        +
        • +
      + + + +
        +
      • +

        isConnectionless

        +
        boolean isConnectionless()
        +
        • +
      + + + +
        +
      • +

        supportsReadingPosixPermissions

        +
        boolean supportsReadingPosixPermissions()
        +
        • +
      + + + +
        +
      • +

        supportsSettingPosixPermissions

        +
        boolean supportsSettingPosixPermissions()
        +
        • +
      + + + +
        +
      • +

        supportsRename

        +
        boolean supportsRename()
        +
        • +
      + + + +
        +
      • +

        canAppend

        +
        boolean canAppend()
        +
        • +
      + + + +
        +
      • +

        needsSizeBeforehand

        +
        boolean needsSizeBeforehand()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystemClosedException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystemClosedException.html new file mode 100644 index 000000000..87c0f2d53 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystemClosedException.html @@ -0,0 +1,332 @@ + + + + + +FileSystemClosedException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Class FileSystemClosedException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class FileSystemClosedException
+extends XenonException
    +
    Signals that a unknown Copy handle was provided.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      FileSystemClosedException(java.lang.String adaptorName, + java.lang.String message) 
      FileSystemClosedException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FileSystemClosedException

        +
        public FileSystemClosedException(java.lang.String adaptorName,
+                                 java.lang.String message,
+                                 java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        FileSystemClosedException

        +
        public FileSystemClosedException(java.lang.String adaptorName,
+                                 java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidOptionsException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidOptionsException.html new file mode 100644 index 000000000..8933ea1ba --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidOptionsException.html @@ -0,0 +1,332 @@ + + + + + +InvalidOptionsException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Class InvalidOptionsException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class InvalidOptionsException
+extends XenonException
    +
    Signals that an invalid combination of OpenOptions have been specified.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      InvalidOptionsException(java.lang.String adaptorName, + java.lang.String message) 
      InvalidOptionsException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InvalidOptionsException

        +
        public InvalidOptionsException(java.lang.String adaptorName,
+                               java.lang.String message,
+                               java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        InvalidOptionsException

        +
        public InvalidOptionsException(java.lang.String adaptorName,
+                               java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidPathException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidPathException.html new file mode 100644 index 000000000..e0b421530 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidPathException.html @@ -0,0 +1,332 @@ + + + + + +InvalidPathException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Class InvalidPathException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class InvalidPathException
+extends XenonException
    +
    Signals that an end-of-file was encountered.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      InvalidPathException(java.lang.String adaptorName, + java.lang.String message) 
      InvalidPathException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InvalidPathException

        +
        public InvalidPathException(java.lang.String adaptorName,
+                            java.lang.String message,
+                            java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        InvalidPathException

        +
        public InvalidPathException(java.lang.String adaptorName,
+                            java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidResumeTargetException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidResumeTargetException.html new file mode 100644 index 000000000..84146fe8c --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidResumeTargetException.html @@ -0,0 +1,332 @@ + + + + + +InvalidResumeTargetException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Class InvalidResumeTargetException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class InvalidResumeTargetException
+extends XenonException
    +
    Signals that the data in the target of a resume does not match the data in the source.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      InvalidResumeTargetException(java.lang.String adaptorName, + java.lang.String message) 
      InvalidResumeTargetException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InvalidResumeTargetException

        +
        public InvalidResumeTargetException(java.lang.String adaptorName,
+                                    java.lang.String message,
+                                    java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        InvalidResumeTargetException

        +
        public InvalidResumeTargetException(java.lang.String adaptorName,
+                                    java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/NoSuchCopyException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/NoSuchCopyException.html new file mode 100644 index 000000000..ea2c9fd6d --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/NoSuchCopyException.html @@ -0,0 +1,332 @@ + + + + + +NoSuchCopyException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Class NoSuchCopyException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class NoSuchCopyException
+extends XenonException
    +
    Signals that a unknown Copy handle was provided.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      NoSuchCopyException(java.lang.String adaptorName, + java.lang.String message) 
      NoSuchCopyException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NoSuchCopyException

        +
        public NoSuchCopyException(java.lang.String adaptorName,
+                           java.lang.String message,
+                           java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        NoSuchCopyException

        +
        public NoSuchCopyException(java.lang.String adaptorName,
+                           java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/NoSuchPathException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/NoSuchPathException.html new file mode 100644 index 000000000..40bc77f92 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/NoSuchPathException.html @@ -0,0 +1,332 @@ + + + + + +NoSuchPathException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Class NoSuchPathException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class NoSuchPathException
+extends XenonException
    +
    Signals that a path does not exists.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      NoSuchPathException(java.lang.String adaptorName, + java.lang.String message) 
      NoSuchPathException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NoSuchPathException

        +
        public NoSuchPathException(java.lang.String adaptorName,
+                           java.lang.String message,
+                           java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        NoSuchPathException

        +
        public NoSuchPathException(java.lang.String adaptorName,
+                           java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/Path.PathIterator.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/Path.PathIterator.html new file mode 100644 index 000000000..5094eab34 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/Path.PathIterator.html @@ -0,0 +1,360 @@ + + + + + +Path.PathIterator (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Class Path.PathIterator

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.filesystems.Path.PathIterator
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Iterator<Path>
    +
    +
    +
    Enclosing class:
    +
    Path
    +
    +
    +
    +
    private class Path.PathIterator
+extends java.lang.Object
+implements java.util.Iterator<Path>
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private intindex 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      private PathIterator() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanhasNext() 
      Pathnext() 
      voidremove() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.util.Iterator

        +forEachRemaining
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        index

        +
        private int index
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PathIterator

        +
        private PathIterator()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
        +
        +
        Specified by:
        +
        hasNext in interface java.util.Iterator<Path>
        +
        +
        • +
      + + + +
        +
      • +

        next

        +
        public Path next()
        +
        +
        Specified by:
        +
        next in interface java.util.Iterator<Path>
        +
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public void remove()
        +
        +
        Specified by:
        +
        remove in interface java.util.Iterator<Path>
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/Path.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/Path.html new file mode 100644 index 000000000..863bd0037 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/Path.html @@ -0,0 +1,1144 @@ + + + + + +Path (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Class Path

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.filesystems.Path
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<Path>
    +
    +
    +
    +
    public class Path
+extends java.lang.Object
+implements java.lang.Iterable<Path>
    +
    Path contains a sequence of path elements separated by a separator. + + It is designed to be immutable.
    +
    +
    Since:
    +
    1.0
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      private class Path.PathIterator 
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static charDEFAULT_SEPARATOR +
      The default separator to use.
      +
      private java.util.List<java.lang.String>elements +
      The path elements in this path
      +
      private booleanisAbsolute +
      Does path start with / ?
      +
      private static intPATH_ELEMENT_LENGTH +
      Estimate of path element String length.
      +
      private charseparator +
      The separator used in this path
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      Path() +
      Create a new empty Path using the default separator.
      +
      Path(boolean isAbsolute, + java.util.List<java.lang.String> elements) +
      Create a new Path using the given path elements and the default separator.
      +
      Path(boolean isAbsolute, + java.lang.String... elements) +
      Create a new Path using the given path elements and the default separator.
      +
      Path(char separator, + boolean isAbsolute, + java.util.List<java.lang.String> elements) +
      Create a new Path using the given path separator, absoluteness, and elements.
      +
      Path(char separator, + boolean isAbsolute, + java.lang.String... elements) +
      Create a new Path using the given path elements and the provided separator.
      +
      Path(char separator, + java.lang.String path) +
      Create a new Path by parsing path using the provided separator.
      +
      Path(java.lang.String path) +
      Create a new Path by parsing path using the default separator.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      protected static java.util.List<java.lang.String>checkForNullAndSeparator(char separator, + java.util.List<java.lang.String> elements) 
      booleanendsWith(Path other) +
      Tests if this Path ends with the given Path.
      +
      booleanendsWith(java.lang.String other) +
      Tests if this Path ends with the given Path represented as a String.
      +
      booleanequals(java.lang.Object obj) 
      private java.lang.StringgetAbsolutePath() +
      Return a String representation of this Path interpreted as an absolute path.
      +
      PathgetFileName() +
      Get the file name or null if the Path is empty.
      +
      java.lang.StringgetFileNameAsString() +
      Get the file name as a String, or null if the Path is empty.
      +
      PathgetName(int index) +
      Get an element of this Path.
      +
      intgetNameCount() +
      Get the number of elements in the Path.
      +
      PathgetParent() +
      Get the parent Path, or null if this Path does not have a parent.
      +
      private java.lang.StringgetRelativePath() +
      Return a String representation of this Path interpreted as a relative path.
      +
      chargetSeparator() +
      Get the separator.
      +
      inthashCode() 
      booleanisAbsolute() 
      booleanisEmpty() +
      Is this Path empty ?
      +
      java.util.Iterator<Path>iterator() +
      Create an Iterator that returns all possible sub Paths of this Path, in order of increasing length.
      +
      Pathnormalize() +
      Normalize this Path by removing as many redundant path elements as possible.
      +
      Pathrelativize(Path other) +
      Create a relative Path between the given Path and this Path.
      +
      Pathresolve(Path other) +
      Resolve a Path against this Path.
      +
      Pathresolve(java.lang.String other) +
      Resolve a Path represented as a String against this path.
      +
      PathresolveSibling(Path other) +
      Resolves the given Path to this paths parent Path, thereby creating a sibling to this Path.
      +
      booleanstartsWith(Path other) +
      Tests if this Path starts with the given Path.
      +
      booleanstartsWith(java.lang.String other) +
      Tests if this Path starts with the given Path represented as a String.
      +
      Pathsubpath(int beginIndex, + int endIndex) +
      Returns a Path that is a subsequence of the name elements of this path.
      +
      PathtoAbsolutePath() 
      PathtoRelativePath() 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        DEFAULT_SEPARATOR

        +
        public static final char DEFAULT_SEPARATOR
        +
        The default separator to use.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        elements

        +
        private final java.util.List<java.lang.String> elements
        +
        The path elements in this path
        +
        • +
      + + + +
        +
      • +

        separator

        +
        private final char separator
        +
        The separator used in this path
        +
        • +
      + + + +
        +
      • +

        isAbsolute

        +
        private boolean isAbsolute
        +
        Does path start with / ?
        +
        • +
      + + + +
        +
      • +

        PATH_ELEMENT_LENGTH

        +
        private static final int PATH_ELEMENT_LENGTH
        +
        Estimate of path element String length.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Path

        +
        public Path()
        +
        Create a new empty Path using the default separator.
        +
        • +
      + + + +
        +
      • +

        Path

        +
        public Path(java.lang.String path)
        +
        Create a new Path by parsing path using the default separator. + + If path is null or an empty String, the resulting Path is empty and relative. Otherwise it will be split into multiple elements + using the default separator. If path starts with a separator, the resulting path will be absolute. Otherwise, it will be relative.
        +
        +
        Parameters:
        +
        path - the path to parse
        +
        +
        • +
      + + + +
        +
      • +

        Path

        +
        public Path(char separator,
+            java.lang.String path)
        +
        Create a new Path by parsing path using the provided separator. + + If path is null or an empty String, the resulting Path is empty and relative. Otherwise it will be split into multiple elements + using the provided separator. If path starts with a separator, the resulting path will be absolute. Otherwise, it will be relative.
        +
        +
        Parameters:
        +
        separator - the separator to use
        +
        path - the path to parse
        +
        +
        • +
      + + + +
        +
      • +

        Path

        +
        public Path(boolean isAbsolute,
+            java.lang.String... elements)
        +
        Create a new Path using the given path elements and the default separator. + + If elements is null or empty, the resulting Path is empty. The elements may not contain null or empty + Strings. The elements will not be parsed individually, and may not contain the separator character.
        +
        +
        Parameters:
        +
        isAbsolute - should the resulting path must be absolute?
        +
        elements - the path elements to use.
        +
        +
        • +
      + + + +
        +
      • +

        Path

        +
        public Path(char separator,
+            boolean isAbsolute,
+            java.lang.String... elements)
        +
        Create a new Path using the given path elements and the provided separator. + + If elements is null or empty, the resulting Path is empty. The elements may not contain null or empty + Strings. The elements will not be parsed individually, and may not contain the separator character.
        +
        +
        Parameters:
        +
        separator - the separator to use.
        +
        isAbsolute - should the resulting path must be absolute?
        +
        elements - the path elements to use.
        +
        +
        • +
      + + + +
        +
      • +

        Path

        +
        public Path(boolean isAbsolute,
+            java.util.List<java.lang.String> elements)
        +
        Create a new Path using the given path elements and the default separator. + + If elements is null or empty, the resulting Path is empty. The elements list may not contain null or + empty Strings, or Strings that contain the separator character. If they do, an IllegalArgumentException will be thrown.
        +
        +
        Parameters:
        +
        isAbsolute - should the resulting path must be absolute?
        +
        elements - the path elements to use.
        +
        +
        • +
      + + + +
        +
      • +

        Path

        +
        public Path(char separator,
+            boolean isAbsolute,
+            java.util.List<java.lang.String> elements)
        +
        Create a new Path using the given path separator, absoluteness, and elements. + + If elements is null or empty, the resulting Path is empty. The elements list may not contain null or + empty Strings, or Strings that contain the separator character. If they do, an IllegalArgumentException will be thrown.
        +
        +
        Parameters:
        +
        separator - the separator to use.
        +
        isAbsolute - should the resulting path should be absolute ?
        +
        elements - the path elements to use.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        checkForNullAndSeparator

        +
        protected static java.util.List<java.lang.String> checkForNullAndSeparator(char separator,
+                                                                           java.util.List<java.lang.String> elements)
        +
        • +
      + + + +
        +
      • +

        getFileName

        +
        public Path getFileName()
        +
        Get the file name or null if the Path is empty. + + The file name is the last element of the Path.
        +
        +
        Returns:
        +
        the resulting file name or null.
        +
        +
        • +
      + + + +
        +
      • +

        getFileNameAsString

        +
        public java.lang.String getFileNameAsString()
        +
        Get the file name as a String, or null if the Path is empty. + + The file name is the last element of the Path.
        +
        +
        Returns:
        +
        the resulting file name or null.
        +
        +
        • +
      + + + +
        +
      • +

        getSeparator

        +
        public char getSeparator()
        +
        Get the separator.
        +
        +
        Returns:
        +
        the separator.
        +
        +
        • +
      + + + +
        +
      • +

        getParent

        +
        public Path getParent()
        +
        Get the parent Path, or null if this Path does not have a parent. + + The parent path will contain all path elements in this pasth except the last one.
        +
        +
        Returns:
        +
        a Path representing this Paths parent.
        +
        +
        • +
      + + + +
        +
      • +

        getNameCount

        +
        public int getNameCount()
        +
        Get the number of elements in the Path.
        +
        +
        Returns:
        +
        the number of elements in the Path, or 0 if this path is empty.
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public Path getName(int index)
        +
        Get an element of this Path. Path elements indices start at 0.
        +
        +
        Parameters:
        +
        index - the index of the element
        +
        Returns:
        +
        the element at the specified index
        +
        Throws:
        +
        java.lang.IndexOutOfBoundsException - If the index is negative or greater or equal to the number of elements in the path.
        +
        +
        • +
      + + + +
        +
      • +

        subpath

        +
        public Path subpath(int beginIndex,
+                    int endIndex)
        +
        Returns a Path that is a subsequence of the name elements of this path. Path elements indices start at 0.
        +
        +
        Parameters:
        +
        beginIndex - the index of the first element, inclusive
        +
        endIndex - the index of the last element, exclusive
        +
        Returns:
        +
        a new Path that is a subsequence of the name elements in this path.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If beginIndex is larger than or equal to the endIndex.
        +
        java.lang.ArrayIndexOutOfBoundsException - If beginIndex < 0 or beginIndex > elements.length
        +
        +
        • +
      + + + +
        +
      • +

        startsWith

        +
        public boolean startsWith(Path other)
        +
        Tests if this Path starts with the given Path. + + This method returns true if this Path starts with the same sequence of the name elements as the given Path. In addition, the absoluteness of + this Path should match the absoluteness of the given Path. + + False is returned if the given Path starts with a different sequence of elements, has more name elements than this path, or has a different absoluteness + than this path.
        +
        +
        Parameters:
        +
        other - the Path to compare to.
        +
        Returns:
        +
        If this Path start with the name elements in the other Path and has the same absoluteness.
        +
        +
        • +
      + + + +
        +
      • +

        endsWith

        +
        public boolean endsWith(Path other)
        +
        Tests if this Path ends with the given Path. + + This method returns true if this Path end with the name elements in the given Path. If the given Path has more name elements than this Path + then false is returned.
        +
        +
        Parameters:
        +
        other - the Path to compare to.
        +
        Returns:
        +
        If this Path ends with the name elements in the other Path.
        +
        +
        • +
      + + + +
        +
      • +

        startsWith

        +
        public boolean startsWith(java.lang.String other)
        +
        Tests if this Path starts with the given Path represented as a String. + + This method converts other into a Path using Path(String) and then uses startsWith(Path) to compare the + result to this Path.
        +
        +
        Parameters:
        +
        other - the path to test.
        +
        Returns:
        +
        If this Path start with the name elements in other.
        +
        +
        • +
      + + + +
        +
      • +

        endsWith

        +
        public boolean endsWith(java.lang.String other)
        +
        Tests if this Path ends with the given Path represented as a String. + + This method converts the other into a Path using Path(String) and then uses endsWith(Path) to compare the + result to this path.
        +
        +
        Parameters:
        +
        other - the path to test.
        +
        Returns:
        +
        If this Path ends with the elements in other.
        +
        +
        • +
      + + + +
        +
      • +

        resolve

        +
        public Path resolve(Path other)
        +
        Resolve a Path against this Path. + + Returns a new Path that concatenates the path elements of this Path with other. The resulting path will use the separator and absoluteness + of this path.
        +
        +
        Parameters:
        +
        other - the Path to concatenate with.
        +
        Returns:
        +
        concatenation of this Path with the other
        +
        +
        • +
      + + + +
        +
      • +

        resolve

        +
        public Path resolve(java.lang.String other)
        +
        Resolve a Path represented as a String against this path. + + Converts other into a Path using Path(char, String) and the separator of the this path. Next, resolve(Path) + is used to resolve the result against this path.
        +
        +
        Parameters:
        +
        other - the path to concatenate with.
        +
        Returns:
        +
        concatenation of this Path with the other
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Is this Path empty ?
        +
        +
        Returns:
        +
        If this Path is empty.
        +
        +
        • +
      + + + +
        +
      • +

        resolveSibling

        +
        public Path resolveSibling(Path other)
        +
        Resolves the given Path to this paths parent Path, thereby creating a sibling to this Path. + + If this Path is empty, other will be returned, unless other is null in which case an empty Path is returned. + + If this Path is not empty, but other is null or empty, the parent of this Path will be returned. + + If neither this Path and other are empty, getParent.resolve(other) will be returned.
        +
        +
        Parameters:
        +
        other - the Path to resolve as sibling.
        +
        Returns:
        +
        a Path representing the sibling.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If the Path can not be resolved as a sibling to this Path.
        +
        +
        • +
      + + + +
        +
      • +

        relativize

        +
        public Path relativize(Path other)
        +
        Create a relative Path between the given Path and this Path. + + Relativation is the inverse of resolving. This method returns a Path that, when resolved against this Path, results in the given Path other.
        +
        +
        Parameters:
        +
        other - the Path to relativize.
        +
        Returns:
        +
        a Path representing a relative path between the given path and this path.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If the path can not be relativized to this path.
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<Path> iterator()
        +
        Create an Iterator that returns all possible sub Paths of this Path, in order of increasing length. + + For example, for the Path "/a/b/c/d" the iterator returns "/a", "/a/b", "/a/b/c", "/a/b/c/d".
        +
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<Path>
        +
        Returns:
        +
        the iterator.
        +
        +
        • +
      + + + +
        +
      • +

        getRelativePath

        +
        private java.lang.String getRelativePath()
        +
        Return a String representation of this Path interpreted as a relative path. + + A relative path does not start with a separator.
        +
        +
        Returns:
        +
        a String representation of this Path interpreted as a relative path.
        +
        +
        • +
      + + + +
        +
      • +

        getAbsolutePath

        +
        private java.lang.String getAbsolutePath()
        +
        Return a String representation of this Path interpreted as an absolute path. + + An absolute path starts with a separator.
        +
        +
        Returns:
        +
        a String representation of this path interpreted as an absolute path.
        +
        +
        • +
      + + + +
        +
      • +

        normalize

        +
        public Path normalize()
        +
        Normalize this Path by removing as many redundant path elements as possible. + + Redundant path elements are "." (indicating the current directory) and ".." (indicating the parent directory). + + Note that the resulting normalized path does may still contain ".." elements which are not redundant.
        +
        +
        Returns:
        +
        the normalize path.
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        isAbsolute

        +
        public boolean isAbsolute()
        +
        • +
      + + + +
        +
      • +

        toRelativePath

        +
        public Path toRelativePath()
        +
        • +
      + + + +
        +
      • +

        toAbsolutePath

        +
        public Path toAbsolutePath()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PathAlreadyExistsException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PathAlreadyExistsException.html new file mode 100644 index 000000000..ee08c2a21 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PathAlreadyExistsException.html @@ -0,0 +1,332 @@ + + + + + +PathAlreadyExistsException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Class PathAlreadyExistsException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class PathAlreadyExistsException
+extends XenonException
    +
    Signals that a path already exists.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      PathAlreadyExistsException(java.lang.String adaptorName, + java.lang.String message) 
      PathAlreadyExistsException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PathAlreadyExistsException

        +
        public PathAlreadyExistsException(java.lang.String adaptorName,
+                                  java.lang.String message,
+                                  java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        PathAlreadyExistsException

        +
        public PathAlreadyExistsException(java.lang.String adaptorName,
+                                  java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PathAttributes.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PathAttributes.html new file mode 100644 index 000000000..e48616257 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PathAttributes.html @@ -0,0 +1,547 @@ + + + + + +PathAttributes (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Interface PathAttributes

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    PathAttributesImplementation
    +
    +
    +
    +
    public interface PathAttributes
    +
    FileAttributes represents a set of attributes of a path.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      longgetCreationTime() +
      Get the creation time for this file.
      +
      java.lang.StringgetGroup() +
      Get the group of this file (optional operation).
      +
      longgetLastAccessTime() +
      Get the last access time for this file.
      +
      longgetLastModifiedTime() +
      Get the last modified time for this file.
      +
      java.lang.StringgetOwner() +
      Get the owner of this file (optional operation).
      +
      PathgetPath() +
      Get the path these attributes belong to.
      +
      java.util.Set<PosixFilePermission>getPermissions() +
      Get the permissions of this file (optional operation).
      +
      longgetSize() +
      Get the size of this file in bytes.
      +
      booleanisDirectory() +
      Does the path refer to a directory ?
      +
      booleanisExecutable() +
      Does the path refer to an executable file ?
      +
      booleanisHidden() +
      Does the path refer to an hidden file ?
      +
      booleanisOther() +
      Is the path not a file, link or directory ?
      +
      booleanisReadable() +
      Does the path refer to an readable file ?
      +
      booleanisRegular() +
      Does the path refer to a regular file ?
      +
      booleanisSymbolicLink() +
      Does the path refer to a symbolic link ?
      +
      booleanisWritable() +
      Does the path refer to a writable file ?
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPath

        +
        Path getPath()
        +
        Get the path these attributes belong to.
        +
        +
        Returns:
        +
        the path these attributes belong to.
        +
        +
        • +
      + + + +
        +
      • +

        isDirectory

        +
        boolean isDirectory()
        +
        Does the path refer to a directory ?
        +
        +
        Returns:
        +
        if the path refers to a directory.
        +
        +
        • +
      + + + +
        +
      • +

        isRegular

        +
        boolean isRegular()
        +
        Does the path refer to a regular file ?
        +
        +
        Returns:
        +
        if the path refers to a regular file.
        +
        +
        • +
      + + + +
        +
      • +

        isSymbolicLink

        +
        boolean isSymbolicLink()
        +
        Does the path refer to a symbolic link ?
        +
        +
        Returns:
        +
        if the path refers to a symbolic link.
        +
        +
        • +
      + + + +
        +
      • +

        isOther

        +
        boolean isOther()
        +
        Is the path not a file, link or directory ?
        +
        +
        Returns:
        +
        if the path does not refer to a file, link or directory.
        +
        +
        • +
      + + + +
        +
      • +

        isExecutable

        +
        boolean isExecutable()
        +
        Does the path refer to an executable file ?
        +
        +
        Returns:
        +
        if the path refers an executable file ?
        +
        +
        • +
      + + + +
        +
      • +

        isReadable

        +
        boolean isReadable()
        +
        Does the path refer to an readable file ?
        +
        +
        Returns:
        +
        if the path refers an readable file ?
        +
        +
        • +
      + + + +
        +
      • +

        isWritable

        +
        boolean isWritable()
        +
        Does the path refer to a writable file ?
        +
        +
        Returns:
        +
        if the path refers a writable file ?
        +
        +
        • +
      + + + +
        +
      • +

        isHidden

        +
        boolean isHidden()
        +
        Does the path refer to an hidden file ?
        +
        +
        Returns:
        +
        if the path refers an hidden file ?
        +
        +
        • +
      + + + +
        +
      • +

        getCreationTime

        +
        long getCreationTime()
        +
        Get the creation time for this file. + + If creationTime is not supported by the adaptor, getLastModifiedTime() will be returned instead.
        +
        +
        Returns:
        +
        the creation time for this file.
        +
        +
        • +
      + + + +
        +
      • +

        getLastAccessTime

        +
        long getLastAccessTime()
        +
        Get the last access time for this file. + + If lastAccessTime is not supported by the adaptor, use getLastModifiedTime() will be returned instead.
        +
        +
        Returns:
        +
        the last access time for this file.
        +
        +
        • +
      + + + +
        +
      • +

        getLastModifiedTime

        +
        long getLastModifiedTime()
        +
        Get the last modified time for this file. + + If lastModifiedTime is not supported by the adaptor, 0 will be returned instead.
        +
        +
        Returns:
        +
        the last modified time for this file.
        +
        +
        • +
      + + + +
        +
      • +

        getSize

        +
        long getSize()
        +
        Get the size of this file in bytes. + + If the file is not a regular file, 0 will be returned.
        +
        +
        Returns:
        +
        the size of this file.
        +
        +
        • +
      + + + + + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PosixFilePermission.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PosixFilePermission.html new file mode 100644 index 000000000..bd8461c98 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PosixFilePermission.html @@ -0,0 +1,481 @@ + + + + + +PosixFilePermission (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.filesystems
+

Enum PosixFilePermission

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Enum<PosixFilePermission>
      • +
    • +
        +
      • nl.esciencecenter.xenon.filesystems.PosixFilePermission
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<PosixFilePermission>
    +
    +
    +
    +
    public enum PosixFilePermission
+extends java.lang.Enum<PosixFilePermission>
    +
    PosixFilePermission is an enumeration containing all supported Posix file permissions.
    +
    +
    Since:
    +
    1.0
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static booleancontains(PosixFilePermission toFind, + PosixFilePermission... options) +
      Check if a sequence of PosixFilePermissions contains a specific option.
      +
      static PosixFilePermissionvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static PosixFilePermission[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static PosixFilePermission[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (PosixFilePermission c : PosixFilePermission.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static PosixFilePermission valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      + + + +
        +
      • +

        contains

        +
        public static boolean contains(PosixFilePermission toFind,
+                               PosixFilePermission... options)
        +
        Check if a sequence of PosixFilePermissions contains a specific option. + + If option or options is null, false will be returned.
        +
        +
        Parameters:
        +
        toFind - the option to find.
        +
        options - the options to check.
        +
        Returns:
        +
        if options contains option.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/package-frame.html new file mode 100644 index 000000000..d6c37d312 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/package-frame.html @@ -0,0 +1,45 @@ + + + + + +nl.esciencecenter.xenon.filesystems (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.filesystems

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +

Exceptions

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/package-summary.html new file mode 100644 index 000000000..0cd2e5754 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/package-summary.html @@ -0,0 +1,281 @@ + + + + + +nl.esciencecenter.xenon.filesystems (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.filesystems

+
+
This package contains classes and interfaces for manipulating files.
+
+

See: Description

+
+
+ + + + +

Package nl.esciencecenter.xenon.filesystems Description

+
This package contains classes and interfaces for manipulating files.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/package-tree.html new file mode 100644 index 000000000..25921e0d0 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/package-tree.html @@ -0,0 +1,184 @@ + + + + + +nl.esciencecenter.xenon.filesystems Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.filesystems

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+
    +
  • java.lang.Object +
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
      • +
    +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/package-frame.html new file mode 100644 index 000000000..7228af4c4 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/package-frame.html @@ -0,0 +1,39 @@ + + + + + +nl.esciencecenter.xenon (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +

Exceptions

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/package-summary.html new file mode 100644 index 000000000..4ab21dd18 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/package-summary.html @@ -0,0 +1,249 @@ + + + + + +nl.esciencecenter.xenon (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon

+
+
This package is the main entry point into the Xenon API.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    AdaptorDescription +
    AdaptorStatus contains information on a specific adaptor.
    +
    +
    • +
  • + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    XenonPropertyDescription +
    XenonPropertyDescription contains all necessary information about a property that is recognized by Xenon
    +
    +
    • +
  • + + + + + + + + + + + + +
    Enum Summary 
    EnumDescription
    XenonPropertyDescription.Type +
    This Type enumeration lists all possible types of properties recognized by Xenon.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Exception Summary 
    ExceptionDescription
    InvalidCredentialException +
    Signals that an invalid credential was used to access a resource.
    +
    InvalidLocationException +
    Signals that an invalid location was provided.
    +
    InvalidPropertyException +
    Signals that a property has a different type than the get method it was retrieved with.
    +
    PropertyTypeException +
    Signals that a property has a different type than the get method it was retrieved with.
    +
    UnknownAdaptorException +
    Thrown when an unknown adaptor name is provided.
    +
    UnknownPropertyException +
    Signals that a property has a different type than the get method it was retrieved with.
    +
    UnsupportedOperationException +
    Throw when an unsupported optional operation is called.
    +
    XenonException +
    XenonException is the parent exception for all exceptions raised in Xenon.
    +
    XenonRuntimeException +
    XenonRuntimeException is the parent for all runtime exceptions raised in Xenon.
    +
    +
    • +
+ + + +

Package nl.esciencecenter.xenon Description

+
This package is the main entry point into the Xenon API.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/package-tree.html new file mode 100644 index 000000000..aee9b1944 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/package-tree.html @@ -0,0 +1,174 @@ + + + + + +nl.esciencecenter.xenon Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/IncompleteJobDescriptionException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/IncompleteJobDescriptionException.html new file mode 100644 index 000000000..4eb095637 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/IncompleteJobDescriptionException.html @@ -0,0 +1,332 @@ + + + + + +IncompleteJobDescriptionException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.schedulers
+

Class IncompleteJobDescriptionException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class IncompleteJobDescriptionException
+extends XenonException
    +
    Signals that a JobDescription is missing required options.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IncompleteJobDescriptionException

        +
        public IncompleteJobDescriptionException(java.lang.String adaptorName,
+                                         java.lang.String message,
+                                         java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        IncompleteJobDescriptionException

        +
        public IncompleteJobDescriptionException(java.lang.String adaptorName,
+                                         java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/InvalidJobDescriptionException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/InvalidJobDescriptionException.html new file mode 100644 index 000000000..d74e0fc30 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/InvalidJobDescriptionException.html @@ -0,0 +1,332 @@ + + + + + +InvalidJobDescriptionException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.schedulers
+

Class InvalidJobDescriptionException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class InvalidJobDescriptionException
+extends XenonException
    +
    Signals that a JobDescription contains invalid values for certain options.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InvalidJobDescriptionException

        +
        public InvalidJobDescriptionException(java.lang.String adaptorName,
+                                      java.lang.String message,
+                                      java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        InvalidJobDescriptionException

        +
        public InvalidJobDescriptionException(java.lang.String adaptorName,
+                                      java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/JobDescription.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/JobDescription.html new file mode 100644 index 000000000..9202cbb54 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/JobDescription.html @@ -0,0 +1,1445 @@ + + + + + +JobDescription (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.schedulers
+

Class JobDescription

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.schedulers.JobDescription
      • +
    +
    • +
+
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    JavaJobDescription
    +
    +
    +
    +
    public class JobDescription
+extends java.lang.Object
    +
    JobDescription contains a description of a job that can be submitted to a Scheduler.
    +
    +
    Since:
    +
    1.0
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.util.List<java.lang.String>arguments +
      The arguments to pass to the executable.
      +
      static intDEFAULT_MAX_RUN_TIME_IN_MINUTES +
      The default maximum run time
      +
      private java.util.Map<java.lang.String,java.lang.String>environment +
      The environment variables and their values
      +
      private java.lang.Stringexecutable +
      The executable to run.
      +
      private java.util.Map<java.lang.String,java.lang.String>jobOptions +
      The job options of this job
      +
      private intmaxMemory +
      The maximum amount of memory needed (in MB) on each node/process.
      +
      private intmaxRuntime +
      The maximum run time in minutes.
      +
      private java.lang.Stringname +
      The name of the job.
      +
      private intnodeCount +
      The number of nodes to run the job on.
      +
      private intprocessesPerNode +
      The number of processes to start/reserve per node.
      +
      private java.lang.StringqueueName +
      The queue to submit to.
      +
      private java.util.List<java.lang.String>schedulerArguments +
      The arguments to pass to the scheduler.
      +
      private booleanstartSingleProcess +
      If true, only a single process is started on the first node aquired, instead of nodeCount * processesPerNode.
      +
      private java.lang.Stringstderr +
      The location file which to redirect stderr to.
      +
      private java.lang.Stringstdin +
      The location file from which to redirect stdin.
      +
      private java.lang.Stringstdout +
      The location file which to redirect stdout to.
      +
      private intthreadsPerProcess +
      The number of threads the executable will use per processes
      +
      private java.lang.StringworkingDirectory +
      The working directory for the job.
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      JobDescription() +
      Create a JobDescription.
      +
      JobDescription(JobDescription original) +
      Create a JobDescription by copying an existing one.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidaddArgument(java.lang.String argument) +
      Add a command line argument for the executable.
      +
      voidaddEnvironment(java.lang.String key, + java.lang.String value) +
      Add a variable to the environment of the executable.
      +
      voidaddJobOption(java.lang.String key, + java.lang.String value) +
      Add a job option to the job.
      +
      voidaddSchedulerArgument(java.lang.String argument) +
      Add a scheduler specific argument.
      +
      booleanequals(java.lang.Object obj) 
      java.util.List<java.lang.String>getArguments() +
      Get the command line arguments of the executable.
      +
      java.util.Map<java.lang.String,java.lang.String>getEnvironment() +
      Get the environment of the executable.
      +
      java.lang.StringgetExecutable() +
      Get the path to the executable.
      +
      java.util.Map<java.lang.String,java.lang.String>getJobOptions() +
      Get a copy of the job options of this job.
      +
      intgetMaxMemory() +
      Get the amount of memory needed for process (in MBytes).
      +
      intgetMaxRuntime() +
      Get the maximum job duration time in minutes.
      +
      java.lang.StringgetName() +
      Get the job name.
      +
      intgetNodeCount() +
      Get the number of nodes.
      +
      intgetProcessesPerNode() +
      Get the number of processes to start on each node.
      +
      java.lang.StringgetQueueName() +
      Get the queue name;
      +
      java.util.List<java.lang.String>getSchedulerArguments() +
      Get the scheduler specific arguments.
      +
      java.lang.StringgetStderr() +
      Gets the path to the file to which the executable must redirect stderr.
      +
      java.lang.StringgetStdin() +
      Gets the path to the file from which the executable must redirect stdin.
      +
      java.lang.StringgetStdout() +
      Gets the path to the file to which the executable must redirect stdout.
      +
      intgetThreadsPerProcess() +
      Get the number of threads needed per process.
      +
      java.lang.StringgetWorkingDirectory() +
      Gets the path of the working directory for the executable.
      +
      inthashCode() 
      booleanisStartSingleProcess() +
      Is only a single process started?
      +
      voidsetArguments(java.lang.String... arguments) +
      Sets the command line arguments of the executable.
      +
      voidsetEnvironment(java.util.Map<java.lang.String,java.lang.String> environment) +
      Sets the environment of the executable.
      +
      voidsetExecutable(java.lang.String executable) +
      Sets the path to the executable.
      +
      voidsetJobOptions(java.util.Map<java.lang.String,java.lang.String> options) +
      Sets the job options of the job.
      +
      voidsetMaxMemory(int maxMemoryInMB) +
      Set the amount of memory needed for process (in MBytes).
      +
      voidsetMaxRuntime(int minutes) +
      Set the maximum job duration in minutes.
      +
      voidsetName(java.lang.String name) +
      Set the name of the job.
      +
      voidsetNodeCount(int nodeCount) +
      Set the number of nodes.
      +
      voidsetProcessesPerNode(int processesPerNode) +
      Set the number of processes started on each node.
      +
      voidsetQueueName(java.lang.String queueName) +
      Set the queue name;
      +
      voidsetSchedulerArguments(java.lang.String... arguments) +
      Sets the scheduler specific arguments for this job.
      +
      voidsetStartSingleProcess(boolean startSingleProcess) +
      Set if only a single process is started, instead of nodeCount * processesPerNode.
      +
      voidsetStderr(java.lang.String stderr) +
      Sets the path to the file to which the executable must redirect stderr.
      +
      voidsetStdin(java.lang.String stdin) +
      Sets the path to the file from which the executable must redirect stdin.
      +
      voidsetStdout(java.lang.String stdout) +
      Sets the path to the file to which the executable must redirect stdout.
      +
      voidsetThreadsPerProcess(int threadsPerProcess) +
      Set the number of threads needed per process.
      +
      voidsetWorkingDirectory(java.lang.String workingDirectory) +
      Sets the path of the working directory for the executable.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        DEFAULT_MAX_RUN_TIME_IN_MINUTES

        +
        public static final int DEFAULT_MAX_RUN_TIME_IN_MINUTES
        +
        The default maximum run time
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        queueName

        +
        private java.lang.String queueName
        +
        The queue to submit to.
        +
        • +
      + + + +
        +
      • +

        executable

        +
        private java.lang.String executable
        +
        The executable to run.
        +
        • +
      + + + +
        +
      • +

        name

        +
        private java.lang.String name
        +
        The name of the job.
        +
        • +
      + + + +
        +
      • +

        arguments

        +
        private final java.util.List<java.lang.String> arguments
        +
        The arguments to pass to the executable.
        +
        • +
      + + + +
        +
      • +

        schedulerArguments

        +
        private final java.util.List<java.lang.String> schedulerArguments
        +
        The arguments to pass to the scheduler.
        +
        • +
      + + + +
        +
      • +

        stdin

        +
        private java.lang.String stdin
        +
        The location file from which to redirect stdin. (optional)
        +
        • +
      + + + +
        +
      • +

        stdout

        +
        private java.lang.String stdout
        +
        The location file which to redirect stdout to. (optional)
        +
        • +
      + + + +
        +
      • +

        stderr

        +
        private java.lang.String stderr
        +
        The location file which to redirect stderr to. (optional)
        +
        • +
      + + + +
        +
      • +

        workingDirectory

        +
        private java.lang.String workingDirectory
        +
        The working directory for the job.
        +
        • +
      + + + +
        +
      • +

        environment

        +
        private final java.util.Map<java.lang.String,java.lang.String> environment
        +
        The environment variables and their values
        +
        • +
      + + + +
        +
      • +

        jobOptions

        +
        private final java.util.Map<java.lang.String,java.lang.String> jobOptions
        +
        The job options of this job
        +
        • +
      + + + +
        +
      • +

        nodeCount

        +
        private int nodeCount
        +
        The number of nodes to run the job on.
        +
        • +
      + + + +
        +
      • +

        processesPerNode

        +
        private int processesPerNode
        +
        The number of processes to start/reserve per node.
        +
        • +
      + + + +
        +
      • +

        threadsPerProcess

        +
        private int threadsPerProcess
        +
        The number of threads the executable will use per processes
        +
        • +
      + + + +
        +
      • +

        maxMemory

        +
        private int maxMemory
        +
        The maximum amount of memory needed (in MB) on each node/process.
        +
        • +
      + + + +
        +
      • +

        startSingleProcess

        +
        private boolean startSingleProcess
        +
        If true, only a single process is started on the first node aquired, instead of nodeCount * processesPerNode.
        +
        • +
      + + + +
        +
      • +

        maxRuntime

        +
        private int maxRuntime
        +
        The maximum run time in minutes.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        JobDescription

        +
        public JobDescription()
        +
        Create a JobDescription.
        +
        • +
      + + + +
        +
      • +

        JobDescription

        +
        public JobDescription(JobDescription original)
        +
        Create a JobDescription by copying an existing one.
        +
        +
        Parameters:
        +
        original - JobDescription to copy
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        Get the job name.
        +
        +
        Returns:
        +
        the job name.
        +
        +
        • +
      + + + +
        +
      • +

        setName

        +
        public void setName(java.lang.String name)
        +
        Set the name of the job.
        +
        +
        Parameters:
        +
        name - the name of the job;
        +
        +
        • +
      + + + +
        +
      • +

        getNodeCount

        +
        public int getNodeCount()
        +
        Get the number of nodes.
        +
        +
        Returns:
        +
        the number of nodes.
        +
        +
        • +
      + + + +
        +
      • +

        setNodeCount

        +
        public void setNodeCount(int nodeCount)
        +
        Set the number of nodes.
        +
        +
        Parameters:
        +
        nodeCount - the number of nodes;
        +
        +
        • +
      + + + +
        +
      • +

        getProcessesPerNode

        +
        public int getProcessesPerNode()
        +
        Get the number of processes to start on each node.
        +
        +
        Returns:
        +
        the number of processesPerNode.
        +
        +
        • +
      + + + +
        +
      • +

        setProcessesPerNode

        +
        public void setProcessesPerNode(int processesPerNode)
        +
        Set the number of processes started on each node.
        +
        +
        Parameters:
        +
        processesPerNode - the number of processes started on each node.
        +
        +
        • +
      + + + +
        +
      • +

        getThreadsPerProcess

        +
        public int getThreadsPerProcess()
        +
        Get the number of threads needed per process.
        +
        +
        Returns:
        +
        the number of threads per process.
        +
        +
        • +
      + + + +
        +
      • +

        setThreadsPerProcess

        +
        public void setThreadsPerProcess(int threadsPerProcess)
        +
        Set the number of threads needed per process.
        +
        +
        Parameters:
        +
        threadsPerProcess - the number of threads needed per process.
        +
        +
        • +
      + + + +
        +
      • +

        getMaxMemory

        +
        public int getMaxMemory()
        +
        Get the amount of memory needed for process (in MBytes).
        +
        +
        Returns:
        +
        the amount of memory needed.
        +
        +
        • +
      + + + +
        +
      • +

        setMaxMemory

        +
        public void setMaxMemory(int maxMemoryInMB)
        +
        Set the amount of memory needed for process (in MBytes).
        +
        +
        Parameters:
        +
        maxMemoryInMB - the amount of memory needed per node/process.
        +
        +
        • +
      + + + +
        +
      • +

        isStartSingleProcess

        +
        public boolean isStartSingleProcess()
        +
        Is only a single process started?
        +
        +
        Returns:
        +
        if only a single process is started.
        +
        +
        • +
      + + + +
        +
      • +

        setStartSingleProcess

        +
        public void setStartSingleProcess(boolean startSingleProcess)
        +
        Set if only a single process is started, instead of nodeCount * processesPerNode. Resources are still reserved, but it is up to the user to start all the + processes. Mainly useful for MPI.
        +
        +
        Parameters:
        +
        startSingleProcess - if only a single process is started.
        +
        +
        • +
      + + + +
        +
      • +

        getQueueName

        +
        public java.lang.String getQueueName()
        +
        Get the queue name;
        +
        +
        Returns:
        +
        the queue name;
        +
        +
        • +
      + + + +
        +
      • +

        setQueueName

        +
        public void setQueueName(java.lang.String queueName)
        +
        Set the queue name;
        +
        +
        Parameters:
        +
        queueName - the queue name;
        +
        +
        • +
      + + + +
        +
      • +

        getMaxRuntime

        +
        public int getMaxRuntime()
        +
        Get the maximum job duration time in minutes.
        +
        +
        Returns:
        +
        the maximum job duration.
        +
        +
        • +
      + + + +
        +
      • +

        setMaxRuntime

        +
        public void setMaxRuntime(int minutes)
        +
        Set the maximum job duration in minutes.
        +
        +
        Parameters:
        +
        minutes - the maximum job duration in minutes.
        +
        +
        • +
      + + + +
        +
      • +

        getExecutable

        +
        public java.lang.String getExecutable()
        +
        Get the path to the executable.
        +
        +
        Returns:
        +
        the path to the executable.
        +
        +
        • +
      + + + +
        +
      • +

        setExecutable

        +
        public void setExecutable(java.lang.String executable)
        +
        Sets the path to the executable.
        +
        +
        Parameters:
        +
        executable - the path to the executable.
        +
        +
        • +
      + + + +
        +
      • +

        getArguments

        +
        public java.util.List<java.lang.String> getArguments()
        +
        Get the command line arguments of the executable.
        +
        +
        Returns:
        +
        Returns the arguments of the executable.
        +
        +
        • +
      + + + +
        +
      • +

        setArguments

        +
        public void setArguments(java.lang.String... arguments)
        +
        Sets the command line arguments of the executable.
        +
        +
        Parameters:
        +
        arguments - the command line arguments of the executable.
        +
        +
        • +
      + + + +
        +
      • +

        addArgument

        +
        public void addArgument(java.lang.String argument)
        +
        Add a command line argument for the executable. + + The argument may not be null or empty.
        +
        +
        Parameters:
        +
        argument - the command line argument to add.
        +
        +
        • +
      + + + +
        +
      • +

        getSchedulerArguments

        +
        public java.util.List<java.lang.String> getSchedulerArguments()
        +
        Get the scheduler specific arguments.
        +
        +
        Returns:
        +
        Returns the scheduler specific arguments.
        +
        +
        • +
      + + + +
        +
      • +

        setSchedulerArguments

        +
        public void setSchedulerArguments(java.lang.String... arguments)
        +
        Sets the scheduler specific arguments for this job. + + Some jobs require extra arguments to be provided to the scheduler, for example to select a certain type of node. These arguments tend to be very + scheduler and location specific and are therefore hard to generalize. + + This method provides a simple mechanism to add such arguments to a JobDescription. These arguments are typically copied into the scheduler specific + section of a generated submit script.
        +
        +
        Parameters:
        +
        arguments - the scheduler specific arguments.
        +
        +
        • +
      + + + +
        +
      • +

        addSchedulerArgument

        +
        public void addSchedulerArgument(java.lang.String argument)
        +
        Add a scheduler specific argument. + + The argument may not be null or empty.
        +
        +
        Parameters:
        +
        argument - the scheduler specific argument.
        +
        +
        • +
      + + + +
        +
      • +

        getEnvironment

        +
        public java.util.Map<java.lang.String,java.lang.String> getEnvironment()
        +
        Get the environment of the executable. + + The environment of the executable consists of a Map of environment variables with their values (for example: "JAVA_HOME", "/path/to/java").
        +
        +
        Returns:
        +
        the environment of the executable.
        +
        +
        • +
      + + + +
        +
      • +

        setEnvironment

        +
        public void setEnvironment(java.util.Map<java.lang.String,java.lang.String> environment)
        +
        Sets the environment of the executable. + + The environment of the executable consists of a Map of environment variables with their values (for example: "JAVA_HOME", "/path/to/java").
        +
        +
        Parameters:
        +
        environment - environment of the executable.
        +
        +
        • +
      + + + +
        +
      • +

        addEnvironment

        +
        public void addEnvironment(java.lang.String key,
+                           java.lang.String value)
        +
        Add a variable to the environment of the executable. + + The environment of the executable consists of a Map of environment variables with their values (for example: "JAVA_HOME", "/path/to/java"). + + The key of an environment variable may not be null or empty.
        +
        +
        Parameters:
        +
        key - the unique key under which to store the value.
        +
        value - the value to store the value.
        +
        +
        • +
      + + + +
        +
      • +

        getJobOptions

        +
        public java.util.Map<java.lang.String,java.lang.String> getJobOptions()
        +
        Get a copy of the job options of this job. + + The job options consist of a Map of options variables with their values (for example: "PE", "MPI").
        +
        +
        Returns:
        +
        the job options of the job.
        +
        +
        • +
      + + + +
        +
      • +

        setJobOptions

        +
        public void setJobOptions(java.util.Map<java.lang.String,java.lang.String> options)
        +
        Sets the job options of the job. + + The job options consist of a Map of options variables with their values (for example: "PE", "MPI").
        +
        +
        Parameters:
        +
        options - job options of the job.
        +
        +
        • +
      + + + +
        +
      • +

        addJobOption

        +
        public void addJobOption(java.lang.String key,
+                         java.lang.String value)
        +
        Add a job option to the job. + + The job option consist of a key-value pair (for example: "PE", "MPI"). + + Neither the key or value of a job option may be null or empty.
        +
        +
        Parameters:
        +
        key - the unique key under which to store the job option.
        +
        value - the value of the option to store.
        +
        +
        • +
      + + + +
        +
      • +

        setStdin

        +
        public void setStdin(java.lang.String stdin)
        +
        Sets the path to the file from which the executable must redirect stdin.
        +
        +
        Parameters:
        +
        stdin - the path.
        +
        +
        • +
      + + + +
        +
      • +

        setStdout

        +
        public void setStdout(java.lang.String stdout)
        +
        Sets the path to the file to which the executable must redirect stdout.
        +
        +
        Parameters:
        +
        stdout - the path.
        +
        +
        • +
      + + + +
        +
      • +

        setStderr

        +
        public void setStderr(java.lang.String stderr)
        +
        Sets the path to the file to which the executable must redirect stderr.
        +
        +
        Parameters:
        +
        stderr - the path.
        +
        +
        • +
      + + + +
        +
      • +

        setWorkingDirectory

        +
        public void setWorkingDirectory(java.lang.String workingDirectory)
        +
        Sets the path of the working directory for the executable.
        +
        +
        Parameters:
        +
        workingDirectory - path of the working directory.
        +
        +
        • +
      + + + +
        +
      • +

        getStdin

        +
        public java.lang.String getStdin()
        +
        Gets the path to the file from which the executable must redirect stdin.
        +
        +
        Returns:
        +
        the path.
        +
        +
        • +
      + + + +
        +
      • +

        getStdout

        +
        public java.lang.String getStdout()
        +
        Gets the path to the file to which the executable must redirect stdout.
        +
        +
        Returns:
        +
        the path.
        +
        +
        • +
      + + + +
        +
      • +

        getStderr

        +
        public java.lang.String getStderr()
        +
        Gets the path to the file to which the executable must redirect stderr.
        +
        +
        Returns:
        +
        the path.
        +
        +
        • +
      + + + +
        +
      • +

        getWorkingDirectory

        +
        public java.lang.String getWorkingDirectory()
        +
        Gets the path of the working directory for the executable.
        +
        +
        Returns:
        +
        workingDirectory path of the working directory.
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/JobStatus.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/JobStatus.html new file mode 100644 index 000000000..be6710b10 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/JobStatus.html @@ -0,0 +1,419 @@ + + + + + +JobStatus (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
nl.esciencecenter.xenon.schedulers
+

Interface JobStatus

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    JobStatusImplementation
    +
    +
    +
    +
    public interface JobStatus
    +
    JobStatus contains status information for a specific job.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      XenonExceptiongetException() +
      Get the exception produced by the Job or while retrieving the status.
      +
      java.lang.IntegergetExitCode() +
      Get the exit code for the Job.
      +
      java.lang.StringgetJobIdentifier() +
      Get the job identifier of the Job for which this JobStatus was created.
      +
      java.lang.StringgetName() +
      Get the name of the Job for which this JobStatus was created.
      +
      java.util.Map<java.lang.String,java.lang.String>getSchedulerSpecificInformation() +
      Get scheduler specific information on the Job.
      +
      java.lang.StringgetState() +
      Get the state of the Job.
      +
      booleanhasException() +
      Has the Job or job retrieval produced a exception ?
      +
      booleanisDone() +
      Is the Job done.
      +
      booleanisRunning() +
      Is the Job running.
      +
      voidmaybeThrowException() +
      Throws the exception produced by the Job or while retrieving the status, if it exists.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getJobIdentifier

        +
        java.lang.String getJobIdentifier()
        +
        Get the job identifier of the Job for which this JobStatus was created.
        +
        +
        Returns:
        +
        the identifier of the Job.
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        Get the name of the Job for which this JobStatus was created.
        +
        +
        Returns:
        +
        the name of the Job.
        +
        +
        • +
      + + + +
        +
      • +

        getState

        +
        java.lang.String getState()
        +
        Get the state of the Job. + + The state is a scheduler specific string, generally intended to be human readable. Very different state strings can be returned depending on which + scheduler is used. Therefore, this method should only be used to provide feedback to the user. To programmatically inspect the state of the job use + {isRunning(), isDone() or hasException() instead.
        +
        +
        Returns:
        +
        the state of the Job.
        +
        +
        • +
      + + + +
        +
      • +

        getExitCode

        +
        java.lang.Integer getExitCode()
        +
        Get the exit code for the Job.
        +
        +
        Returns:
        +
        the exit code for the Job.
        +
        +
        • +
      + + + +
        +
      • +

        getException

        +
        XenonException getException()
        +
        Get the exception produced by the Job or while retrieving the status. If no exception occurred, null will be returned. + + See maybeThrowException() for the possible exceptions.
        +
        +
        Returns:
        +
        the exception.
        +
        +
        • +
      + + + +
        +
      • +

        maybeThrowException

        +
        void maybeThrowException()
+                  throws XenonException
        +
        Throws the exception produced by the Job or while retrieving the status, if it exists. Otherwise continue.
        +
        +
        Throws:
        +
        JobCanceledException - if the job was cancelled
        +
        NoSuchJobException - if the job of which the status was requested does not exist
        +
        XenonException - if an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        isRunning

        +
        boolean isRunning()
        +
        Is the Job running.
        +
        +
        Returns:
        +
        if the Job is running.
        +
        +
        • +
      + + + +
        +
      • +

        isDone

        +
        boolean isDone()
        +
        Is the Job done.
        +
        +
        Returns:
        +
        if the Job is done.
        +
        +
        • +
      + + + +
        +
      • +

        hasException

        +
        boolean hasException()
        +
        Has the Job or job retrieval produced a exception ?
        +
        +
        Returns:
        +
        if the Job has an exception.
        +
        +
        • +
      + + + +
        +
      • +

        getSchedulerSpecificInformation

        +
        java.util.Map<java.lang.String,java.lang.String> getSchedulerSpecificInformation()
        +
        Get scheduler specific information on the Job.
        +
        +
        Returns:
        +
        scheduler specific information on the Job.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/NoSuchJobException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/NoSuchJobException.html new file mode 100644 index 000000000..f701651a4 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/NoSuchJobException.html @@ -0,0 +1,332 @@ + + + + + +NoSuchJobException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.schedulers
+

Class NoSuchJobException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class NoSuchJobException
+extends XenonException
    +
    Signals that a Job was not found.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      NoSuchJobException(java.lang.String adaptorName, + java.lang.String message) 
      NoSuchJobException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NoSuchJobException

        +
        public NoSuchJobException(java.lang.String adaptorName,
+                          java.lang.String message,
+                          java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        NoSuchJobException

        +
        public NoSuchJobException(java.lang.String adaptorName,
+                          java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/NoSuchQueueException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/NoSuchQueueException.html new file mode 100644 index 000000000..70d5164dd --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/NoSuchQueueException.html @@ -0,0 +1,332 @@ + + + + + +NoSuchQueueException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.schedulers
+

Class NoSuchQueueException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class NoSuchQueueException
+extends XenonException
    +
    Signals that a unknown queue was provided.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      NoSuchQueueException(java.lang.String adaptorName, + java.lang.String message) 
      NoSuchQueueException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NoSuchQueueException

        +
        public NoSuchQueueException(java.lang.String adaptorName,
+                            java.lang.String message,
+                            java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        NoSuchQueueException

        +
        public NoSuchQueueException(java.lang.String adaptorName,
+                            java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/QueueStatus.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/QueueStatus.html new file mode 100644 index 000000000..d4a358575 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/QueueStatus.html @@ -0,0 +1,334 @@ + + + + + +QueueStatus (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
nl.esciencecenter.xenon.schedulers
+

Interface QueueStatus

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    QueueStatusImplementation
    +
    +
    +
    +
    public interface QueueStatus
    +
    QueueStatus contains status information for a specific queue.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getScheduler

        +
        Scheduler getScheduler()
        +
        Get the Scheduler that produced this QueueStatus.
        +
        +
        Returns:
        +
        the Scheduler.
        +
        +
        • +
      + + + +
        +
      • +

        getQueueName

        +
        java.lang.String getQueueName()
        +
        Get the queue name.
        +
        +
        Returns:
        +
        the queue name.
        +
        +
        • +
      + + + +
        +
      • +

        hasException

        +
        boolean hasException()
        +
        Did the queue produce an exception ?
        +
        +
        Returns:
        +
        if the queue produced an exception ?
        +
        +
        • +
      + + + +
        +
      • +

        getException

        +
        XenonException getException()
        +
        Get the exception produced by the queue, or null if hasException() returns false. + + See maybeThrowException() for the possible exceptions.
        +
        +
        Returns:
        +
        the exception.
        +
        +
        • +
      + + + +
        +
      • +

        maybeThrowException

        +
        void maybeThrowException()
+                  throws XenonException
        +
        Throws the exception produced by the queue if it exists. Otherwise continue.
        +
        +
        Throws:
        +
        NoSuchQueueException - if the requested queue does not exist
        +
        XenonException - if an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        getSchedulerSpecificInformation

        +
        java.util.Map<java.lang.String,java.lang.String> getSchedulerSpecificInformation()
        +
        Get scheduler specific information on the queue.
        +
        +
        Returns:
        +
        Scheduler specific information on the queue.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/Scheduler.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/Scheduler.html new file mode 100644 index 000000000..a6255a235 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/Scheduler.html @@ -0,0 +1,1240 @@ + + + + + +Scheduler (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.schedulers
+

Class Scheduler

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.schedulers.Scheduler
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.AutoCloseable
    +
    +
    +
    Direct Known Subclasses:
    +
    JobQueueScheduler, ScriptingScheduler
    +
    +
    +
    +
    public abstract class Scheduler
+extends java.lang.Object
+implements java.lang.AutoCloseable
    +
    Scheduler represents a (possibly remote) scheduler that can be used to submit jobs and retrieve queue information.
    +
    +
    Since:
    +
    1.0
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected Scheduler(java.lang.String uniqueID, + java.lang.String adaptor, + java.lang.String location, + Credential credential, + XenonProperties properties) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private static voidaddAdaptor(SchedulerAdaptor adaptor) 
      protected voidassertNonNullOrEmpty(java.lang.String s, + java.lang.String message) 
      protected voidassertPositive(long value, + java.lang.String message) 
      abstract JobStatuscancelJob(java.lang.String jobIdentifier) +
      Cancel a job.
      +
      abstract voidclose() +
      Close this Scheduler.
      +
      static Schedulercreate(java.lang.String adaptor) +
      Create a new Scheduler using the adaptor connecting to the default location and using the default credentials to get access.
      +
      static Schedulercreate(java.lang.String adaptor, + java.lang.String location) +
      Create a new Scheduler using the adaptor connecting to the location using the default credentials to get access.
      +
      static Schedulercreate(java.lang.String adaptor, + java.lang.String location, + Credential credential) +
      Create a new Scheduler using the adaptor connecting to the location using credentials to get access.
      +
      static Schedulercreate(java.lang.String adaptor, + java.lang.String location, + Credential credential, + java.util.Map<java.lang.String,java.lang.String> properties) +
      Create a new Scheduler using the adaptor connecting to the location using credentials to get access.
      +
      booleanequals(java.lang.Object o) 
      private static SchedulerAdaptorgetAdaptorByName(java.lang.String adaptorName) 
      static SchedulerAdaptorDescriptiongetAdaptorDescription(java.lang.String adaptorName) +
      Gives the description of the adaptor with the given name.
      +
      static SchedulerAdaptorDescription[]getAdaptorDescriptions() +
      Gives a list of the descriptions of the available adaptors.
      +
      java.lang.StringgetAdaptorName() +
      Get the name of the adaptor that created this Scheduler.
      +
      static java.lang.String[]getAdaptorNames() +
      Gives a list names of the available adaptors.
      +
      CredentialgetCredential() +
      Get the credential that this Scheduler is using.
      +
      abstract java.lang.StringgetDefaultQueueName() +
      Get the name of the default queue.
      +
      abstract FileSystemgetFileSystem() +
      Retrieve the FileSystem used internally by this Scheduler.
      +
      abstract java.lang.String[]getJobs(java.lang.String... queueNames) +
      Get all job identifier of jobs currently in (one ore more) queues.
      +
      abstract JobStatusgetJobStatus(java.lang.String jobIdentifier) +
      Get the status of a Job.
      +
      JobStatus[]getJobStatuses(java.lang.String... jobIdentifiers) +
      Get the status of all specified jobs.
      +
      java.lang.StringgetLocation() +
      Get the location that this Scheduler is connected to.
      +
      java.util.Map<java.lang.String,java.lang.String>getProperties() +
      Get the properties used to create this Scheduler.
      +
      abstract java.lang.String[]getQueueNames() +
      Get the queue names supported by this Scheduler.
      +
      abstract QueueStatusgetQueueStatus(java.lang.String queueName) +
      Get the status of the queue.
      +
      abstract QueueStatus[]getQueueStatuses(java.lang.String... queueNames) +
      Get the status of all queues.
      +
      inthashCode() 
      abstract booleanisOpen() +
      Test if the connection of this Scheduler is open.
      +
      abstract java.lang.StringsubmitBatchJob(JobDescription description) +
      Submit a batch job.
      +
      abstract StreamssubmitInteractiveJob(JobDescription description) +
      Submit an interactive job (optional operation).
      +
      abstract JobStatuswaitUntilDone(java.lang.String jobIdentifier, + long timeout) +
      Wait until a job is done or until a timeout expires.
      +
      abstract JobStatuswaitUntilRunning(java.lang.String jobIdentifier, + long timeout) +
      Wait until a job starts running, or until a timeout expires.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        COMPONENT_NAME

        +
        private static final java.lang.String COMPONENT_NAME
        +
        The name of this component, for use in exceptions
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        adaptors

        +
        private static final java.util.HashMap<java.lang.String,SchedulerAdaptor> adaptors
        +
        • +
      + + + +
        +
      • +

        uniqueID

        +
        private final java.lang.String uniqueID
        +
        • +
      + + + +
        +
      • +

        adaptor

        +
        private final java.lang.String adaptor
        +
        • +
      + + + +
        +
      • +

        location

        +
        private final java.lang.String location
        +
        • +
      + + + +
        +
      • +

        credential

        +
        private final Credential credential
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Scheduler

        +
        protected Scheduler(java.lang.String uniqueID,
+                    java.lang.String adaptor,
+                    java.lang.String location,
+                    Credential credential,
+                    XenonProperties properties)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        getAdaptorNames

        +
        public static java.lang.String[] getAdaptorNames()
        +
        Gives a list names of the available adaptors.
        +
        +
        Returns:
        +
        the list
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getAdaptorDescriptions

        +
        public static SchedulerAdaptorDescription[] getAdaptorDescriptions()
        +
        Gives a list of the descriptions of the available adaptors.
        +
        +
        Returns:
        +
        the list
        +
        +
        • +
      + + + +
        +
      • +

        create

        +
        public static Scheduler create(java.lang.String adaptor,
+                               java.lang.String location,
+                               Credential credential,
+                               java.util.Map<java.lang.String,java.lang.String> properties)
+                        throws XenonException
        +
        Create a new Scheduler using the adaptor connecting to the location using credentials to get access. Use + properties to (optionally) configure the scheduler when it is created. + + Make sure to always close Scheduler instances by calling Scheduler.close() when you no longer need them, otherwise their associated + resources may remain allocated.
        +
        +
        Parameters:
        +
        adaptor - the adaptor used to access the Scheduler.
        +
        location - the location of the Scheduler.
        +
        credential - the Credentials to use to get access to the Scheduler.
        +
        properties - optional properties to configure the Scheduler when it is created.
        +
        Returns:
        +
        the new Scheduler.
        +
        Throws:
        +
        UnknownPropertyException - If a unknown property was provided.
        +
        InvalidPropertyException - If a known property was provided with an invalid value.
        +
        InvalidLocationException - If the location was invalid.
        +
        InvalidCredentialException - If the credential is invalid to access the location.
        +
        XenonException - If the creation of the Scheduler failed.
        +
        java.lang.IllegalArgumentException - If adaptor is null.
        +
        See Also:
        +
        Documentation on the supported adaptors and locations.
        +
        +
        • +
      + + + +
        +
      • +

        create

        +
        public static Scheduler create(java.lang.String adaptor,
+                               java.lang.String location,
+                               Credential credential)
+                        throws XenonException
        +
        Create a new Scheduler using the adaptor connecting to the location using credentials to get access. + + Make sure to always close Scheduler instances by calling Scheduler.close() when you no longer need them, otherwise their associated + resources may remain allocated.
        +
        +
        Parameters:
        +
        adaptor - the adaptor used to access the Scheduler.
        +
        location - the location of the Scheduler.
        +
        credential - the Credentials to use to get access to the Scheduler.
        +
        Returns:
        +
        the new Scheduler.
        +
        Throws:
        +
        UnknownPropertyException - If a unknown property was provided.
        +
        InvalidPropertyException - If a known property was provided with an invalid value.
        +
        InvalidLocationException - If the location was invalid.
        +
        InvalidCredentialException - If the credential is invalid to access the location.
        +
        XenonException - If the creation of the Scheduler failed.
        +
        java.lang.IllegalArgumentException - If adaptor is null.
        +
        See Also:
        +
        Documentation on the supported adaptors and locations.
        +
        +
        • +
      + + + +
        +
      • +

        create

        +
        public static Scheduler create(java.lang.String adaptor,
+                               java.lang.String location)
+                        throws XenonException
        +
        Create a new Scheduler using the adaptor connecting to the location using the default credentials to get access. + + Make sure to always close Scheduler instances by calling Scheduler.close() when you no longer need them, otherwise their associated + resources may remain allocated.
        +
        +
        Parameters:
        +
        adaptor - the adaptor used to access the Scheduler.
        +
        location - the location of the Scheduler.
        +
        Returns:
        +
        the new Scheduler.
        +
        Throws:
        +
        UnknownPropertyException - If a unknown property was provided.
        +
        InvalidPropertyException - If a known property was provided with an invalid value.
        +
        InvalidLocationException - If the location was invalid.
        +
        InvalidCredentialException - If the credential is invalid to access the location.
        +
        XenonException - If the creation of the Scheduler failed.
        +
        java.lang.IllegalArgumentException - If adaptor is null.
        +
        See Also:
        +
        Documentation on the supported adaptors and locations.
        +
        +
        • +
      + + + +
        +
      • +

        create

        +
        public static Scheduler create(java.lang.String adaptor)
+                        throws XenonException
        +
        Create a new Scheduler using the adaptor connecting to the default location and using the default credentials to get access. + + Note that there are very few adaptors that support a default scheduler location. The local scheduler adaptor is the prime example. + + Make sure to always close Scheduler instances by calling Scheduler.close() when you no longer need them, otherwise their associated + resources may remain allocated.
        +
        +
        Parameters:
        +
        adaptor - the adaptor used to access the Scheduler.
        +
        Returns:
        +
        the new Scheduler.
        +
        Throws:
        +
        UnknownPropertyException - If a unknown property was provided.
        +
        InvalidPropertyException - If a known property was provided with an invalid value.
        +
        InvalidLocationException - If the location was invalid.
        +
        InvalidCredentialException - If the credential is invalid to access the location.
        +
        XenonException - If the creation of the Scheduler failed.
        +
        java.lang.IllegalArgumentException - If adaptor is null.
        +
        See Also:
        +
        Documentation on the supported adaptors and locations.
        +
        +
        • +
      + + + +
        +
      • +

        getAdaptorName

        +
        public java.lang.String getAdaptorName()
        +
        Get the name of the adaptor that created this Scheduler.
        +
        +
        Returns:
        +
        the name of the adaptor.
        +
        +
        • +
      + + + +
        +
      • +

        getLocation

        +
        public java.lang.String getLocation()
        +
        Get the location that this Scheduler is connected to.
        +
        +
        Returns:
        +
        the location this Scheduler is connected to.
        +
        +
        • +
      + + + +
        +
      • +

        getCredential

        +
        public Credential getCredential()
        +
        Get the credential that this Scheduler is using.
        +
        +
        Returns:
        +
        the credential this Scheduler is using.
        +
        +
        • +
      + + + +
        +
      • +

        getProperties

        +
        public java.util.Map<java.lang.String,java.lang.String> getProperties()
        +
        Get the properties used to create this Scheduler.
        +
        +
        Returns:
        +
        the properties used to create this Scheduler.
        +
        +
        • +
      + + + +
        +
      • +

        getQueueNames

        +
        public abstract java.lang.String[] getQueueNames()
+                                          throws XenonException
        +
        Get the queue names supported by this Scheduler.
        +
        +
        Returns:
        +
        the queue names supported by this Scheduler.
        +
        Throws:
        +
        NotConnectedException - If scheduler is closed.
        +
        XenonException - If an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        public abstract void close()
+                    throws XenonException
        +
        Close this Scheduler.
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Throws:
        +
        XenonException - If the Scheduler failed to close.
        +
        +
        • +
      + + + +
        +
      • +

        isOpen

        +
        public abstract boolean isOpen()
+                        throws XenonException
        +
        Test if the connection of this Scheduler is open.
        +
        +
        Returns:
        +
        true if the connection of this Scheduler is still open, false otherwise.
        +
        Throws:
        +
        XenonException - If an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        getDefaultQueueName

        +
        public abstract java.lang.String getDefaultQueueName()
+                                              throws XenonException
        +
        Get the name of the default queue.
        +
        +
        Returns:
        +
        the name of the default queue for this scheduler, or null if no default queue is available.
        +
        Throws:
        +
        NotConnectedException - If scheduler is closed.
        +
        XenonException - If an I/O error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        getJobs

        +
        public abstract java.lang.String[] getJobs(java.lang.String... queueNames)
+                                    throws XenonException
        +
        Get all job identifier of jobs currently in (one ore more) queues. + + If no queue names are specified, the job identifiers for all queues are returned. + + Note that job identifiers of jobs submitted by other users or other schedulers may also be returned.
        +
        +
        Parameters:
        +
        queueNames - the names of the queues.
        +
        Returns:
        +
        an array containing the resulting job identifiers .
        +
        Throws:
        +
        NotConnectedException - If scheduler is closed.
        +
        NoSuchQueueException - If the queue does not exist in the scheduler.
        +
        XenonException - If the Scheduler failed to get jobs.
        +
        +
        • +
      + + + +
        +
      • +

        getQueueStatus

        +
        public abstract QueueStatus getQueueStatus(java.lang.String queueName)
+                                    throws XenonException
        +
        Get the status of the queue.
        +
        +
        Parameters:
        +
        queueName - the name of the queue.
        +
        Returns:
        +
        the resulting QueueStatus.
        +
        Throws:
        +
        NoSuchQueueException - If the queue does not exist in the scheduler.
        +
        XenonException - If the Scheduler failed to get its status.
        +
        +
        • +
      + + + +
        +
      • +

        getQueueStatuses

        +
        public abstract QueueStatus[] getQueueStatuses(java.lang.String... queueNames)
+                                        throws XenonException
        +
        Get the status of all queues. + + Note that this method will only throw an exception when this exception will influence all status requests. For example, if the scheduler is no longer + connected. + + Exceptions that only refer to a single queue are returned in the QueueStatus returned for that queue.
        +
        +
        Parameters:
        +
        queueNames - the names of the queues.
        +
        Returns:
        +
        an array containing the resulting QueueStatus.
        +
        Throws:
        +
        XenonException - If the Scheduler failed to get the statuses.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getJobStatus

        +
        public abstract JobStatus getJobStatus(java.lang.String jobIdentifier)
+                                throws XenonException
        +
        Get the status of a Job.
        +
        +
        Parameters:
        +
        jobIdentifier - the job identifier of the job to get the status for.
        +
        Returns:
        +
        the status of the Job.
        +
        Throws:
        +
        NoSuchJobException - If the job is not known.
        +
        XenonException - If the status of the job could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        getJobStatuses

        +
        public JobStatus[] getJobStatuses(java.lang.String... jobIdentifiers)
+                           throws XenonException
        +
        Get the status of all specified jobs. +

        + The array of JobStatus contains one entry for each of the jobs. The order of the elements in the returned + JobStatus array corresponds to the order in which the jobs are passed as parameters. If a job is + null, the corresponding entry in the JobStatus array will also be null. If the retrieval of the + JobStatus fails for a job, the exception will be stored in the corresponding JobsStatus entry. +

        +
        +
        Parameters:
        +
        jobIdentifiers - the job identifiers for which to retrieve the status.
        +
        Returns:
        +
        an array of the resulting JobStatuses.
        +
        Throws:
        +
        XenonException - If an I/O error occurred
        +
        +
        • +
      + + + +
        +
      • +

        cancelJob

        +
        public abstract JobStatus cancelJob(java.lang.String jobIdentifier)
+                             throws XenonException
        +
        Cancel a job. +

        + A status is returned that indicates the state of the job after the cancel. If the job was already done it cannot be cancelled. +

        +

        + A JobStatus is returned that can be used to determine the state of the job after cancelJob returns. Note that it may take some time before the + job has actually terminated. The waitUntilDone method can be used to wait until the job is terminated. +

        +
        +
        Parameters:
        +
        jobIdentifier - the identifier of job to kill.
        +
        Returns:
        +
        the status of the Job.
        +
        Throws:
        +
        NoSuchJobException - If the job is not known.
        +
        XenonException - If the status of the job could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        waitUntilDone

        +
        public abstract JobStatus waitUntilDone(java.lang.String jobIdentifier,
+                                        long timeout)
+                                 throws XenonException
        +
        Wait until a job is done or until a timeout expires. +

        + This method will wait until a job is done (either gracefully or by being killed or producing an error), or until the timeout expires, whichever comes + first. If the timeout expires, the job will continue to run. +

        +

        + The timeout is in milliseconds and must be >= 0. When timeout is 0, it will be ignored and this method will wait until the jobs is done. +

        +

        + A JobStatus is returned that can be used to determine why the call returned. +

        +
        +
        Parameters:
        +
        jobIdentifier - the identifier of the to wait for.
        +
        timeout - the maximum time to wait for the job in milliseconds.
        +
        Returns:
        +
        the status of the Job.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If the value of timeout is negative
        +
        NoSuchJobException - If the job is not known.
        +
        XenonException - If the status of the job could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        waitUntilRunning

        +
        public abstract JobStatus waitUntilRunning(java.lang.String jobIdentifier,
+                                           long timeout)
+                                    throws XenonException
        +
        Wait until a job starts running, or until a timeout expires. +

        + This method will return as soon as the job is no longer waiting in the queue, or when the timeout expires, whichever comes first. If the job is no longer + waiting in the queue, it may be running, but it may also be killed, finished or have produced an error. If the timeout expires, the job will continue to + be queued normally. +

        +

        + The timeout is in milliseconds and must be >= 0. When timeout is 0, it will be ignored and this method will wait until the job is no longer queued. +

        +

        + A JobStatus is returned that can be used to determine why the call returned. +

        +
        +
        Parameters:
        +
        jobIdentifier - the identifier of the to wait for.
        +
        timeout - the maximum time to wait in milliseconds.
        +
        Returns:
        +
        the status of the Job.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If the value of timeout is negative
        +
        NoSuchJobException - If the job is not known.
        +
        XenonException - If the status of the job could not be retrieved.
        +
        +
        • +
      + + + +
        +
      • +

        getFileSystem

        +
        public abstract FileSystem getFileSystem()
+                                  throws XenonException
        +
        Retrieve the FileSystem used internally by this Scheduler. +

        + Often, a Scheduler needs to access files or directories on the machine it will schedule jobs. For example, to ensure a working directory + exists, or to redirect the stdin, stdout or stderr streams used by a job. +

        +

        + This method returns this FileSystem so it can also be used by the application to prepare input files for the jobs, or retrieve the output + files produced by the jobs. +

        +
        +
        Returns:
        +
        the FileSystem used by this Scheduler.
        +
        Throws:
        +
        XenonException - if this Scheduler does not use a FileSystem internally.
        +
        +
        • +
      + + + +
        +
      • +

        assertNonNullOrEmpty

        +
        protected void assertNonNullOrEmpty(java.lang.String s,
+                                    java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        assertPositive

        +
        protected void assertPositive(long value,
+                              java.lang.String message)
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object o)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/SchedulerAdaptorDescription.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/SchedulerAdaptorDescription.html new file mode 100644 index 000000000..da6e60b20 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/SchedulerAdaptorDescription.html @@ -0,0 +1,324 @@ + + + + + +SchedulerAdaptorDescription (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
nl.esciencecenter.xenon.schedulers
+

Interface SchedulerAdaptorDescription

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      booleanisEmbedded() +
      Is this an embedded scheduler ? + + Embedded schedulers are implemented inside the Xenon process itself.
      +
      booleansupportsBatch() +
      Does this Scheduler support the submission of batch jobs ? + + For batch jobs the standard streams of the jobs are redirected from and to files.
      +
      booleansupportsInteractive() +
      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.
      +
      booleanusesFileSystem() +
      Does this Scheduler create a FileSystem to support the submission of jobs ? + + Many scheduler implementations use a FileSystem internally to handle job submission, for example to store submission scripts or handle the standard I/O + streams of a process.
      +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isEmbedded

        +
        boolean isEmbedded()
        +
        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.
        +
        +
        Returns:
        +
        if this scheduler is embedded.
        +
        +
        • +
      + + + +
        +
      • +

        supportsBatch

        +
        boolean supportsBatch()
        +
        Does this Scheduler support the submission of batch jobs ? + + For batch jobs the standard streams of the jobs are redirected from and to files.
        +
        +
        Returns:
        +
        if this scheduler supports the submission of batch jobs ?
        +
        +
        • +
      + + + +
        +
      • +

        supportsInteractive

        +
        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. Failing to do so may cause the job to hang indefinitely.
        +
        +
        Returns:
        +
        if this scheduler supports the submission of interactive jobs ?
        +
        +
        • +
      + + + +
        +
      • +

        usesFileSystem

        +
        boolean usesFileSystem()
        +
        Does this Scheduler create a FileSystem to support the submission of jobs ? + + Many scheduler implementations use a FileSystem internally to handle job submission, for example to store submission scripts or handle the standard I/O + streams of a process. This FileSystem can optionally be retrieved by the user to perform other tasks, such as staging in and output data of the job. To + do so use Scheduler.getFileSystem() method.
        +
        +
        Returns:
        +
        does this Scheduler create a FileSystem to support the submission of jobs ?
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/Streams.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/Streams.html new file mode 100644 index 000000000..d233d1a61 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/Streams.html @@ -0,0 +1,296 @@ + + + + + +Streams (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
nl.esciencecenter.xenon.schedulers
+

Interface Streams

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    StreamsImplementation
    +
    +
    +
    +
    public interface Streams
    +
    Streams is a container for the standard input, output and error streams of a job. + + Note that these standard streams are only available for interactive jobs.
    +
    +
    Since:
    +
    1.0
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetJobIdentifier() +
      Get the identifier of the job for which this Streams was created.
      +
      java.io.InputStreamgetStderr() +
      Returns the standard error stream of job.
      +
      java.io.OutputStreamgetStdin() +
      Returns the standard input stream of job.
      +
      java.io.InputStreamgetStdout() +
      Returns the standard output stream of job.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getJobIdentifier

        +
        java.lang.String getJobIdentifier()
        +
        Get the identifier of the job for which this Streams was created.
        +
        +
        Returns:
        +
        the identifier of the ob.
        +
        +
        • +
      + + + +
        +
      • +

        getStdout

        +
        java.io.InputStream getStdout()
        +
        Returns the standard output stream of job.
        +
        +
        Returns:
        +
        the standard output stream of job.
        +
        +
        • +
      + + + +
        +
      • +

        getStderr

        +
        java.io.InputStream getStderr()
        +
        Returns the standard error stream of job.
        +
        +
        Returns:
        +
        the standard error stream of job.
        +
        +
        • +
      + + + +
        +
      • +

        getStdin

        +
        java.io.OutputStream getStdin()
        +
        Returns the standard input stream of job.
        +
        +
        Returns:
        +
        the standard input stream of this job.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/UnsupportedJobDescriptionException.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/UnsupportedJobDescriptionException.html new file mode 100644 index 000000000..665eb53e6 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/UnsupportedJobDescriptionException.html @@ -0,0 +1,332 @@ + + + + + +UnsupportedJobDescriptionException (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.schedulers
+

Class UnsupportedJobDescriptionException

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class UnsupportedJobDescriptionException
+extends XenonException
    +
    Signals that a combination of options used in a JobDescription is not supported by a resource.
    +
    +
    Since:
    +
    1.0
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UnsupportedJobDescriptionException

        +
        public UnsupportedJobDescriptionException(java.lang.String adaptorName,
+                                          java.lang.String message,
+                                          java.lang.Throwable t)
        +
        • +
      + + + +
        +
      • +

        UnsupportedJobDescriptionException

        +
        public UnsupportedJobDescriptionException(java.lang.String adaptorName,
+                                          java.lang.String message)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/package-frame.html new file mode 100644 index 000000000..e29cb6808 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/package-frame.html @@ -0,0 +1,35 @@ + + + + + +nl.esciencecenter.xenon.schedulers (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.schedulers

+
+

Interfaces

+ +

Classes

+ +

Exceptions

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/package-summary.html new file mode 100644 index 000000000..b461d7fa0 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/package-summary.html @@ -0,0 +1,230 @@ + + + + + +nl.esciencecenter.xenon.schedulers (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.schedulers

+
+
This package contains the classes and interfaces used to run jobs.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + +
    Interface Summary 
    InterfaceDescription
    JobStatus +
    JobStatus contains status information for a specific job.
    +
    QueueStatus +
    QueueStatus contains status information for a specific queue.
    +
    SchedulerAdaptorDescription 
    Streams +
    Streams is a container for the standard input, output and error streams of a job.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    JobDescription +
    JobDescription contains a description of a job that can be submitted to a Scheduler.
    +
    Scheduler +
    Scheduler represents a (possibly remote) scheduler that can be used to submit jobs and retrieve queue information.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Exception Summary 
    ExceptionDescription
    IncompleteJobDescriptionException +
    Signals that a JobDescription is missing required options.
    +
    InvalidJobDescriptionException +
    Signals that a JobDescription contains invalid values for certain options.
    +
    NoSuchJobException +
    Signals that a Job was not found.
    +
    NoSuchQueueException +
    Signals that a unknown queue was provided.
    +
    UnsupportedJobDescriptionException +
    Signals that a combination of options used in a JobDescription is not supported by a resource.
    +
    +
    • +
+ + + +

Package nl.esciencecenter.xenon.schedulers Description

+
This package contains the classes and interfaces used to run jobs.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/package-tree.html new file mode 100644 index 000000000..1cdb67995 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/package-tree.html @@ -0,0 +1,163 @@ + + + + + +nl.esciencecenter.xenon.schedulers Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.schedulers

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/InputWriter.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/InputWriter.html new file mode 100644 index 000000000..ea8325d18 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/InputWriter.html @@ -0,0 +1,451 @@ + + + + + +InputWriter (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.utils
+

Class InputWriter

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Thread
      • +
    • +
        +
      • nl.esciencecenter.xenon.utils.InputWriter
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Runnable
    +
    +
    +
    +
    public final class InputWriter
+extends java.lang.Thread
    +
    A simple input writer that uses a daemon thread to write from an String to an OutputStream. + Once the end of the string is reached, the destination stream will be closed.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class java.lang.Thread

        +java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.lang.Stringcontent 
      private java.io.OutputStreamdestination 
      private booleanfinished 
      private static org.slf4j.LoggerLOGGER 
      +
        +
      • + + +

        Fields inherited from class java.lang.Thread

        +MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      InputWriter(java.lang.String content, + java.io.OutputStream destination) +
      Create a new InputWriter that writes content to the destination.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanisFinished() +
      Poll if the InputWriter has finished writing.
      +
      voidrun() +
      Entry point for the Daemon thread.
      +
      private voidsetFinished() 
      voidwaitUntilFinished() +
      Wait until the InputWriter has finished writing.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Thread

        +activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        content

        +
        private final java.lang.String content
        +
        • +
      + + + +
        +
      • +

        destination

        +
        private final java.io.OutputStream destination
        +
        • +
      + + + +
        +
      • +

        finished

        +
        private boolean finished
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InputWriter

        +
        public InputWriter(java.lang.String content,
+                   java.io.OutputStream destination)
        +
        Create a new InputWriter that writes content to the destination.
        +
        +
        Parameters:
        +
        content - the data to write to the destination.
        +
        destination - the destination to write to.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setFinished

        +
        private void setFinished()
        +
        • +
      + + + +
        +
      • +

        isFinished

        +
        public boolean isFinished()
        +
        Poll if the InputWriter has finished writing.
        +
        +
        Returns:
        +
        if the InputWriter has finished writing.
        +
        +
        • +
      + + + +
        +
      • +

        waitUntilFinished

        +
        public void waitUntilFinished()
        +
        Wait until the InputWriter has finished writing.
        +
        • +
      + + + +
        +
      • +

        run

        +
        public void run()
        +
        Entry point for the Daemon thread.
        +
        +
        Specified by:
        +
        run in interface java.lang.Runnable
        +
        Overrides:
        +
        run in class java.lang.Thread
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/JavaJobDescription.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/JavaJobDescription.html new file mode 100644 index 000000000..fe1b1c042 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/JavaJobDescription.html @@ -0,0 +1,780 @@ + + + + + +JavaJobDescription (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.utils
+

Class JavaJobDescription

+
+
+ +
+
    +
  • +
    +
    +
    public class JavaJobDescription
+extends JobDescription
    +
    A JobDescription specialized in Java applications. + + A JavaJobDescription will use the Java specific information provided by the user to build the command line arguments of the JobDescription.
    +
    +
    Since:
    +
    1.0
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        javaOptions

        +
        private final java.util.List<java.lang.String> javaOptions
        +
        • +
      + + + +
        +
      • +

        javaSystemProperties

        +
        private final java.util.Map<java.lang.String,java.lang.String> javaSystemProperties
        +
        • +
      + + + +
        +
      • +

        javaMain

        +
        private java.lang.String javaMain
        +
        • +
      + + + +
        +
      • +

        javaArguments

        +
        private final java.util.List<java.lang.String> javaArguments
        +
        • +
      + + + +
        +
      • +

        javaClasspath

        +
        private final java.util.List<java.lang.String> javaClasspath
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        JavaJobDescription

        +
        public JavaJobDescription()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getJavaOptions

        +
        public java.util.List<java.lang.String> getJavaOptions()
        +
        Returns the JVM options.
        +
        +
        Returns:
        +
        the JVM options.
        +
        +
        • +
      + + + +
        +
      • +

        setJavaOptions

        +
        public void setJavaOptions(java.lang.String... options)
        +
        Sets the JVM options.
        +
        +
        Parameters:
        +
        options - the JVM options.
        +
        +
        • +
      + + + +
        +
      • +

        addJavaOption

        +
        public void addJavaOption(java.lang.String option)
        +
        Adds a JVM option.
        +
        +
        Parameters:
        +
        option - the JVM option.
        +
        +
        • +
      + + + +
        +
      • +

        getJavaSystemProperties

        +
        public java.util.Map<java.lang.String,java.lang.String> getJavaSystemProperties()
        +
        Returns the java system properties.
        +
        +
        Returns:
        +
        the java system properties.
        +
        +
        • +
      + + + +
        +
      • +

        setJavaSystemProperties

        +
        public void setJavaSystemProperties(java.util.Map<java.lang.String,java.lang.String> systemProperties)
        +
        Sets the system properties. A system property should be passed as a key value pair <"a", "b">, not as <"-Da", "b">, Xenon will add the -D to + the property.
        +
        +
        Parameters:
        +
        systemProperties - the system properties.
        +
        +
        • +
      + + + +
        +
      • +

        addJavaSystemProperty

        +
        public void addJavaSystemProperty(java.lang.String key,
+                                  java.lang.String value)
        +
        Adds a system property to the current set of system properties. The key of the system property should not start with "-D".
        +
        +
        Parameters:
        +
        key - the key of the system property to be added
        +
        value - the value belonging to the key of the system property to be added
        +
        +
        • +
      + + + +
        +
      • +

        getJavaMain

        +
        public java.lang.String getJavaMain()
        +
        Returns the main class of the java application.
        +
        +
        Returns:
        +
        the main class.
        +
        +
        • +
      + + + +
        +
      • +

        setJavaMain

        +
        public void setJavaMain(java.lang.String main)
        +
        Sets the main class.
        +
        +
        Parameters:
        +
        main - the main class.
        +
        +
        • +
      + + + +
        +
      • +

        getJavaArguments

        +
        public java.util.List<java.lang.String> getJavaArguments()
        +
        Returns the arguments for the main class.
        +
        +
        Returns:
        +
        the arguments for the main class
        +
        +
        • +
      + + + +
        +
      • +

        setJavaArguments

        +
        public void setJavaArguments(java.lang.String... javaArguments)
        +
        Sets the arguments of the java main class.
        +
        +
        Parameters:
        +
        javaArguments - the arguments of the java main class.
        +
        +
        • +
      + + + +
        +
      • +

        addJavaArgument

        +
        public void addJavaArgument(java.lang.String javaArgument)
        +
        • +
      + + + + + + + +
        +
      • +

        getArguments

        +
        public java.util.List<java.lang.String> getArguments()
        +
        Constructs the command line arguments from the class path, the JVM options, the system properties, the main and the java arguments.
        +
        +
        Overrides:
        +
        getArguments in class JobDescription
        +
        Returns:
        +
        the command line arguments
        +
        +
        • +
      + + + +
        +
      • +

        getArguments

        +
        public java.util.List<java.lang.String> getArguments(char pathSeparator)
        +
        Constructs the command line arguments from the class path, the JVM options, the system properties, the main and the java arguments.
        +
        +
        Parameters:
        +
        pathSeparator - the seperator to use in the classpath. Defaults to the unix path seperator ':'
        +
        Returns:
        +
        the command line arguments
        +
        +
        • +
      + + + +
        +
      • +

        getExecutable

        +
        public java.lang.String getExecutable()
        +
        Returns the executable. If no executable is set the default executable will be "java".
        +
        +
        Overrides:
        +
        getExecutable in class JobDescription
        +
        Returns:
        +
        Returns the executable.
        +
        +
        • +
      + + + +
        +
      • +

        getJavaClasspath

        +
        public java.util.List<java.lang.String> getJavaClasspath()
        +
        Returns the java class path.
        +
        +
        Returns:
        +
        the java class path.
        +
        +
        • +
      + + + +
        +
      • +

        setJavaClasspath

        +
        public void setJavaClasspath(java.lang.String... javaClasspath)
        +
        Sets the java class path. Will automatically add separators when multiple elements are given.
        +
        +
        Parameters:
        +
        javaClasspath - the class path to be set.
        +
        +
        • +
      + + + +
        +
      • +

        addJavaClasspathElement

        +
        public void addJavaClasspathElement(java.lang.String element)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class JobDescription
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/LocalFileSystemUtils.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/LocalFileSystemUtils.html new file mode 100644 index 000000000..8db285acb --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/LocalFileSystemUtils.html @@ -0,0 +1,658 @@ + + + + + +LocalFileSystemUtils (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.utils
+

Class LocalFileSystemUtils

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.utils.LocalFileSystemUtils
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class LocalFileSystemUtils
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static java.lang.StringOS_PROPERTY 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      private LocalFileSystemUtils() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static java.lang.StringexpandTilde(java.lang.String path) +
      Expand the tilde in a String representation of a path by the users home directory, as provided by the user.home property.
      +
      static FileSystem[]getLocalFileSystems() +
      Returns all local FileSystems.
      +
      static java.lang.StringgetLocalRoot(java.lang.String p) +
      Return the locally valid root element of an String representation of an absolute path.
      +
      static java.lang.StringgetLocalRootlessPath(java.lang.String path) +
      Return the local root less path of an absolute path.
      +
      static chargetLocalSeparator() +
      Returns the local file system path separator character.
      +
      static booleanisLinux() +
      Returns if we are currently running on Linux.
      +
      static booleanisLinuxRoot(java.lang.String root) +
      Check if root only contains a valid Linux root element, which is "/".
      +
      static booleanisLocalRoot(java.lang.String root) +
      Check if root contains a locally valid root element, such as "C:" on Windows or "/" on Linux and OSX.
      +
      static booleanisOSX() +
      Returns if we are currently running on OSX.
      +
      static booleanisOSXRoot(java.lang.String root) +
      Check if root contains a valid OSX root element, which is "/".
      +
      static booleanisWindows() +
      Returns if we are currently running on Windows.
      +
      static booleanisWindowsRoot(java.lang.String root) +
      Check if root only contains a valid Windows root element such as "C:".
      +
      static booleanstartsWithLinuxRoot(java.lang.String path) +
      Checks if the provide path starts with a valid Linux root, that is "/".
      +
      static booleanstartWithRoot(java.lang.String path) +
      Checks if the provide path starts with a valid root, such as "/" or "C:".
      +
      static booleanstartWithWindowsRoot(java.lang.String path) +
      Checks if the provide path starts with a valid Windows root, for example "C:".
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        LocalFileSystemUtils

        +
        private LocalFileSystemUtils()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isWindows

        +
        public static boolean isWindows()
        +
        Returns if we are currently running on Windows.
        +
        +
        Returns:
        +
        if we are currently running on Window.
        +
        +
        • +
      + + + +
        +
      • +

        isOSX

        +
        public static boolean isOSX()
        +
        Returns if we are currently running on OSX.
        +
        +
        Returns:
        +
        if we are currently running on OSX.
        +
        +
        • +
      + + + +
        +
      • +

        isLinux

        +
        public static boolean isLinux()
        +
        Returns if we are currently running on Linux.
        +
        +
        Returns:
        +
        if we are currently running on Linux.
        +
        +
        • +
      + + + +
        +
      • +

        isWindowsRoot

        +
        public static boolean isWindowsRoot(java.lang.String root)
        +
        Check if root only contains a valid Windows root element such as "C:". + + If root is null or empty, false will be returned. If root contains more than just a root element, + false will be returned.
        +
        +
        Parameters:
        +
        root - The root to check.
        +
        Returns:
        +
        If root only contains a valid Windows root element.
        +
        +
        • +
      + + + +
        +
      • +

        isLinuxRoot

        +
        public static boolean isLinuxRoot(java.lang.String root)
        +
        Check if root only contains a valid Linux root element, which is "/". + + If root is null or empty, false will be returned. If root contains more than just a root element, + false will be returned.
        +
        +
        Parameters:
        +
        root - The root to check.
        +
        Returns:
        +
        If root only contains a valid Linux root element.
        +
        +
        • +
      + + + +
        +
      • +

        isOSXRoot

        +
        public static boolean isOSXRoot(java.lang.String root)
        +
        Check if root contains a valid OSX root element, which is "/". + + If root is null or empty, false will be returned. If root contains more than just a root element, + false will be returned.
        +
        +
        Parameters:
        +
        root - The root to check.
        +
        Returns:
        +
        If root only contains a valid OSX root element.
        +
        +
        • +
      + + + +
        +
      • +

        isLocalRoot

        +
        public static boolean isLocalRoot(java.lang.String root)
        +
        Check if root contains a locally valid root element, such as "C:" on Windows or "/" on Linux and OSX. + + If root is null or empty, false will be returned. If root contains more than just a root element, + false will be returned. + + Note that the result of this method depends on the OS the application is running on.
        +
        +
        Parameters:
        +
        root - The root to check.
        +
        Returns:
        +
        If root only contains a valid OSX root element.
        +
        +
        • +
      + + + +
        +
      • +

        startsWithLinuxRoot

        +
        public static boolean startsWithLinuxRoot(java.lang.String path)
        +
        Checks if the provide path starts with a valid Linux root, that is "/".
        +
        +
        Parameters:
        +
        path - The path to check.
        +
        Returns:
        +
        If the provide path starts with a valid Linux root.
        +
        +
        • +
      + + + +
        +
      • +

        startWithWindowsRoot

        +
        public static boolean startWithWindowsRoot(java.lang.String path)
        +
        Checks if the provide path starts with a valid Windows root, for example "C:".
        +
        +
        Parameters:
        +
        path - The path to check.
        +
        Returns:
        +
        If the provide path starts with a valid Windows root.
        +
        +
        • +
      + + + +
        +
      • +

        startWithRoot

        +
        public static boolean startWithRoot(java.lang.String path)
        +
        Checks if the provide path starts with a valid root, such as "/" or "C:".
        +
        +
        Parameters:
        +
        path - The path to check.
        +
        Returns:
        +
        If the provide path starts with a valid root.
        +
        +
        • +
      + + + +
        +
      • +

        getLocalRoot

        +
        public static java.lang.String getLocalRoot(java.lang.String p)
+                                     throws InvalidLocationException
        +
        Return the locally valid root element of an String representation of an absolute path. + + Examples of a root elements are "/" or "C:". If the provided path does not contain a locally valid root element, an exception will be thrown. For + example, providing "/user/local" will return "/" on Linux or OSX, but throw an exception on Windows; providing "C:\test" will return "C:" on Windows but + throw an exception on Linux or OSX. + + If the provided string is null or empty, the default root element for this OS will be returned, i.e,. "/" on Linux or OSX and "C:" on + windows.
        +
        +
        Parameters:
        +
        p - The absolute path for which to determine the root element.
        +
        Returns:
        +
        The locally valid root element.
        +
        Throws:
        +
        InvalidLocationException - If the provided path is not absolute, or does not contain a locally valid root.
        +
        +
        • +
      + + + +
        +
      • +

        expandTilde

        +
        public static java.lang.String expandTilde(java.lang.String path)
        +
        Expand the tilde in a String representation of a path by the users home directory, as provided by the user.home property. + + The tilde will only be replaced if it is the first character in the path and either the only character in the path or directly followed by the local + separator character or directly followed by the local user name (as provided by the user.name property). + + For example, if user.name is set to "john" and user.home is set to "/home/john", then "~" will be expanded to "/home/john", + "~/foo" or "~john/foo" will be expanded to "/home/john/foo". + + However, in paths like "/foo/bar", "~matt/foo" or "/foo/~" the tilde will not be expanded, and the provided path is returned unchanged. This includes a + path that is null. + + If the user.home property is not set, the tilde will not be expanded and the provided path will be returned unchanged. If the + user.name property is not set, the combined tilde-username expansion will not be performed.
        +
        +
        Parameters:
        +
        path - the path in which to replace the tilde (if possible).
        +
        Returns:
        +
        the path with the tilde replaced by the user home property, or the unchanged path if replacement was not triggered.
        +
        +
        • +
      + + + +
        +
      • +

        getLocalRootlessPath

        +
        public static java.lang.String getLocalRootlessPath(java.lang.String path)
        +
        Return the local root less path of an absolute path.
        +
        +
        Parameters:
        +
        path - The absolute path from which to remove the root element.
        +
        Returns:
        +
        The path without the root element.
        +
        +
        • +
      + + + +
        +
      • +

        getLocalSeparator

        +
        public static char getLocalSeparator()
        +
        Returns the local file system path separator character.
        +
        +
        Returns:
        +
        The local file system path separator character.
        +
        +
        • +
      + + + +
        +
      • +

        getLocalFileSystems

        +
        public static FileSystem[] getLocalFileSystems()
+                                        throws XenonException
        +
        Returns all local FileSystems. + + This method detects all local file system roots, and returns one or more FileSystems representing each of these roots.
        +
        +
        Returns:
        +
        all local FileSystems.
        +
        Throws:
        +
        XenonException - If the creation of the FileSystem failed.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/OutputReader.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/OutputReader.html new file mode 100644 index 000000000..b28ecb23b --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/OutputReader.html @@ -0,0 +1,513 @@ + + + + + +OutputReader (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.utils
+

Class OutputReader

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Thread
      • +
    • +
        +
      • nl.esciencecenter.xenon.utils.OutputReader
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Runnable
    +
    +
    +
    +
    public final class OutputReader
+extends java.lang.Thread
    +
    A simple output reader that uses a daemon thread to read from an InputStream and buffer this data. Once + end-of-stream is reached, this data will be made available as a String. + + Note that since the data is buffered in memory, so it is not advisable to use this OutputReader to read large amounts of data.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class java.lang.Thread

        +java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.nio.ByteBufferbuffer 
      private static intBUFFER_SIZE 
      private booleanfinished 
      private java.io.InputStreamsource 
      +
        +
      • + + +

        Fields inherited from class java.lang.Thread

        +MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      OutputReader(java.io.InputStream source) +
      Create an OutputReader that reads from source.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private voidaddToBuffer(byte[] bytes, + int length) 
      byte[]getResult() +
      Returns the data that has been read from the InputStream as a byte array.
      +
      java.lang.StringgetResultAsString() +
      Returns the data that has been read from the InputStream as a String.
      +
      booleanisFinished() +
      Returns if the OutputReader has finished (i.e., has reached the end-of-stream on the input).
      +
      voidrun() +
      Entry method for daemon thread.
      +
      private voidsetFinished() 
      voidwaitUntilFinished() +
      Waits until the OutputReader has finished (i.e., has reached the end-of-stream on the input).
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Thread

        +activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        source

        +
        private final java.io.InputStream source
        +
        • +
      + + + +
        +
      • +

        buffer

        +
        private java.nio.ByteBuffer buffer
        +
        • +
      + + + +
        +
      • +

        finished

        +
        private boolean finished
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OutputReader

        +
        public OutputReader(java.io.InputStream source)
        +
        Create an OutputReader that reads from source.
        +
        +
        Parameters:
        +
        source - the {#link InputStream} to read from.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setFinished

        +
        private void setFinished()
        +
        • +
      + + + +
        +
      • +

        isFinished

        +
        public boolean isFinished()
        +
        Returns if the OutputReader has finished (i.e., has reached the end-of-stream on the input). If so, the data that has been + read is now available through getResultAsString().
        +
        +
        Returns:
        +
        if the OutputReader has finished reading.
        +
        +
        • +
      + + + +
        +
      • +

        waitUntilFinished

        +
        public void waitUntilFinished()
        +
        Waits until the OutputReader has finished (i.e., has reached the end-of-stream on the input). After this method returns, + the data that has been read is available through getResultAsString().
        +
        • +
      + + + +
        +
      • +

        addToBuffer

        +
        private void addToBuffer(byte[] bytes,
+                         int length)
        +
        • +
      + + + +
        +
      • +

        run

        +
        public void run()
        +
        Entry method for daemon thread.
        +
        +
        Specified by:
        +
        run in interface java.lang.Runnable
        +
        Overrides:
        +
        run in class java.lang.Thread
        +
        +
        • +
      + + + +
        +
      • +

        getResultAsString

        +
        public java.lang.String getResultAsString()
        +
        Returns the data that has been read from the InputStream as a String. If the + OutputReader has not finished reading, this method will block until end-of-stream has been reached.
        +
        +
        Returns:
        +
        the data that has been read.
        +
        +
        • +
      + + + +
        +
      • +

        getResult

        +
        public byte[] getResult()
        +
        Returns the data that has been read from the InputStream as a byte array. If the + OutputReader has not finished reading, this method will block until end-of-stream has been reached.
        +
        +
        Returns:
        +
        the data that has been read.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/StreamForwarder.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/StreamForwarder.html new file mode 100644 index 000000000..c29c27caf --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/StreamForwarder.html @@ -0,0 +1,520 @@ + + + + + +StreamForwarder (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
nl.esciencecenter.xenon.utils
+

Class StreamForwarder

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.lang.Thread
      • +
    • +
        +
      • nl.esciencecenter.xenon.utils.StreamForwarder
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Runnable
    +
    +
    +
    +
    public final class StreamForwarder
+extends java.lang.Thread
    +
    A simple stream forwarder that uses a daemon thread to read from an InputStream and write it to a OutputStream. A small + buffer is used (typically 1 KB) to improve performance. Any exceptions will be ignored.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class java.lang.Thread

        +java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private intbufferSize 
      private static intDEFAULT_BUFFER_SIZE 
      private booleandone 
      private java.io.InputStreamin 
      private static org.slf4j.LoggerLOGGER 
      private java.io.OutputStreamout 
      +
        +
      • + + +

        Fields inherited from class java.lang.Thread

        +MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      StreamForwarder(java.io.InputStream in, + java.io.OutputStream out) +
      Create a new StreamForwarder and start it immediately.
      +
      StreamForwarder(java.lang.String name, + java.io.InputStream in, + java.io.OutputStream out, + int bufferSize) +
      Create a new StreamForwarder and start it immediately.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private voidclose(java.io.Closeable c, + java.lang.String error) +
      Closes the input stream, thereby stopping the stream forwarder, and closing the output stream.
      +
      private voiddone() +
      Tell the daemon thread that we are done.
      +
      voidrun() +
      Main entry method for the daemon thread.
      +
      voidterminate(long timeout) +
      Wait for a given timeout for the StreamForwarder to terminate by reading an end-of-stream on the input.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Thread

        +activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOGGER

        +
        private static final org.slf4j.Logger LOGGER
        +
        • +
      + + + +
        +
      • +

        DEFAULT_BUFFER_SIZE

        +
        private static final int DEFAULT_BUFFER_SIZE
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        in

        +
        private final java.io.InputStream in
        +
        • +
      + + + +
        +
      • +

        out

        +
        private final java.io.OutputStream out
        +
        • +
      + + + +
        +
      • +

        bufferSize

        +
        private final int bufferSize
        +
        • +
      + + + +
        +
      • +

        done

        +
        private boolean done
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StreamForwarder

        +
        public StreamForwarder(java.lang.String name,
+                       java.io.InputStream in,
+                       java.io.OutputStream out,
+                       int bufferSize)
        +
        Create a new StreamForwarder and start it immediately.
        +
        +
        Parameters:
        +
        name - the name of the thread
        +
        in - the InputStream to read from.
        +
        out - the OutputStream to write to, or null to discard the output.
        +
        bufferSize - the buffer size to use, or 0 to use the default.
        +
        +
        • +
      + + + +
        +
      • +

        StreamForwarder

        +
        public StreamForwarder(java.io.InputStream in,
+                       java.io.OutputStream out)
        +
        Create a new StreamForwarder and start it immediately.
        +
        +
        Parameters:
        +
        in - the InputStream to read from.
        +
        out - the OutputStream to write to.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        private void close(java.io.Closeable c,
+                   java.lang.String error)
        +
        Closes the input stream, thereby stopping the stream forwarder, and closing the output stream.
        +
        +
        Parameters:
        +
        c - The Closeable to close (i.e., the InputStream or OutputStream)
        +
        error - The error message to print if the close results in an Exception
        +
        +
        • +
      + + + +
        +
      • +

        done

        +
        private void done()
        +
        Tell the daemon thread that we are done.
        +
        • +
      + + + +
        +
      • +

        terminate

        +
        public void terminate(long timeout)
        +
        Wait for a given timeout for the StreamForwarder to terminate by reading an end-of-stream on the input. When the timeout expires both input and output + streams will be closed, regardless of whether the input has reached end-of-line.
        +
        +
        Parameters:
        +
        timeout - The number of milliseconds to wait for termination.
        +
        +
        • +
      + + + +
        +
      • +

        run

        +
        public void run()
        +
        Main entry method for the daemon thread.
        +
        +
        Specified by:
        +
        run in interface java.lang.Runnable
        +
        Overrides:
        +
        run in class java.lang.Thread
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/package-frame.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/package-frame.html new file mode 100644 index 000000000..e3fcf983c --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/package-frame.html @@ -0,0 +1,23 @@ + + + + + +nl.esciencecenter.xenon.utils (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +

nl.esciencecenter.xenon.utils

+
+

Classes

+ +
+ + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/package-summary.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/package-summary.html new file mode 100644 index 000000000..b0b6e34fc --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/package-summary.html @@ -0,0 +1,172 @@ + + + + + +nl.esciencecenter.xenon.utils (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package nl.esciencecenter.xenon.utils

+
+
This package is contains several utility classes.
+
+

See: Description

+
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    InputWriter +
    A simple input writer that uses a daemon thread to write from an String to an OutputStream.
    +
    JavaJobDescription +
    A JobDescription specialized in Java applications.
    +
    LocalFileSystemUtils 
    OutputReader +
    A simple output reader that uses a daemon thread to read from an InputStream and buffer this data.
    +
    StreamForwarder +
    A simple stream forwarder that uses a daemon thread to read from an InputStream and write it to a OutputStream.
    +
    +
    • +
+ + + +

Package nl.esciencecenter.xenon.utils Description

+
This package is contains several utility classes.
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/package-tree.html b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/package-tree.html new file mode 100644 index 000000000..51eb5b04a --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/nl/esciencecenter/xenon/utils/package-tree.html @@ -0,0 +1,146 @@ + + + + + +nl.esciencecenter.xenon.utils Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package nl.esciencecenter.xenon.utils

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/docs/versions/2.6.1/javadoc-devel/overview-frame.html b/docs/versions/2.6.1/javadoc-devel/overview-frame.html new file mode 100644 index 000000000..ebd31c5d6 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/overview-frame.html @@ -0,0 +1,40 @@ + + + + + +Overview List (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + +
All Classes
+
+

Packages

+ +
+

 

+ + diff --git a/docs/versions/2.6.1/javadoc-devel/overview-summary.html b/docs/versions/2.6.1/javadoc-devel/overview-summary.html new file mode 100644 index 000000000..f992112b9 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/overview-summary.html @@ -0,0 +1,804 @@ + + + + + +Overview (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+
    +
  • Prev
    • +
  • Next
    • +
+ + +
+ +
+ + +
+ +
+

xenon-2.3.0 2.6.1 API for Xenon developers

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

See: Description

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
nl.esciencecenter.xenon +
This package is the main entry point into the Xenon API.
+
nl.esciencecenter.xenon.adaptors 
nl.esciencecenter.xenon.adaptors.filesystems 
nl.esciencecenter.xenon.adaptors.filesystems.ftp 
nl.esciencecenter.xenon.adaptors.filesystems.hdfs 
nl.esciencecenter.xenon.adaptors.filesystems.jclouds 
nl.esciencecenter.xenon.adaptors.filesystems.local 
nl.esciencecenter.xenon.adaptors.filesystems.s3 
nl.esciencecenter.xenon.adaptors.filesystems.sftp 
nl.esciencecenter.xenon.adaptors.filesystems.webdav 
nl.esciencecenter.xenon.adaptors.schedulers 
nl.esciencecenter.xenon.adaptors.schedulers.gridengine 
nl.esciencecenter.xenon.adaptors.schedulers.local 
nl.esciencecenter.xenon.adaptors.schedulers.slurm 
nl.esciencecenter.xenon.adaptors.schedulers.ssh 
nl.esciencecenter.xenon.adaptors.schedulers.torque 
nl.esciencecenter.xenon.adaptors.shared.ssh 
nl.esciencecenter.xenon.credentials +
This package contains classes and interfaces for managing credentials.
+
nl.esciencecenter.xenon.filesystems +
This package contains classes and interfaces for manipulating files.
+
nl.esciencecenter.xenon.schedulers +
This package contains the classes and interfaces used to run jobs.
+
nl.esciencecenter.xenon.utils +
This package is contains several utility classes.
+
+
+
+ + +
A middleware abstraction library that provides a simple programming interface to various compute and storage resources. +

The main entry points are

+

Adaptor Documentation

+

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

+ +

Schedulers

+

local

+

The local jobs adaptor implements all functionality by emulating a local queue.

+

Supported locations:

+Supported locations for Scheduler.create(type, location, credential, properties) method.
    +
  • [/workdir]
    • +
+

Supported properties:

+Supported properties for Scheduler.create(type, location, credential, properties) method. + + + + + + + + + + + + + +
NameDescriptionExpected typeDefault
xenon.adaptors.schedulers.local.queue.pollingDelay
The polling delay for monitoring running jobs (in milliseconds).LONG1000
xenon.adaptors.schedulers.local.queue.multi.maxConcurrentJobs
The maximum number of concurrent jobs in the multiq.INTEGER4
+

Supported features

    +
  • Batch: true
    • +
  • Interactive: true
    • +
  • Embedded: true
    • +
  • Uses a filesystem: true
    • +
+

ssh

+

The SSH job adaptor implements all functionality to start jobs on ssh servers.

+

Supported locations:

+Supported locations for Scheduler.create(type, location, credential, properties) method.
    +
  • host[:port][/workdir][ via:otherhost[:port]]*
    • +
+

Supported properties:

+Supported properties for Scheduler.create(type, location, credential, properties) method. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionExpected typeDefault
xenon.adaptors.schedulers.ssh.strictHostKeyChecking
Enable strict host key checking.BOOLEANtrue
xenon.adaptors.schedulers.ssh.loadKnownHosts
Load the standard known_hosts file.BOOLEANtrue
xenon.adaptors.schedulers.ssh.loadSshConfig
Load the OpenSSH config file.BOOLEANtrue
xenon.adaptors.schedulers.ssh.agent
Use a (local) ssh-agent.BOOLEANfalse
xenon.adaptors.schedulers.ssh.agentForwarding
Use ssh-agent forwardingBOOLEANfalse
xenon.adaptors.schedulers.ssh.timeout
The timeout for the connection setup and authetication (in milliseconds).LONG10000
xenon.adaptors.schedulers.ssh.queue.pollingDelay
The polling delay for monitoring running jobs (in milliseconds).LONG1000
xenon.adaptors.schedulers.ssh.queue.multi.maxConcurrentJobs
The maximum number of concurrent jobs in the multiq..INTEGER4
+

Supported features

    +
  • Batch: true
    • +
  • Interactive: true
    • +
  • Embedded: true
    • +
  • Uses a filesystem: true
    • +
+

gridengine

+

The SGE Adaptor submits jobs to a (Sun/Oracle/Univa) Grid Engine scheduler. This adaptor uses either the local or the ssh scheduler adaptor to run commands on the machine running Grid Engine, and the file or the stfp filesystem adaptor to gain access to the filesystem of that machine.

+

Supported locations:

+Supported locations for Scheduler.create(type, location, credential, properties) method.
    +
  • local://[/workdir]
    • +
  • ssh://host[:port][/workdir][ via:otherhost[:port]]*
    • +
+

Supported properties:

+Supported properties for Scheduler.create(type, location, credential, properties) method. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionExpected typeDefault
xenon.adaptors.schedulers.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!BOOLEANfalse
xenon.adaptors.schedulers.gridengine.accounting.grace.time
Number of milliseconds a job is allowed to take going from the queue to the qacct output.LONG60000
xenon.adaptors.schedulers.gridengine.poll.delay
Number of milliseconds between polling the status of a job.LONG1000
xenon.adaptors.schedulers.ssh.strictHostKeyChecking
Enable strict host key checking.BOOLEANtrue
xenon.adaptors.schedulers.ssh.loadKnownHosts
Load the standard known_hosts file.BOOLEANtrue
xenon.adaptors.schedulers.ssh.loadSshConfig
Load the OpenSSH config file.BOOLEANtrue
xenon.adaptors.schedulers.ssh.agent
Use a (local) ssh-agent.BOOLEANfalse
xenon.adaptors.schedulers.ssh.agentForwarding
Use ssh-agent forwardingBOOLEANfalse
xenon.adaptors.schedulers.ssh.timeout
The timeout for the connection setup and authetication (in milliseconds).LONG10000
xenon.adaptors.schedulers.ssh.queue.pollingDelay
The polling delay for monitoring running jobs (in milliseconds).LONG1000
xenon.adaptors.schedulers.ssh.queue.multi.maxConcurrentJobs
The maximum number of concurrent jobs in the multiq..INTEGER4
xenon.adaptors.schedulers.local.queue.pollingDelay
The polling delay for monitoring running jobs (in milliseconds).LONG1000
xenon.adaptors.schedulers.local.queue.multi.maxConcurrentJobs
The maximum number of concurrent jobs in the multiq.INTEGER4
+

Supported features

    +
  • Batch: true
    • +
  • Interactive: false
    • +
  • Embedded: false
    • +
  • Uses a filesystem: true
    • +
+

slurm

+

The Slurm Adaptor submits jobs to a Slurm scheduler. This adaptor uses either the local or the ssh scheduler adaptor to run commands on the machine running Slurm, and the file or the stfp filesystem adaptor to gain access to the filesystem of that machine.

+

Supported locations:

+Supported locations for Scheduler.create(type, location, credential, properties) method.
    +
  • local://[/workdir]
    • +
  • ssh://host[:port][/workdir][ via:otherhost[:port]]*
    • +
+

Supported properties:

+Supported properties for Scheduler.create(type, location, credential, properties) method. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionExpected typeDefault
xenon.adaptors.schedulers.slurm.disable.accounting.usage
Do not use accounting info of slurm, even when available. Mostly for testing purposesBOOLEANfalse
xenon.adaptors.schedulers.slurm.poll.delay
Number of milliseconds between polling the status of a job.LONG1000
xenon.adaptors.schedulers.ssh.strictHostKeyChecking
Enable strict host key checking.BOOLEANtrue
xenon.adaptors.schedulers.ssh.loadKnownHosts
Load the standard known_hosts file.BOOLEANtrue
xenon.adaptors.schedulers.ssh.loadSshConfig
Load the OpenSSH config file.BOOLEANtrue
xenon.adaptors.schedulers.ssh.agent
Use a (local) ssh-agent.BOOLEANfalse
xenon.adaptors.schedulers.ssh.agentForwarding
Use ssh-agent forwardingBOOLEANfalse
xenon.adaptors.schedulers.ssh.timeout
The timeout for the connection setup and authetication (in milliseconds).LONG10000
xenon.adaptors.schedulers.ssh.queue.pollingDelay
The polling delay for monitoring running jobs (in milliseconds).LONG1000
xenon.adaptors.schedulers.ssh.queue.multi.maxConcurrentJobs
The maximum number of concurrent jobs in the multiq..INTEGER4
xenon.adaptors.schedulers.local.queue.pollingDelay
The polling delay for monitoring running jobs (in milliseconds).LONG1000
xenon.adaptors.schedulers.local.queue.multi.maxConcurrentJobs
The maximum number of concurrent jobs in the multiq.INTEGER4
+

Supported features

    +
  • Batch: true
    • +
  • Interactive: true
    • +
  • Embedded: false
    • +
  • Uses a filesystem: true
    • +
+

torque

+

The Torque Adaptor submits jobs to a TORQUE batch system. This adaptor uses either the local or the ssh scheduler adaptor to run commands on the machine running TORQUE, and the file or the stfp filesystem adaptor to gain access to the filesystem of that machine.

+

Supported locations:

+Supported locations for Scheduler.create(type, location, credential, properties) method.
    +
  • local://[/workdir]
    • +
  • ssh://host[:port][/workdir][ via:otherhost[:port]]*
    • +
+

Supported properties:

+Supported properties for Scheduler.create(type, location, credential, properties) method. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionExpected typeDefault
xenon.adaptors.schedulers.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!BOOLEANfalse
xenon.adaptors.schedulers.torque.accounting.grace.time
Number of milliseconds a job is allowed to take going from the queue to the accinfo output.LONG60000
xenon.adaptors.schedulers.torque.poll.delay
Number of milliseconds between polling the status of a job.LONG1000
xenon.adaptors.schedulers.ssh.strictHostKeyChecking
Enable strict host key checking.BOOLEANtrue
xenon.adaptors.schedulers.ssh.loadKnownHosts
Load the standard known_hosts file.BOOLEANtrue
xenon.adaptors.schedulers.ssh.loadSshConfig
Load the OpenSSH config file.BOOLEANtrue
xenon.adaptors.schedulers.ssh.agent
Use a (local) ssh-agent.BOOLEANfalse
xenon.adaptors.schedulers.ssh.agentForwarding
Use ssh-agent forwardingBOOLEANfalse
xenon.adaptors.schedulers.ssh.timeout
The timeout for the connection setup and authetication (in milliseconds).LONG10000
xenon.adaptors.schedulers.ssh.queue.pollingDelay
The polling delay for monitoring running jobs (in milliseconds).LONG1000
xenon.adaptors.schedulers.ssh.queue.multi.maxConcurrentJobs
The maximum number of concurrent jobs in the multiq..INTEGER4
xenon.adaptors.schedulers.local.queue.pollingDelay
The polling delay for monitoring running jobs (in milliseconds).LONG1000
xenon.adaptors.schedulers.local.queue.multi.maxConcurrentJobs
The maximum number of concurrent jobs in the multiq.INTEGER4
+

Supported features

    +
  • Batch: true
    • +
  • Interactive: false
    • +
  • Embedded: false
    • +
  • Uses a filesystem: true
    • +
+

File systems

+

file

+

This is the local file adaptor that implements file functionality for local access.

+

Supported locations:

+Supported locations for FileSystem.create(type, location, credential, properties) method. +
  • (null)
    • +
  • (empty string)
    • +
  • [/workdir]
    • +
  • driveletter:[/workdir]
    • + +

    Supported properties:

    +Supported properties for FileSystem.create(type, location, credential, properties) method. + + + + + + + +
    NameDescriptionExpected typeDefault
    xenon.adaptors.filesystems.file.bufferSize
    		The buffer size to use when copying files (in bytes).SIZE64K
    +

    Supported features

      +
    • Read symbolic links: true
      • +
    • Create symbolic links: true
      • +
    • Third party copy: false
      • +
    +

    ftp

    +

    The FTP adaptor implements file access on remote ftp servers.

    +

    Supported locations:

    +Supported locations for FileSystem.create(type, location, credential, properties) method. +
  • host[:port][/workdir]
    • + +

    Supported properties:

    +Supported properties for FileSystem.create(type, location, credential, properties) method. + + + + + + + +
    NameDescriptionExpected typeDefault
    xenon.adaptors.filesystems.ftp.bufferSize
    		The buffer size to use when copying files (in bytes).SIZE64K
    +

    Supported features

      +
    • Read symbolic links: true
      • +
    • Create symbolic links: false
      • +
    • Third party copy: false
      • +
    +

    sftp

    +

    The SFTP adaptor implements all file access functionality to remote SFTP servers

    +

    Supported locations:

    +Supported locations for FileSystem.create(type, location, credential, properties) method. +
  • host[:port][/workdir]
    • + +

    Supported properties:

    +Supported properties for FileSystem.create(type, location, credential, properties) method. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionExpected typeDefault
    xenon.adaptors.filesystems.sftp.strictHostKeyChecking
    		Enable strict host key checking.BOOLEANtrue
    xenon.adaptors.filesystems.sftp.loadKnownHosts
    		Load the standard known_hosts file.BOOLEANtrue
    xenon.adaptors.filesystems.sftp.loadSshConfig
    		Load the OpenSSH config file.BOOLEANtrue
    xenon.adaptors.filesystems.sftp.agent
    		Use a (local) ssh-agent.BOOLEANfalse
    xenon.adaptors.filesystems.sftp.agentForwarding
    		Use ssh-agent forwarding when setting up a connection.BOOLEANfalse
    xenon.adaptors.filesystems.sftp.connection.timeout
    		The timeout for creating and authenticating connections (in milliseconds).NATURAL10000
    xenon.adaptors.filesystems.sftp.bufferSize
    		The buffer size to use when copying files (in bytes).SIZE64K
    +

    Supported features

      +
    • Read symbolic links: true
      • +
    • Create symbolic links: true
      • +
    • Third party copy: false
      • +
    +

    webdav

    +

    The webdav file adaptor implements file access to remote webdav servers.

    +

    Supported locations:

    +Supported locations for FileSystem.create(type, location, credential, properties) method. +
  • http://host[:port][/workdir]
    • +
  • https://host[:port][/workdir]
    • + +

    Supported properties:

    +Supported properties for FileSystem.create(type, location, credential, properties) method. + + + + + + + +
    NameDescriptionExpected typeDefault
    xenon.adaptors.filesystems.webdav.bufferSize
    		The buffer size to use when copying files (in bytes).SIZE64K
    +

    Supported features

      +
    • Read symbolic links: false
      • +
    • Create symbolic links: false
      • +
    • Third party copy: false
      • +
    +

    s3

    +

    The JClouds adaptor uses Apache JClouds to talk to s3 and others

    +

    Supported locations:

    +Supported locations for FileSystem.create(type, location, credential, properties) method. +
  • [http://host[:port]]/bucketname[/workdir]
    • + +

    Supported properties:

    +Supported properties for FileSystem.create(type, location, credential, properties) method. + + + + + + + +
    NameDescriptionExpected typeDefault
    xenon.adaptors.filesystems.s3.bufferSize
    		The buffer size to use when copying files (in bytes).SIZE64K
    +

    Supported features

      +
    • Read symbolic links: false
      • +
    • Create symbolic links: false
      • +
    • Third party copy: false
      • +
    +

    hdfs

    +

    Adaptor for the Apache Hadoop file system

    +

    Supported locations:

    +Supported locations for FileSystem.create(type, location, credential, properties) method. +
  • hdfs://host[:port]
    • + +

    Supported properties:

    +Supported properties for FileSystem.create(type, location, credential, properties) method. + + + + + + + + + + + + + +
    NameDescriptionExpected typeDefault
    xenon.adaptors.filesystems.hdfs.bufferSize
    		The buffer size to use when copying files (in bytes).SIZE64K
    xenon.adaptors.filesystems.hdfs.hadoopSettingsFile
    		The path to the file with the hadoop settings, i.e. "/home/xenon/core-site.xml".STRING
    +

    Supported features

      +
    • Read symbolic links: false
      • +
    • Create symbolic links: false
      • +
    • Third party copy: false
      • +
    +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc-devel/overview-tree.html b/docs/versions/2.6.1/javadoc-devel/overview-tree.html new file mode 100644 index 000000000..cc16db4e6 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/overview-tree.html @@ -0,0 +1,366 @@ + + + + + +Class Hierarchy (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + +
    +

    Hierarchy For All Packages

    +Package Hierarchies: + +
    +
    +

    Class Hierarchy

    + +

    Interface Hierarchy

    + +

    Enum Hierarchy

    + +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc-devel/package-list b/docs/versions/2.6.1/javadoc-devel/package-list new file mode 100644 index 000000000..628c3b957 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/package-list @@ -0,0 +1,21 @@ +nl.esciencecenter.xenon +nl.esciencecenter.xenon.adaptors +nl.esciencecenter.xenon.adaptors.filesystems +nl.esciencecenter.xenon.adaptors.filesystems.ftp +nl.esciencecenter.xenon.adaptors.filesystems.hdfs +nl.esciencecenter.xenon.adaptors.filesystems.jclouds +nl.esciencecenter.xenon.adaptors.filesystems.local +nl.esciencecenter.xenon.adaptors.filesystems.s3 +nl.esciencecenter.xenon.adaptors.filesystems.sftp +nl.esciencecenter.xenon.adaptors.filesystems.webdav +nl.esciencecenter.xenon.adaptors.schedulers +nl.esciencecenter.xenon.adaptors.schedulers.gridengine +nl.esciencecenter.xenon.adaptors.schedulers.local +nl.esciencecenter.xenon.adaptors.schedulers.slurm +nl.esciencecenter.xenon.adaptors.schedulers.ssh +nl.esciencecenter.xenon.adaptors.schedulers.torque +nl.esciencecenter.xenon.adaptors.shared.ssh +nl.esciencecenter.xenon.credentials +nl.esciencecenter.xenon.filesystems +nl.esciencecenter.xenon.schedulers +nl.esciencecenter.xenon.utils diff --git a/docs/versions/2.6.1/javadoc-devel/script.js b/docs/versions/2.6.1/javadoc-devel/script.js new file mode 100644 index 000000000..b34635693 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/docs/versions/2.6.1/javadoc-devel/serialized-form.html b/docs/versions/2.6.1/javadoc-devel/serialized-form.html new file mode 100644 index 000000000..1045627f0 --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/serialized-form.html @@ -0,0 +1,506 @@ + + + + + +Serialized Form (xenon-2.3.0 2.6.1 API for Xenon developers) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + +
    +

    Serialized Form

    +
    +
    + +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc-devel/stylesheet.css b/docs/versions/2.6.1/javadoc-devel/stylesheet.css new file mode 100644 index 000000000..98055b22d --- /dev/null +++ b/docs/versions/2.6.1/javadoc-devel/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/docs/versions/2.6.1/javadoc/allclasses-frame.html b/docs/versions/2.6.1/javadoc/allclasses-frame.html new file mode 100644 index 000000000..0a1d5c5f1 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/allclasses-frame.html @@ -0,0 +1,69 @@ + + + + + +All Classes (xenon-2.3.0 2.6.1 API) + + + + +

    All Classes

    +
    + +
    + + diff --git a/docs/versions/2.6.1/javadoc/allclasses-noframe.html b/docs/versions/2.6.1/javadoc/allclasses-noframe.html new file mode 100644 index 000000000..8d8772bec --- /dev/null +++ b/docs/versions/2.6.1/javadoc/allclasses-noframe.html @@ -0,0 +1,69 @@ + + + + + +All Classes (xenon-2.3.0 2.6.1 API) + + + + +

    All Classes

    +
    + +
    + + diff --git a/docs/versions/2.6.1/javadoc/constant-values.html b/docs/versions/2.6.1/javadoc/constant-values.html new file mode 100644 index 000000000..11811bd50 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/constant-values.html @@ -0,0 +1,171 @@ + + + + + +Constant Field Values (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + +
    +

    Constant Field Values

    +

    Contents

    + +
    +
    + + +

    nl.esciencecenter.*

    +
      +
    • + + + + + + + + + + + + + + +
      nl.esciencecenter.xenon.filesystems.Path 
      Modifier and TypeConstant FieldValue
      + +public static final charDEFAULT_SEPARATOR47
      +
      • +
    + +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/deprecated-list.html b/docs/versions/2.6.1/javadoc/deprecated-list.html new file mode 100644 index 000000000..2a1ff7c92 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/deprecated-list.html @@ -0,0 +1,121 @@ + + + + + +Deprecated List (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + +
    +

    Deprecated API

    +

    Contents

    +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/help-doc.html b/docs/versions/2.6.1/javadoc/help-doc.html new file mode 100644 index 000000000..fa84e16b6 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/help-doc.html @@ -0,0 +1,222 @@ + + + + + +API Help (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + +
    +

    How This API Document Is Organized

    +
    This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
    +
    +
    +
      +
    • +

      Overview

      +

      The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

      +
      • +
    • +

      Package

      +

      Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

      +
        +
      • Interfaces (italic)
        • +
      • Classes
        • +
      • Enums
        • +
      • Exceptions
        • +
      • Errors
        • +
      • Annotation Types
        • +
      +
      • +
    • +

      Class/Interface

      +

      Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

      +
        +
      • Class inheritance diagram
        • +
      • Direct Subclasses
        • +
      • All Known Subinterfaces
        • +
      • All Known Implementing Classes
        • +
      • Class/interface declaration
        • +
      • Class/interface description
        • +
      +
        +
      • Nested Class Summary
        • +
      • Field Summary
        • +
      • Constructor Summary
        • +
      • Method Summary
        • +
      +
        +
      • Field Detail
        • +
      • Constructor Detail
        • +
      • Method Detail
        • +
      +

      Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

      +
      • +
    • +

      Annotation Type

      +

      Each annotation type has its own separate page with the following sections:

      +
        +
      • Annotation Type declaration
        • +
      • Annotation Type description
        • +
      • Required Element Summary
        • +
      • Optional Element Summary
        • +
      • Element Detail
        • +
      +
      • +
    • +

      Enum

      +

      Each enum has its own separate page with the following sections:

      +
        +
      • Enum declaration
        • +
      • Enum description
        • +
      • Enum Constant Summary
        • +
      • Enum Constant Detail
        • +
      +
      • +
    • +

      Tree (Class Hierarchy)

      +

      There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

      +
        +
      • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
        • +
      • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
        • +
      +
      • +
    • +

      Deprecated API

      +

      The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

      +
      • +
    • +

      Index

      +

      The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

      +
      • +
    • +

      Prev/Next

      +

      These links take you to the next or previous class, interface, package, or related page.

      +
      • +
    • +

      Frames/No Frames

      +

      These links show and hide the HTML frames. All pages are available with or without frames.

      +
      • +
    • +

      All Classes

      +

      The All Classes link shows all classes and interfaces except non-static nested types.

      +
      • +
    • +

      Serialized Form

      +

      Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

      +
      • +
    • +

      Constant Field Values

      +

      The Constant Field Values page lists the static final fields and their values.

      +
      • +
    +This help file applies to API documentation generated using the standard doclet.
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/index-all.html b/docs/versions/2.6.1/javadoc/index-all.html new file mode 100644 index 000000000..9a9978d2d --- /dev/null +++ b/docs/versions/2.6.1/javadoc/index-all.html @@ -0,0 +1,1703 @@ + + + + + +Index (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + +
    A B C D E F G H I J K L M N O P Q R S T U V W X  + + +

    A

    +
    +
    AdaptorDescription - Interface in nl.esciencecenter.xenon
    +
    +
    AdaptorStatus contains information on a specific adaptor.
    +
    +
    addArgument(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Add a command line argument for the executable.
    +
    +
    addEnvironment(String, String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Add a variable to the environment of the executable.
    +
    +
    addJavaArgument(String) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
     
    +
    addJavaClasspathElement(String) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
     
    +
    addJavaOption(String) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
    +
    Adds a JVM option.
    +
    +
    addJavaSystemProperty(String, String) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
    +
    Adds a system property to the current set of system properties.
    +
    +
    addJobOption(String, String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Add a job option to the job.
    +
    +
    addSchedulerArgument(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Add a scheduler specific argument.
    +
    +
    appendToFile(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Open an existing file and return an OutputStream to append data to this file.
    +
    +
    AttributeNotSupportedException - Exception in nl.esciencecenter.xenon.filesystems
    +
    +
    Signals that a requested file attribute is not supported by the underlying file system implementation.
    +
    +
    AttributeNotSupportedException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.AttributeNotSupportedException
    +
     
    +
    AttributeNotSupportedException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.AttributeNotSupportedException
    +
     
    +
    + + + +

    B

    +
    +
    bytesCopied() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
    +
    +
    Get the number of bytes that have been copied.
    +
    +
    bytesToCopy() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
    +
    +
    Get the number of bytes that need to be copied for the entire copy operation.
    +
    +
    + + + +

    C

    +
    +
    canAppend() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
    +
     
    +
    cancel(String) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Cancel a copy operation.
    +
    +
    cancelJob(String) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Cancel a job.
    +
    +
    canCreateSymboliclinks() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
    +
    +
    Can this adaptor create symbolic links ? + + In third party copy, a file is copied between two remote locations, without passing through the local machine first.
    +
    +
    canReadSymboliclinks() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
    +
    +
    Can this adaptor read symbolic links ?
    +
    +
    CertificateCredential - Class in nl.esciencecenter.xenon.credentials
    +
    +
    A container for security Information based upon certificates.
    +
    +
    CertificateCredential(String, String, char[]) - Constructor for class nl.esciencecenter.xenon.credentials.CertificateCredential
    +
    +
    Constructs a CertificateCredential out of a username, a certificate file containing a private key, and an optional passphrase.
    +
    +
    close() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Close this FileSystem.
    +
    +
    close() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Close this Scheduler.
    +
    +
    contains(PosixFilePermission, PosixFilePermission...) - Static method in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
    +
    +
    Check if a sequence of PosixFilePermissions contains a specific option.
    +
    +
    containsCredential(String) - Method in class nl.esciencecenter.xenon.credentials.CredentialMap
    +
    +
    Check if the key is stored in this CredentialMap.
    +
    +
    copy(Path, FileSystem, Path, CopyMode, boolean) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Asynchronously Copy an existing source path to a target path on a different file system.
    +
    +
    CopyCancelledException - Exception in nl.esciencecenter.xenon.filesystems
    +
     
    +
    CopyCancelledException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.CopyCancelledException
    +
     
    +
    CopyMode - Enum in nl.esciencecenter.xenon.filesystems
    +
    +
    CopyOption is an enumeration containing all possible options for copying a file.
    +
    +
    CopyStatus - Interface in nl.esciencecenter.xenon.filesystems
    +
    +
    CopyStatus contains status information for a specific copy operation.
    +
    +
    create(String, String, Credential, Map<String, String>) - Static method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Create a new FileSystem using the adaptor that connects to a data store at location using the credentials to get + access.
    +
    +
    create(String, String, Credential) - Static method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Create a new FileSystem using the adaptor that connects to a data store at location using the credentials to get + access.
    +
    +
    create(String, String) - Static method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Create a new FileSystem using the adaptor that connects to a data store at location using the default credentials to get + access.
    +
    +
    create(String) - Static method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Create a new FileSystem using the adaptor that connects to a data store at the default location using the default credentials to get access.
    +
    +
    create(String, String, Credential, Map<String, String>) - Static method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Create a new Scheduler using the adaptor connecting to the location using credentials to get access.
    +
    +
    create(String, String, Credential) - Static method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Create a new Scheduler using the adaptor connecting to the location using credentials to get access.
    +
    +
    create(String, String) - Static method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Create a new Scheduler using the adaptor connecting to the location using the default credentials to get access.
    +
    +
    create(String) - Static method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Create a new Scheduler using the adaptor connecting to the default location and using the default credentials to get access.
    +
    +
    createDirectories(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Creates a new directory, failing if the directory already exists.
    +
    +
    createDirectory(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Creates a new directory, failing if the directory already exists.
    +
    +
    createFile(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Creates a new empty file, failing if the file already exists.
    +
    +
    createSymbolicLink(Path, Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Creates a new symbolic link, failing if the link already exists (optional operation).
    +
    +
    Credential - Interface in nl.esciencecenter.xenon.credentials
    +
    +
    Credential represents a user credential uses to gain access to a resource.
    +
    +
    CredentialMap - Class in nl.esciencecenter.xenon.credentials
    +
    +
    A Credential consisting of a collection of Credentials each uniquely identified by a String (typically a host name or host alias).
    +
    +
    CredentialMap() - Constructor for class nl.esciencecenter.xenon.credentials.CredentialMap
    +
    +
    Create a new CredentialMap using null as the default credential.
    +
    +
    CredentialMap(UserCredential) - Constructor for class nl.esciencecenter.xenon.credentials.CredentialMap
    +
    +
    Creates a new CredentialMap and set the default credential to defaultCredential.
    +
    +
    + + + +

    D

    +
    +
    DEFAULT_MAX_RUN_TIME_IN_MINUTES - Static variable in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    The default maximum run time
    +
    +
    DEFAULT_SEPARATOR - Static variable in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    The default separator to use.
    +
    +
    DefaultCredential - Class in nl.esciencecenter.xenon.credentials
    +
    +
    This class represents the default credential that may be used by the various adaptors.
    +
    +
    DefaultCredential() - Constructor for class nl.esciencecenter.xenon.credentials.DefaultCredential
    +
     
    +
    DefaultCredential(String) - Constructor for class nl.esciencecenter.xenon.credentials.DefaultCredential
    +
     
    +
    delete(Path, boolean) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Deletes an existing path.
    +
    +
    DirectoryNotEmptyException - Exception in nl.esciencecenter.xenon.filesystems
    +
    +
    Signals that directory is not empty.
    +
    +
    DirectoryNotEmptyException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.DirectoryNotEmptyException
    +
     
    +
    DirectoryNotEmptyException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.DirectoryNotEmptyException
    +
     
    +
    + + + +

    E

    +
    +
    endsWith(Path) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Tests if this Path ends with the given Path.
    +
    +
    endsWith(String) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Tests if this Path ends with the given Path represented as a String.
    +
    +
    equals(Object) - Method in class nl.esciencecenter.xenon.credentials.CertificateCredential
    +
     
    +
    equals(Object) - Method in class nl.esciencecenter.xenon.credentials.CredentialMap
    +
     
    +
    equals(Object) - Method in class nl.esciencecenter.xenon.credentials.DefaultCredential
    +
     
    +
    equals(Object) - Method in class nl.esciencecenter.xenon.credentials.KeytabCredential
    +
     
    +
    equals(Object) - Method in class nl.esciencecenter.xenon.credentials.PasswordCredential
    +
     
    +
    equals(Object) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
     
    +
    equals(Object) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
     
    +
    equals(Object) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
     
    +
    equals(Object) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
     
    +
    equals(Object) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
     
    +
    exists(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Tests if a path exists.
    +
    +
    expandTilde(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
    +
    +
    Expand the tilde in a String representation of a path by the users home directory, as provided by the user.home property.
    +
    +
    + + + +

    F

    +
    +
    FileSystem - Class in nl.esciencecenter.xenon.filesystems
    +
    +
    FileSystem represent a (possibly remote) file system that can be used to access data.
    +
    +
    FileSystemAdaptorDescription - Interface in nl.esciencecenter.xenon.filesystems
    +
     
    +
    FileSystemClosedException - Exception in nl.esciencecenter.xenon.filesystems
    +
    +
    Signals that a unknown Copy handle was provided.
    +
    +
    FileSystemClosedException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.FileSystemClosedException
    +
     
    +
    FileSystemClosedException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.FileSystemClosedException
    +
     
    +
    + + + +

    G

    +
    +
    get(String) - Method in class nl.esciencecenter.xenon.credentials.CredentialMap
    +
    +
    Retrieve the UserCredential stored using the key.
    +
    +
    getAdaptorDescription(String) - Static method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Gives the description of the adaptor with the given name.
    +
    +
    getAdaptorDescription(String) - Static method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Gives the description of the adaptor with the given name.
    +
    +
    getAdaptorDescriptions() - Static method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Gives a list of the descriptions of the available adaptors.
    +
    +
    getAdaptorDescriptions() - Static method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Gives a list of the descriptions of the available adaptors.
    +
    +
    getAdaptorName() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Get the name of the adaptor that created this FileSystem.
    +
    +
    getAdaptorName() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Get the name of the adaptor that created this Scheduler.
    +
    +
    getAdaptorNames() - Static method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Gives a list names of the available adaptors.
    +
    +
    getAdaptorNames() - Static method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Gives a list names of the available adaptors.
    +
    +
    getArguments() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Get the command line arguments of the executable.
    +
    +
    getArguments() - Method in class nl.esciencecenter.xenon.utils.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.utils.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 class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Get the PathAttributes of an existing path.
    +
    +
    getCertificateFile() - Method in class nl.esciencecenter.xenon.credentials.CertificateCredential
    +
    +
    Returns the certificate file.
    +
    +
    getCopyIdentifier() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
    +
    +
    Get the copy identifier for which this CopyStatus was created.
    +
    +
    getCreationTime() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
    +
    +
    Get the creation time for this file.
    +
    +
    getCredential() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Get the credential that this FileSystem is using.
    +
    +
    getCredential() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Get the credential that this Scheduler is using.
    +
    +
    getDefault() - Method in class nl.esciencecenter.xenon.credentials.CredentialMap
    +
    +
    Returns the default UserCredential.
    +
    +
    getDefaultQueueName() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Get the name of the default queue.
    +
    +
    getDefaultValue() - Method in class nl.esciencecenter.xenon.XenonPropertyDescription
    +
    +
    Returns the default value for this property.
    +
    +
    getDescription() - Method in interface nl.esciencecenter.xenon.AdaptorDescription
    +
    +
    Get the description of the adaptor.
    +
    +
    getDescription() - Method in class nl.esciencecenter.xenon.XenonPropertyDescription
    +
    +
    Returns a human readable description of this property.
    +
    +
    getEnvironment() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Get the environment of the executable.
    +
    +
    getException() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
    +
    +
    Get the exception produced by the Copy or while retrieving the status.
    +
    +
    getException() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
    +
    +
    Get the exception produced by the Job or while retrieving the status.
    +
    +
    getException() - Method in interface nl.esciencecenter.xenon.schedulers.QueueStatus
    +
    +
    Get the exception produced by the queue, or null if hasException() returns false.
    +
    +
    getExecutable() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Get the path to the executable.
    +
    +
    getExecutable() - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
    +
    Returns the executable.
    +
    +
    getExitCode() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
    +
    +
    Get the exit code for the Job.
    +
    +
    getFileName() - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Get the file name or null if the Path is empty.
    +
    +
    getFileNameAsString() - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Get the file name as a String, or null if the Path is empty.
    +
    +
    getFileSystem() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Retrieve the FileSystem used internally by this Scheduler.
    +
    +
    getGroup() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
    +
    +
    Get the group of this file (optional operation).
    +
    +
    getJavaArguments() - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
    +
    Returns the arguments for the main class.
    +
    +
    getJavaClasspath() - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
    +
    Returns the java class path.
    +
    +
    getJavaMain() - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
    +
    Returns the main class of the java application.
    +
    +
    getJavaOptions() - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
    +
    Returns the JVM options.
    +
    +
    getJavaSystemProperties() - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
    +
    Returns the java system properties.
    +
    +
    getJobIdentifier() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
    +
    +
    Get the job identifier of the Job for which this JobStatus was created.
    +
    +
    getJobIdentifier() - Method in interface nl.esciencecenter.xenon.schedulers.Streams
    +
    +
    Get the identifier of the job for which this Streams was created.
    +
    +
    getJobOptions() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Get a copy of the job options of this job.
    +
    +
    getJobs(String...) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Get all job identifier of jobs currently in (one ore more) queues.
    +
    +
    getJobStatus(String) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Get the status of a Job.
    +
    +
    getJobStatuses(String...) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Get the status of all specified jobs.
    +
    +
    getKeytabFile() - Method in class nl.esciencecenter.xenon.credentials.KeytabCredential
    +
     
    +
    getLastAccessTime() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
    +
    +
    Get the last access time for this file.
    +
    +
    getLastModifiedTime() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
    +
    +
    Get the last modified time for this file.
    +
    +
    getLocalFileSystems() - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
    +
    +
    Returns all local FileSystems.
    +
    +
    getLocalRoot(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
    +
    +
    Return the locally valid root element of an String representation of an absolute path.
    +
    +
    getLocalRootlessPath(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
    +
    +
    Return the local root less path of an absolute path.
    +
    +
    getLocalSeparator() - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
    +
    +
    Returns the local file system path separator character.
    +
    +
    getLocation() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Get the location of the FileSystem.
    +
    +
    getLocation() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Get the location that this Scheduler is connected to.
    +
    +
    getMaxMemory() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Get the amount of memory needed for process (in MBytes).
    +
    +
    getMaxRuntime() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Get the maximum job duration 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.AdaptorDescription
    +
    +
    Get the name of the adaptor.
    +
    +
    getName(int) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Get an element of this Path.
    +
    +
    getName() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Get the job name.
    +
    +
    getName() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
    +
    +
    Get the name of the Job for which this JobStatus was created.
    +
    +
    getName() - Method in class nl.esciencecenter.xenon.XenonPropertyDescription
    +
    +
    Returns the name of the property.
    +
    +
    getNameCount() - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Get the number of elements in the Path.
    +
    +
    getNodeCount() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Get the number of nodes.
    +
    +
    getOwner() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
    +
    +
    Get the owner of this file (optional operation).
    +
    +
    getParent() - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Get the parent Path, or null if this Path does not have a parent.
    +
    +
    getPassword() - Method in class nl.esciencecenter.xenon.credentials.PasswordCredential
    +
    +
    Gets the password.
    +
    +
    getPath() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
    +
    +
    Get the path these attributes belong to.
    +
    +
    getPathSeparator() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Get the path separator used by this file system.
    +
    +
    getPermissions() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
    +
    +
    Get the permissions of this file (optional operation).
    +
    +
    getProcessesPerNode() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Get the number of processes to start on each node.
    +
    +
    getProperties() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Get the properties used to create this FileSystem.
    +
    +
    getProperties() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Get the properties used to create this Scheduler.
    +
    +
    getQueueName() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Get the queue name;
    +
    +
    getQueueName() - Method in interface nl.esciencecenter.xenon.schedulers.QueueStatus
    +
    +
    Get the queue name.
    +
    +
    getQueueNames() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Get the queue names supported by this Scheduler.
    +
    +
    getQueueStatus(String) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Get the status of the queue.
    +
    +
    getQueueStatuses(String...) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Get the status of all queues.
    +
    +
    getResult() - Method in class nl.esciencecenter.xenon.utils.OutputReader
    +
    +
    Returns the data that has been read from the InputStream as a byte array.
    +
    +
    getResultAsString() - Method in class nl.esciencecenter.xenon.utils.OutputReader
    +
    +
    Returns the data that has been read from the InputStream as a String.
    +
    +
    getScheduler() - Method in interface nl.esciencecenter.xenon.schedulers.QueueStatus
    +
    +
    Get the Scheduler that produced this QueueStatus.
    +
    +
    getSchedulerArguments() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Get the scheduler specific arguments.
    +
    +
    getSchedulerSpecificInformation() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
    +
    +
    Get scheduler specific information on the Job.
    +
    +
    getSchedulerSpecificInformation() - Method in interface nl.esciencecenter.xenon.schedulers.QueueStatus
    +
    +
    Get scheduler specific information on the queue.
    +
    +
    getSeparator() - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Get the separator.
    +
    +
    getSize() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
    +
    +
    Get the size of this file in bytes.
    +
    +
    getState() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
    +
    +
    Get the state of the Copy operation.
    +
    +
    getState() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
    +
    +
    Get the state of the Job.
    +
    +
    getStatus(String) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Retrieve the status of an copy.
    +
    +
    getStderr() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Gets the path to the file to which the executable must redirect stderr.
    +
    +
    getStderr() - Method in interface nl.esciencecenter.xenon.schedulers.Streams
    +
    +
    Returns the standard error stream of job.
    +
    +
    getStdin() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Gets the path to the file from which the executable must redirect stdin.
    +
    +
    getStdin() - Method in interface nl.esciencecenter.xenon.schedulers.Streams
    +
    +
    Returns the standard input stream of job.
    +
    +
    getStdout() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Gets the path to the file to which the executable must redirect stdout.
    +
    +
    getStdout() - Method in interface nl.esciencecenter.xenon.schedulers.Streams
    +
    +
    Returns the standard output stream of job.
    +
    +
    getSupportedCredentials() - Method in interface nl.esciencecenter.xenon.AdaptorDescription
    +
    +
    Get the supported credential types for this adaptor.
    +
    +
    getSupportedLocations() - Method in interface nl.esciencecenter.xenon.AdaptorDescription
    +
    +
    Get the supported locations for this adaptor.
    +
    +
    getSupportedProperties() - Method in interface nl.esciencecenter.xenon.AdaptorDescription
    +
    +
    Returns an array containing all properties this adaptor supports.
    +
    +
    getThreadsPerProcess() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Get the number of threads needed per process.
    +
    +
    getType() - Method in class nl.esciencecenter.xenon.XenonPropertyDescription
    +
    +
    Returns the type of the property.
    +
    +
    getUsername() - Method in class nl.esciencecenter.xenon.credentials.DefaultCredential
    +
     
    +
    getUsername() - Method in class nl.esciencecenter.xenon.credentials.KeytabCredential
    +
     
    +
    getUsername() - Method in class nl.esciencecenter.xenon.credentials.PasswordCredential
    +
     
    +
    getUsername() - Method in interface nl.esciencecenter.xenon.credentials.UserCredential
    +
    +
    Returns the user name associated with this credential.
    +
    +
    getWorkingDirectory() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Get the current working directory of this file system.
    +
    +
    getWorkingDirectory() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Gets the path of the working directory for the executable.
    +
    +
    + + + +

    H

    +
    +
    hasException() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
    +
    +
    Has the Copy or status retrieval produced a exception ?
    +
    +
    hasException() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
    +
    +
    Has the Job or job retrieval produced a exception ?
    +
    +
    hasException() - Method in interface nl.esciencecenter.xenon.schedulers.QueueStatus
    +
    +
    Did the queue produce an exception ?
    +
    +
    hashCode() - Method in class nl.esciencecenter.xenon.credentials.CertificateCredential
    +
     
    +
    hashCode() - Method in class nl.esciencecenter.xenon.credentials.CredentialMap
    +
     
    +
    hashCode() - Method in class nl.esciencecenter.xenon.credentials.DefaultCredential
    +
     
    +
    hashCode() - Method in class nl.esciencecenter.xenon.credentials.KeytabCredential
    +
     
    +
    hashCode() - Method in class nl.esciencecenter.xenon.credentials.PasswordCredential
    +
     
    +
    hashCode() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
     
    +
    hashCode() - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
     
    +
    hashCode() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
     
    +
    hashCode() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
     
    +
    hashCode() - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
     
    +
    + + + +

    I

    +
    +
    IncompleteJobDescriptionException - Exception in nl.esciencecenter.xenon.schedulers
    +
    +
    Signals that a JobDescription is missing required options.
    +
    +
    IncompleteJobDescriptionException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.schedulers.IncompleteJobDescriptionException
    +
     
    +
    IncompleteJobDescriptionException(String, String) - Constructor for exception nl.esciencecenter.xenon.schedulers.IncompleteJobDescriptionException
    +
     
    +
    InputWriter - Class in nl.esciencecenter.xenon.utils
    +
    +
    A simple input writer that uses a daemon thread to write from an String to an OutputStream.
    +
    +
    InputWriter(String, OutputStream) - Constructor for class nl.esciencecenter.xenon.utils.InputWriter
    +
    +
    Create a new InputWriter that writes content to the destination.
    +
    +
    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.schedulers
    +
    +
    Signals that a JobDescription contains invalid values for certain options.
    +
    +
    InvalidJobDescriptionException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.schedulers.InvalidJobDescriptionException
    +
     
    +
    InvalidJobDescriptionException(String, String) - Constructor for exception nl.esciencecenter.xenon.schedulers.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
    +
     
    +
    InvalidOptionsException - Exception in nl.esciencecenter.xenon.filesystems
    +
    +
    Signals that an invalid combination of OpenOptions have been specified.
    +
    +
    InvalidOptionsException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.InvalidOptionsException
    +
     
    +
    InvalidOptionsException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.InvalidOptionsException
    +
     
    +
    InvalidPathException - Exception in nl.esciencecenter.xenon.filesystems
    +
    +
    Signals that an end-of-file was encountered.
    +
    +
    InvalidPathException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.InvalidPathException
    +
     
    +
    InvalidPathException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.InvalidPathException
    +
     
    +
    InvalidPropertyException - Exception in nl.esciencecenter.xenon
    +
    +
    Signals that a property has a different type than the get method it was retrieved with.
    +
    +
    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.filesystems
    +
    +
    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.filesystems.InvalidResumeTargetException
    +
     
    +
    InvalidResumeTargetException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.InvalidResumeTargetException
    +
     
    +
    isAbsolute() - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
     
    +
    isConnectionless() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
    +
     
    +
    isDirectory() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
    +
    +
    Does the path refer to a directory ?
    +
    +
    isDone() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
    +
    +
    Is the Copy done?
    +
    +
    isDone() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
    +
    +
    Is the Job done.
    +
    +
    isEmbedded() - Method in interface nl.esciencecenter.xenon.schedulers.SchedulerAdaptorDescription
    +
    +
    Is this an embedded scheduler ? + + Embedded schedulers are implemented inside the Xenon process itself.
    +
    +
    isEmpty() - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Is this Path empty ?
    +
    +
    isExecutable() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
    +
    +
    Does the path refer to an executable file ?
    +
    +
    isFinished() - Method in class nl.esciencecenter.xenon.utils.InputWriter
    +
    +
    Poll if the InputWriter has finished writing.
    +
    +
    isFinished() - Method in class nl.esciencecenter.xenon.utils.OutputReader
    +
    +
    Returns if the OutputReader has finished (i.e., has reached the end-of-stream on the input).
    +
    +
    isHidden() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
    +
    +
    Does the path refer to an hidden file ?
    +
    +
    isLinux() - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
    +
    +
    Returns if we are currently running on Linux.
    +
    +
    isLinuxRoot(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
    +
    +
    Check if root only contains a valid Linux root element, which is "/".
    +
    +
    isLocalRoot(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
    +
    +
    Check if root contains a locally valid root element, such as "C:" on Windows or "/" on Linux and OSX.
    +
    +
    isOpen() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Return if the connection to the FileSystem is open.
    +
    +
    isOpen() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Test if the connection of this Scheduler is open.
    +
    +
    isOSX() - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
    +
    +
    Returns if we are currently running on OSX.
    +
    +
    isOSXRoot(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
    +
    +
    Check if root contains a valid OSX root element, which is "/".
    +
    +
    isOther() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
    +
    +
    Is the path not a file, link or directory ?
    +
    +
    isReadable() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
    +
    +
    Does the path refer to an readable file ?
    +
    +
    isRegular() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
    +
    +
    Does the path refer to a regular file ?
    +
    +
    isRunning() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
    +
    +
    Is the Copy still running?
    +
    +
    isRunning() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
    +
    +
    Is the Job running.
    +
    +
    isStartSingleProcess() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Is only a single process started?
    +
    +
    isSymbolicLink() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
    +
    +
    Does the path refer to a symbolic link ?
    +
    +
    isWindows() - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
    +
    +
    Returns if we are currently running on Windows.
    +
    +
    isWindowsRoot(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
    +
    +
    Check if root only contains a valid Windows root element such as "C:".
    +
    +
    isWritable() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
    +
    +
    Does the path refer to a writable file ?
    +
    +
    iterator() - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Create an Iterator that returns all possible sub Paths of this Path, in order of increasing length.
    +
    +
    + + + +

    J

    +
    +
    JavaJobDescription - Class in nl.esciencecenter.xenon.utils
    +
    +
    A JobDescription specialized in Java applications.
    +
    +
    JavaJobDescription() - Constructor for class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
     
    +
    JobDescription - Class in nl.esciencecenter.xenon.schedulers
    +
    +
    JobDescription contains a description of a job that can be submitted to a Scheduler.
    +
    +
    JobDescription() - Constructor for class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Create a JobDescription.
    +
    +
    JobDescription(JobDescription) - Constructor for class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Create a JobDescription by copying an existing one.
    +
    +
    JobStatus - Interface in nl.esciencecenter.xenon.schedulers
    +
    +
    JobStatus contains status information for a specific job.
    +
    +
    + + + +

    K

    +
    +
    keySet() - Method in class nl.esciencecenter.xenon.credentials.CredentialMap
    +
    +
    Returns a Set view of the keys contained in this map.
    +
    +
    KeytabCredential - Class in nl.esciencecenter.xenon.credentials
    +
     
    +
    KeytabCredential(String, String) - Constructor for class nl.esciencecenter.xenon.credentials.KeytabCredential
    +
     
    +
    + + + +

    L

    +
    +
    list(Path, boolean) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    List all entries in the directory dir.
    +
    +
    LocalFileSystemUtils - Class in nl.esciencecenter.xenon.utils
    +
     
    +
    + + + +

    M

    +
    +
    maybeThrowException() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
    +
    +
    Throws the exception that occured during copying, if it exists.
    +
    +
    maybeThrowException() - Method in interface nl.esciencecenter.xenon.schedulers.JobStatus
    +
    +
    Throws the exception produced by the Job or while retrieving the status, if it exists.
    +
    +
    maybeThrowException() - Method in interface nl.esciencecenter.xenon.schedulers.QueueStatus
    +
    +
    Throws the exception produced by the queue if it exists.
    +
    +
    + + + +

    N

    +
    +
    needsSizeBeforehand() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
    +
     
    +
    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.filesystems - package nl.esciencecenter.xenon.filesystems
    +
    +
    This package contains classes and interfaces for manipulating files.
    +
    +
    nl.esciencecenter.xenon.schedulers - package nl.esciencecenter.xenon.schedulers
    +
    +
    This package contains the classes and interfaces used to run jobs.
    +
    +
    nl.esciencecenter.xenon.utils - package nl.esciencecenter.xenon.utils
    +
    +
    This package is contains several utility classes.
    +
    +
    normalize() - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Normalize this Path by removing as many redundant path elements as possible.
    +
    +
    NoSuchCopyException - Exception in nl.esciencecenter.xenon.filesystems
    +
    +
    Signals that a unknown Copy handle was provided.
    +
    +
    NoSuchCopyException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.NoSuchCopyException
    +
     
    +
    NoSuchCopyException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.NoSuchCopyException
    +
     
    +
    NoSuchJobException - Exception in nl.esciencecenter.xenon.schedulers
    +
    +
    Signals that a Job was not found.
    +
    +
    NoSuchJobException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.schedulers.NoSuchJobException
    +
     
    +
    NoSuchJobException(String, String) - Constructor for exception nl.esciencecenter.xenon.schedulers.NoSuchJobException
    +
     
    +
    NoSuchPathException - Exception in nl.esciencecenter.xenon.filesystems
    +
    +
    Signals that a path does not exists.
    +
    +
    NoSuchPathException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.NoSuchPathException
    +
     
    +
    NoSuchPathException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.NoSuchPathException
    +
     
    +
    NoSuchQueueException - Exception in nl.esciencecenter.xenon.schedulers
    +
    +
    Signals that a unknown queue was provided.
    +
    +
    NoSuchQueueException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.schedulers.NoSuchQueueException
    +
     
    +
    NoSuchQueueException(String, String) - Constructor for exception nl.esciencecenter.xenon.schedulers.NoSuchQueueException
    +
     
    +
    + + + +

    O

    +
    +
    OutputReader - Class in nl.esciencecenter.xenon.utils
    +
    +
    A simple output reader that uses a daemon thread to read from an InputStream and buffer this data.
    +
    +
    OutputReader(InputStream) - Constructor for class nl.esciencecenter.xenon.utils.OutputReader
    +
    +
    Create an OutputReader that reads from source.
    +
    +
    + + + +

    P

    +
    +
    PasswordCredential - Class in nl.esciencecenter.xenon.credentials
    +
    +
    A Credential consisting of a username + password combination.
    +
    +
    PasswordCredential(String, String) - Constructor for class nl.esciencecenter.xenon.credentials.PasswordCredential
    +
    +
    Create a new PasswordCredential using a String as password.
    +
    +
    PasswordCredential(String, char[]) - Constructor for class nl.esciencecenter.xenon.credentials.PasswordCredential
    +
    +
    Create a new PasswordCredential using a char array as password.
    +
    +
    Path - Class in nl.esciencecenter.xenon.filesystems
    +
    +
    Path contains a sequence of path elements separated by a separator.
    +
    +
    Path() - Constructor for class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Create a new empty Path using the default separator.
    +
    +
    Path(String) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Create a new Path by parsing path using the default separator.
    +
    +
    Path(char, String) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Create a new Path by parsing path using the provided separator.
    +
    +
    Path(boolean, String...) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Create a new Path using the given path elements and the default separator.
    +
    +
    Path(char, boolean, String...) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Create a new Path using the given path elements and the provided separator.
    +
    +
    Path(boolean, List<String>) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Create a new Path using the given path elements and the default separator.
    +
    +
    Path(char, boolean, List<String>) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Create a new Path using the given path separator, absoluteness, and elements.
    +
    +
    PathAlreadyExistsException - Exception in nl.esciencecenter.xenon.filesystems
    +
    +
    Signals that a path already exists.
    +
    +
    PathAlreadyExistsException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.PathAlreadyExistsException
    +
     
    +
    PathAlreadyExistsException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.PathAlreadyExistsException
    +
     
    +
    PathAttributes - Interface in nl.esciencecenter.xenon.filesystems
    +
    +
    FileAttributes represents a set of attributes of a path.
    +
    +
    PosixFilePermission - Enum in nl.esciencecenter.xenon.filesystems
    +
    +
    PosixFilePermission is an enumeration containing all supported Posix file permissions.
    +
    +
    PropertyTypeException - Exception in nl.esciencecenter.xenon
    +
    +
    Signals that a property has a different type than the get method it was retrieved with.
    +
    +
    PropertyTypeException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.PropertyTypeException
    +
     
    +
    PropertyTypeException(String, String) - Constructor for exception nl.esciencecenter.xenon.PropertyTypeException
    +
     
    +
    put(String, UserCredential) - Method in class nl.esciencecenter.xenon.credentials.CredentialMap
    +
    +
    Add a Credential to the CredentialMap using key as a unique key.
    +
    +
    + + + +

    Q

    +
    +
    QueueStatus - Interface in nl.esciencecenter.xenon.schedulers
    +
    +
    QueueStatus contains status information for a specific queue.
    +
    +
    + + + +

    R

    +
    +
    readFromFile(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Open an existing file and return an InputStream to read from this file.
    +
    +
    readSymbolicLink(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Reads the target of a symbolic link (optional operation).
    +
    +
    relativize(Path) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Create a relative Path between the given Path and this Path.
    +
    +
    rename(Path, Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Rename an existing source path to a non-existing target path (optional operation).
    +
    +
    resolve(Path) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Resolve a Path against this Path.
    +
    +
    resolve(String) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Resolve a Path represented as a String against this path.
    +
    +
    resolveSibling(Path) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Resolves the given Path to this paths parent Path, thereby creating a sibling to this Path.
    +
    +
    run() - Method in class nl.esciencecenter.xenon.utils.InputWriter
    +
    +
    Entry point for the Daemon thread.
    +
    +
    run() - Method in class nl.esciencecenter.xenon.utils.OutputReader
    +
    +
    Entry method for daemon thread.
    +
    +
    run() - Method in class nl.esciencecenter.xenon.utils.StreamForwarder
    +
    +
    Main entry method for the daemon thread.
    +
    +
    + + + +

    S

    +
    +
    Scheduler - Class in nl.esciencecenter.xenon.schedulers
    +
    +
    Scheduler represents a (possibly remote) scheduler that can be used to submit jobs and retrieve queue information.
    +
    +
    SchedulerAdaptorDescription - Interface in nl.esciencecenter.xenon.schedulers
    +
     
    +
    setArguments(String...) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Sets the command line arguments of the executable.
    +
    +
    setArguments(String...) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
    +
    This method should not be used.
    +
    +
    setEnvironment(Map<String, String>) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Sets the environment of the executable.
    +
    +
    setExecutable(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Sets the path to the executable.
    +
    +
    setJavaArguments(String...) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
    +
    Sets the arguments of the java main class.
    +
    +
    setJavaClasspath(String...) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
    +
    Sets the java class path.
    +
    +
    setJavaMain(String) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
    +
    Sets the main class.
    +
    +
    setJavaOptions(String...) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
    +
    Sets the JVM options.
    +
    +
    setJavaSystemProperties(Map<String, String>) - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
    +
    Sets the system properties.
    +
    +
    setJobOptions(Map<String, String>) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Sets the job options of the job.
    +
    +
    setMaxMemory(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Set the amount of memory needed for process (in MBytes).
    +
    +
    setMaxRuntime(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Set the maximum job duration in minutes.
    +
    +
    setName(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Set the name of the job.
    +
    +
    setNodeCount(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Set the number of nodes.
    +
    +
    setPosixFilePermissions(Path, Set<PosixFilePermission>) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Sets the POSIX permissions of a path (optional operation).
    +
    +
    setProcessesPerNode(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Set the number of processes started on each node.
    +
    +
    setQueueName(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Set the queue name;
    +
    +
    setSchedulerArguments(String...) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Sets the scheduler specific arguments for this job.
    +
    +
    setStartSingleProcess(boolean) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Set if only a single process is started, instead of nodeCount * processesPerNode.
    +
    +
    setStderr(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Sets the path to the file to which the executable must redirect stderr.
    +
    +
    setStdin(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Sets the path to the file from which the executable must redirect stdin.
    +
    +
    setStdout(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Sets the path to the file to which the executable must redirect stdout.
    +
    +
    setThreadsPerProcess(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Set the number of threads needed per process.
    +
    +
    setWorkingDirectory(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Set the current working directory of this file system to directory.
    +
    +
    setWorkingDirectory(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Sets the path of the working directory for the executable.
    +
    +
    startsWith(Path) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Tests if this Path starts with the given Path.
    +
    +
    startsWith(String) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Tests if this Path starts with the given Path represented as a String.
    +
    +
    startsWithLinuxRoot(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
    +
    +
    Checks if the provide path starts with a valid Linux root, that is "/".
    +
    +
    startWithRoot(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
    +
    +
    Checks if the provide path starts with a valid root, such as "/" or "C:".
    +
    +
    startWithWindowsRoot(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
    +
    +
    Checks if the provide path starts with a valid Windows root, for example "C:".
    +
    +
    StreamForwarder - Class in nl.esciencecenter.xenon.utils
    +
    +
    A simple stream forwarder that uses a daemon thread to read from an InputStream and write it to a OutputStream.
    +
    +
    StreamForwarder(String, InputStream, OutputStream, int) - Constructor for class nl.esciencecenter.xenon.utils.StreamForwarder
    +
    +
    Create a new StreamForwarder and start it immediately.
    +
    +
    StreamForwarder(InputStream, OutputStream) - Constructor for class nl.esciencecenter.xenon.utils.StreamForwarder
    +
    +
    Create a new StreamForwarder and start it immediately.
    +
    +
    Streams - Interface in nl.esciencecenter.xenon.schedulers
    +
    +
    Streams is a container for the standard input, output and error streams of a job.
    +
    +
    submitBatchJob(JobDescription) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Submit a batch job.
    +
    +
    submitInteractiveJob(JobDescription) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Submit an interactive job (optional operation).
    +
    +
    subpath(int, int) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Returns a Path that is a subsequence of the name elements of this path.
    +
    +
    supportsBatch() - Method in interface nl.esciencecenter.xenon.schedulers.SchedulerAdaptorDescription
    +
    +
    Does this Scheduler support the submission of batch jobs ? + + For batch jobs the standard streams of the jobs are redirected from and to files.
    +
    +
    supportsInteractive() - Method in interface nl.esciencecenter.xenon.schedulers.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.
    +
    +
    supportsReadingPosixPermissions() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
    +
     
    +
    supportsRename() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
    +
     
    +
    supportsSettingPosixPermissions() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
    +
     
    +
    supportsThirdPartyCopy() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
    +
    +
    Does this adaptor support third party copy ? + + In third party copy, a file is copied between two remote locations, without passing through the local machine first.
    +
    +
    + + + +

    T

    +
    +
    terminate(long) - Method in class nl.esciencecenter.xenon.utils.StreamForwarder
    +
    +
    Wait for a given timeout for the StreamForwarder to terminate by reading an end-of-stream on the input.
    +
    +
    toAbsolutePath() - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
     
    +
    toRelativePath() - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
     
    +
    toString() - Method in class nl.esciencecenter.xenon.credentials.CertificateCredential
    +
     
    +
    toString() - Method in class nl.esciencecenter.xenon.credentials.PasswordCredential
    +
     
    +
    toString() - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
     
    +
    toString() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
     
    +
    toString() - Method in class nl.esciencecenter.xenon.utils.JavaJobDescription
    +
     
    +
    toString() - Method in class nl.esciencecenter.xenon.XenonPropertyDescription
    +
     
    +
    + + + +

    U

    +
    +
    UnknownAdaptorException - Exception in nl.esciencecenter.xenon
    +
    +
    Thrown when an unknown adaptor name is provided.
    +
    +
    UnknownAdaptorException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.UnknownAdaptorException
    +
     
    +
    UnknownAdaptorException(String, String) - Constructor for exception nl.esciencecenter.xenon.UnknownAdaptorException
    +
     
    +
    UnknownPropertyException - Exception in nl.esciencecenter.xenon
    +
    +
    Signals that a property has a different type than the get method it was retrieved with.
    +
    +
    UnknownPropertyException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.UnknownPropertyException
    +
     
    +
    UnknownPropertyException(String, String) - Constructor for exception nl.esciencecenter.xenon.UnknownPropertyException
    +
     
    +
    UnsupportedJobDescriptionException - Exception in nl.esciencecenter.xenon.schedulers
    +
    +
    Signals that a combination of options used in a JobDescription is not supported by a resource.
    +
    +
    UnsupportedJobDescriptionException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.schedulers.UnsupportedJobDescriptionException
    +
     
    +
    UnsupportedJobDescriptionException(String, String) - Constructor for exception nl.esciencecenter.xenon.schedulers.UnsupportedJobDescriptionException
    +
     
    +
    UnsupportedOperationException - Exception in nl.esciencecenter.xenon
    +
    +
    Throw when an unsupported optional operation is called.
    +
    +
    UnsupportedOperationException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.UnsupportedOperationException
    +
     
    +
    UnsupportedOperationException(String, String) - Constructor for exception nl.esciencecenter.xenon.UnsupportedOperationException
    +
     
    +
    UserCredential - Interface in nl.esciencecenter.xenon.credentials
    +
     
    +
    usesFileSystem() - Method in interface nl.esciencecenter.xenon.schedulers.SchedulerAdaptorDescription
    +
    +
    Does this Scheduler create a FileSystem to support the submission of jobs ? + + Many scheduler implementations use a FileSystem internally to handle job submission, for example to store submission scripts or handle the standard I/O + streams of a process.
    +
    +
    + + + +

    V

    +
    +
    valueOf(String) - Static method in enum nl.esciencecenter.xenon.filesystems.CopyMode
    +
    +
    Returns the enum constant of this type with the specified name.
    +
    +
    valueOf(String) - Static method in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
    +
    +
    Returns the enum constant of this type with the specified name.
    +
    +
    valueOf(String) - Static method in enum nl.esciencecenter.xenon.XenonPropertyDescription.Type
    +
    +
    Returns the enum constant of this type with the specified name.
    +
    +
    values() - Static method in enum nl.esciencecenter.xenon.filesystems.CopyMode
    +
    +
    Returns an array containing the constants of this enum type, in +the order they are declared.
    +
    +
    values() - Static method in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
    +
    +
    Returns an array containing the constants of this enum type, in +the order they are declared.
    +
    +
    values() - Static method in enum nl.esciencecenter.xenon.XenonPropertyDescription.Type
    +
    +
    Returns an array containing the constants of this enum type, in +the order they are declared.
    +
    +
    + + + +

    W

    +
    +
    waitUntilDone(String, long) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Wait until a copy operation is done or until a timeout expires.
    +
    +
    waitUntilDone(String, long) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Wait until a job is done or until a timeout expires.
    +
    +
    waitUntilFinished() - Method in class nl.esciencecenter.xenon.utils.InputWriter
    +
    +
    Wait until the InputWriter has finished writing.
    +
    +
    waitUntilFinished() - Method in class nl.esciencecenter.xenon.utils.OutputReader
    +
    +
    Waits until the OutputReader has finished (i.e., has reached the end-of-stream on the input).
    +
    +
    waitUntilRunning(String, long) - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Wait until a job starts running, or until a timeout expires.
    +
    +
    writeToFile(Path, long) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Open a file and return an OutputStream to write to this file.
    +
    +
    writeToFile(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Open a file and return an OutputStream to write to this file.
    +
    +
    + + + +

    X

    +
    +
    XenonException - Exception in nl.esciencecenter.xenon
    +
    +
    XenonException is the parent exception for all exceptions raised in Xenon.
    +
    +
    XenonException(String, String) - Constructor for exception nl.esciencecenter.xenon.XenonException
    +
     
    +
    XenonException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.XenonException
    +
     
    +
    XenonPropertyDescription - Class in nl.esciencecenter.xenon
    +
    +
    XenonPropertyDescription contains all necessary information about a property that is recognized by Xenon
    +
    +
    XenonPropertyDescription(String, XenonPropertyDescription.Type, String, String) - Constructor for class nl.esciencecenter.xenon.XenonPropertyDescription
    +
     
    +
    XenonPropertyDescription.Type - Enum in nl.esciencecenter.xenon
    +
    +
    This Type enumeration lists all possible types of properties recognized by Xenon.
    +
    +
    XenonRuntimeException - Exception in nl.esciencecenter.xenon
    +
    +
    XenonRuntimeException is the parent for all runtime exceptions raised in Xenon.
    +
    +
    XenonRuntimeException(String, String) - Constructor for exception nl.esciencecenter.xenon.XenonRuntimeException
    +
     
    +
    XenonRuntimeException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.XenonRuntimeException
    +
     
    +
    +A B C D E F G H I J K L M N O P Q R S T U V W X 
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/index.html b/docs/versions/2.6.1/javadoc/index.html new file mode 100644 index 000000000..286b35d4a --- /dev/null +++ b/docs/versions/2.6.1/javadoc/index.html @@ -0,0 +1,74 @@ + + + + + +xenon-2.3.0 2.6.1 API + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/AdaptorDescription.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/AdaptorDescription.html new file mode 100644 index 000000000..32afa2036 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/AdaptorDescription.html @@ -0,0 +1,310 @@ + + + + + +AdaptorDescription (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon
    +

    Interface AdaptorDescription

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          java.lang.String getName()
          +
          Get the name of the adaptor.
          +
          +
          Returns:
          +
          the name of the adaptor.
          +
          +
          • +
        + + + +
          +
        • +

          getDescription

          +
          java.lang.String getDescription()
          +
          Get the description of the adaptor.
          +
          +
          Returns:
          +
          the description of the adaptor.
          +
          +
          • +
        + + + +
          +
        • +

          getSupportedLocations

          +
          java.lang.String[] getSupportedLocations()
          +
          Get the supported locations for this adaptor.
          +
          +
          Returns:
          +
          the locations supported by this adaptor.
          +
          +
          • +
        + + + +
          +
        • +

          getSupportedCredentials

          +
          java.lang.Class[] getSupportedCredentials()
          +
          Get the supported credential types for this adaptor.
          +
          +
          Returns:
          +
          the credential types supported by this adaptor.
          +
          +
          • +
        + + + +
          +
        • +

          getSupportedProperties

          +
          XenonPropertyDescription[] getSupportedProperties()
          +
          Returns an array containing all properties this adaptor supports.
          +
          +
          Returns:
          +
          an array containing all properties this adaptor supports.
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/InvalidCredentialException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/InvalidCredentialException.html new file mode 100644 index 000000000..8ad97b700 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/InvalidCredentialException.html @@ -0,0 +1,292 @@ + + + + + +InvalidCredentialException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon
    +

    Class InvalidCredentialException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class InvalidCredentialException
+extends XenonException
      +
      Signals that an invalid credential was used to access a resource.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        InvalidCredentialException(java.lang.String adaptorName, + java.lang.String message) 
        InvalidCredentialException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InvalidCredentialException

          +
          public InvalidCredentialException(java.lang.String adaptorName,
+                                  java.lang.String message,
+                                  java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          InvalidCredentialException

          +
          public InvalidCredentialException(java.lang.String adaptorName,
+                                  java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/InvalidLocationException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/InvalidLocationException.html new file mode 100644 index 000000000..76fe6e840 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/InvalidLocationException.html @@ -0,0 +1,292 @@ + + + + + +InvalidLocationException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon
    +

    Class InvalidLocationException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class InvalidLocationException
+extends XenonException
      +
      Signals that an invalid location was provided.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        InvalidLocationException(java.lang.String adaptorName, + java.lang.String message) 
        InvalidLocationException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InvalidLocationException

          +
          public InvalidLocationException(java.lang.String adaptorName,
+                                java.lang.String message,
+                                java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          InvalidLocationException

          +
          public InvalidLocationException(java.lang.String adaptorName,
+                                java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/InvalidPropertyException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/InvalidPropertyException.html new file mode 100644 index 000000000..7653d206b --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/InvalidPropertyException.html @@ -0,0 +1,292 @@ + + + + + +InvalidPropertyException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon
    +

    Class InvalidPropertyException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class InvalidPropertyException
+extends XenonException
      +
      Signals that a property has a different type than the get method it was retrieved with.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        InvalidPropertyException(java.lang.String adaptorName, + java.lang.String message) 
        InvalidPropertyException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InvalidPropertyException

          +
          public InvalidPropertyException(java.lang.String adaptorName,
+                                java.lang.String message,
+                                java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          InvalidPropertyException

          +
          public InvalidPropertyException(java.lang.String adaptorName,
+                                java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/PropertyTypeException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/PropertyTypeException.html new file mode 100644 index 000000000..2389e7821 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/PropertyTypeException.html @@ -0,0 +1,292 @@ + + + + + +PropertyTypeException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon
    +

    Class PropertyTypeException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class PropertyTypeException
+extends XenonException
      +
      Signals that a property has a different type than the get method it was retrieved with.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        PropertyTypeException(java.lang.String adaptorName, + java.lang.String message) 
        PropertyTypeException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PropertyTypeException

          +
          public PropertyTypeException(java.lang.String adaptorName,
+                             java.lang.String message,
+                             java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          PropertyTypeException

          +
          public PropertyTypeException(java.lang.String adaptorName,
+                             java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/UnknownAdaptorException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/UnknownAdaptorException.html new file mode 100644 index 000000000..8d0a35717 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/UnknownAdaptorException.html @@ -0,0 +1,290 @@ + + + + + +UnknownAdaptorException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon
    +

    Class UnknownAdaptorException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class UnknownAdaptorException
+extends XenonException
      +
      Thrown when an unknown adaptor name is provided.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        UnknownAdaptorException(java.lang.String adaptorName, + java.lang.String message) 
        UnknownAdaptorException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnknownAdaptorException

          +
          public UnknownAdaptorException(java.lang.String adaptorName,
+                               java.lang.String message,
+                               java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          UnknownAdaptorException

          +
          public UnknownAdaptorException(java.lang.String adaptorName,
+                               java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/UnknownPropertyException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/UnknownPropertyException.html new file mode 100644 index 000000000..f17090439 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/UnknownPropertyException.html @@ -0,0 +1,292 @@ + + + + + +UnknownPropertyException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon
    +

    Class UnknownPropertyException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class UnknownPropertyException
+extends XenonException
      +
      Signals that a property has a different type than the get method it was retrieved with.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        UnknownPropertyException(java.lang.String adaptorName, + java.lang.String message) 
        UnknownPropertyException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnknownPropertyException

          +
          public UnknownPropertyException(java.lang.String adaptorName,
+                                java.lang.String message,
+                                java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          UnknownPropertyException

          +
          public UnknownPropertyException(java.lang.String adaptorName,
+                                java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/UnsupportedOperationException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/UnsupportedOperationException.html new file mode 100644 index 000000000..adcb9db2f --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/UnsupportedOperationException.html @@ -0,0 +1,290 @@ + + + + + +UnsupportedOperationException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon
    +

    Class UnsupportedOperationException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class UnsupportedOperationException
+extends XenonException
      +
      Throw when an unsupported optional operation is called.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnsupportedOperationException

          +
          public UnsupportedOperationException(java.lang.String adaptorName,
+                                     java.lang.String message,
+                                     java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          UnsupportedOperationException

          +
          public UnsupportedOperationException(java.lang.String adaptorName,
+                                     java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/XenonException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/XenonException.html new file mode 100644 index 000000000..3450fe20c --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/XenonException.html @@ -0,0 +1,324 @@ + + + + + +XenonException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + +
    +
    nl.esciencecenter.xenon
    +

    Class XenonException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • nl.esciencecenter.xenon.XenonException
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        XenonException(java.lang.String adaptorName, + java.lang.String message) 
        XenonException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        java.lang.StringgetMessage() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XenonException

          +
          public XenonException(java.lang.String adaptorName,
+                      java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          XenonException

          +
          public XenonException(java.lang.String adaptorName,
+                      java.lang.String message,
+                      java.lang.Throwable t)
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getMessage

          +
          public java.lang.String getMessage()
          +
          +
          Overrides:
          +
          getMessage in class java.lang.Throwable
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/XenonPropertyDescription.Type.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/XenonPropertyDescription.Type.html new file mode 100644 index 000000000..bbc08765b --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/XenonPropertyDescription.Type.html @@ -0,0 +1,435 @@ + + + + + +XenonPropertyDescription.Type (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    nl.esciencecenter.xenon
    +

    Enum XenonPropertyDescription.Type

    +
    +
    + +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum Constant and Description
        BOOLEAN +
        Properties of type BOOLEAN can be either "true" or "false".
        +
        DOUBLE +
        Properties of type DOUBLE can be converted into a 64-bit floating point number using + Double.valueOf(String).
        +
        INTEGER +
        Properties of type INTEGER can be converted into a 32-bit signed integer using + Integer.valueOf(String).
        +
        LONG +
        Properties of type LONG can be converted into a 64-bit signed long using + Long.valueOf(String).
        +
        NATURAL +
        Properties of type NATURAL may contain only positive values, including 0.
        +
        SIZE +
        Properties of type SIZE can be converted into a 64-bit signed long using + Long.valueOf(String).
        +
        STRING +
        Properties of type STRING are directly stored in a String without conversion.
        +
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethod and Description
        static XenonPropertyDescription.TypevalueOf(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static XenonPropertyDescription.Type[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Enum Constant Detail

        + + + + + + + +
          +
        • +

          INTEGER

          +
          public static final XenonPropertyDescription.Type INTEGER
          +
          Properties of type INTEGER can be converted into a 32-bit signed integer using + Integer.valueOf(String).
          +
          • +
        + + + +
          +
        • +

          LONG

          +
          public static final XenonPropertyDescription.Type LONG
          +
          Properties of type LONG can be converted into a 64-bit signed long using + Long.valueOf(String).
          +
          • +
        + + + +
          +
        • +

          NATURAL

          +
          public static final XenonPropertyDescription.Type NATURAL
          +
          Properties of type NATURAL may contain only positive values, including 0. + They will be converted into a 64-bit signed long using Long.valueOf(String).
          +
          • +
        + + + +
          +
        • +

          DOUBLE

          +
          public static final XenonPropertyDescription.Type DOUBLE
          +
          Properties of type DOUBLE can be converted into a 64-bit floating point number using + Double.valueOf(String).
          +
          • +
        + + + +
          +
        • +

          STRING

          +
          public static final XenonPropertyDescription.Type STRING
          +
          Properties of type STRING are directly stored in a String without conversion.
          +
          • +
        + + + +
          +
        • +

          SIZE

          +
          public static final XenonPropertyDescription.Type SIZE
          +
          Properties of type SIZE can be converted into a 64-bit signed long using + Long.valueOf(String). In addition, the postfixes "K", "M" and "G" may + be used to multiply the value by 1024, 1024*1024, or 1024*1024*1024 + respectively.
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static XenonPropertyDescription.Type[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (XenonPropertyDescription.Type c : XenonPropertyDescription.Type.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static XenonPropertyDescription.Type valueOf(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/XenonPropertyDescription.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/XenonPropertyDescription.html new file mode 100644 index 000000000..437d29f3e --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/XenonPropertyDescription.html @@ -0,0 +1,407 @@ + + + + + +XenonPropertyDescription (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    nl.esciencecenter.xenon
    +

    Class XenonPropertyDescription

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • nl.esciencecenter.xenon.XenonPropertyDescription
        • +
      +
      • +
    +
    +
      +
    • +
      +
      +
      public class XenonPropertyDescription
+extends java.lang.Object
      +

      XenonPropertyDescription contains all necessary information about a property that is recognized by Xenon

      + +

      Each XenonPropertyDescription contains the following information:

      + +
        +
      • + A name that uniquely identifies the property. + This name should be used as a key when passing properties to Xenon in a Map. +
        • + +
      • + A (human-readable) description that explains the use of the property. +
        • +
      • + + The type of values that are accepted for the property (one of the XenonPropertyDescription.Type enum). + Even though it is customary to pass the values of properties as Strings, the user should ensure the values can be + converted into the expected type. +
        • + +
      • + The default value of the property. +
        • +
      +
      +
      Since:
      +
      1.0
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClass and Description
        static class XenonPropertyDescription.Type +
        This Type enumeration lists all possible types of properties recognized by Xenon.
        +
        +
        • +
      + + + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        java.lang.StringgetDefaultValue() +
        Returns the default value for this property.
        +
        java.lang.StringgetDescription() +
        Returns a human readable description of this property.
        +
        java.lang.StringgetName() +
        Returns the name of the property.
        +
        XenonPropertyDescription.TypegetType() +
        Returns the type of the property.
        +
        java.lang.StringtoString() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XenonPropertyDescription

          +
          public XenonPropertyDescription(java.lang.String name,
+                                XenonPropertyDescription.Type type,
+                                java.lang.String defaultValue,
+                                java.lang.String description)
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Returns the name of the property.
          +
          +
          Returns:
          +
          the name of the property.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getDefaultValue

          +
          public java.lang.String getDefaultValue()
          +
          Returns the default value for this property.
          +
          +
          Returns:
          +
          the default value for this property or null is no default is set.
          +
          +
          • +
        + + + +
          +
        • +

          getDescription

          +
          public java.lang.String getDescription()
          +
          Returns a human readable description of this property.
          +
          +
          Returns:
          +
          a human readable description of this property.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/XenonRuntimeException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/XenonRuntimeException.html new file mode 100644 index 000000000..af4a4fdcd --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/XenonRuntimeException.html @@ -0,0 +1,325 @@ + + + + + +XenonRuntimeException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + +
    +
    nl.esciencecenter.xenon
    +

    Class XenonRuntimeException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • nl.esciencecenter.xenon.XenonRuntimeException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class XenonRuntimeException
+extends java.lang.RuntimeException
      +
      XenonRuntimeException is the parent for all runtime exceptions raised in Xenon. + + Next to the regular exception message and cause, XenonRuntimeException add a source adaptor name to all runtime exceptions.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        XenonRuntimeException(java.lang.String adaptorName, + java.lang.String message) 
        XenonRuntimeException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        java.lang.StringgetMessage() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XenonRuntimeException

          +
          public XenonRuntimeException(java.lang.String adaptorName,
+                             java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          XenonRuntimeException

          +
          public XenonRuntimeException(java.lang.String adaptorName,
+                             java.lang.String message,
+                             java.lang.Throwable t)
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getMessage

          +
          public java.lang.String getMessage()
          +
          +
          Overrides:
          +
          getMessage in class java.lang.Throwable
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/CertificateCredential.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/CertificateCredential.html new file mode 100644 index 000000000..daab480ba --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/CertificateCredential.html @@ -0,0 +1,356 @@ + + + + + +CertificateCredential (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.credentials
    +

    Class CertificateCredential

    +
    +
    + +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        CertificateCredential(java.lang.String username, + java.lang.String certfile, + char[] passphrase) +
        Constructs a CertificateCredential out of a username, a certificate file containing a private key, and an optional passphrase.
        +
        +
        • +
      + + +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CertificateCredential

          +
          public CertificateCredential(java.lang.String username,
+                             java.lang.String certfile,
+                             char[] passphrase)
          +
          Constructs a CertificateCredential out of a username, a certificate file containing a private key, and an optional passphrase.
          +
          +
          Parameters:
          +
          username - the username for this certificate
          +
          certfile - the certification file
          +
          passphrase - the optional passphrase needed to decrypt for this certificate
          +
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getCertificateFile

          +
          public java.lang.String getCertificateFile()
          +
          Returns the certificate file.
          +
          +
          Returns:
          +
          the certificate file.
          +
          +
          • +
        + + + + + + + + + + + + +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/Credential.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/Credential.html new file mode 100644 index 000000000..935d106ce --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/Credential.html @@ -0,0 +1,173 @@ + + + + + +Credential (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.credentials
    +

    Interface Credential

    +
    +
    +
    + +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/CredentialMap.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/CredentialMap.html new file mode 100644 index 000000000..e03eaefb9 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/CredentialMap.html @@ -0,0 +1,433 @@ + + + + + +CredentialMap (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.credentials
    +

    Class CredentialMap

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • nl.esciencecenter.xenon.credentials.CredentialMap
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Credential
      +
      +
      +
      +
      public class CredentialMap
+extends java.lang.Object
+implements Credential
      +
      A Credential consisting of a collection of Credentials each uniquely identified by a String (typically a host name or host alias). + + A default Credential can be set that will be returned if by get if a key is not found.
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        CredentialMap() +
        Create a new CredentialMap using null as the default credential.
        +
        CredentialMap(UserCredential defaultCredential) +
        Creates a new CredentialMap and set the default credential to defaultCredential.
        +
        +
        • +
      + + +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CredentialMap

          +
          public CredentialMap()
          +
          Create a new CredentialMap using null as the default credential.
          +
          • +
        + + + +
          +
        • +

          CredentialMap

          +
          public CredentialMap(UserCredential defaultCredential)
          +
          Creates a new CredentialMap and set the default credential to defaultCredential.
          +
          +
          Parameters:
          +
          defaultCredential - the default credential to return by get if a key is not found.
          +
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          put

          +
          public UserCredential put(java.lang.String key,
+                          UserCredential credential)
          +
          Add a Credential to the CredentialMap using key as a unique key. + + If the key already exists in the CredentialMap, the stored UserCredential will be replaced by credential.
          +
          +
          Parameters:
          +
          key - the unique key used to store the credential.
          +
          credential - the UserCredential to store.
          +
          Returns:
          +
          the UserCredential previously stored using the key or null if the key was not used before.
          +
          +
          • +
        + + + +
          +
        • +

          containsCredential

          +
          public boolean containsCredential(java.lang.String key)
          +
          Check if the key is stored in this CredentialMap.
          +
          +
          Parameters:
          +
          key - the key to check.
          +
          Returns:
          +
          if key is stored in this CredentialMap
          +
          +
          • +
        + + + +
          +
        • +

          get

          +
          public UserCredential get(java.lang.String key)
          +
          Retrieve the UserCredential stored using the key. + + If the key is not found in the map, the default credential is returned (if provided when the CredentialMap was created) or null if no + default is set.
          +
          +
          Parameters:
          +
          key - the key of the UserCredential to retrieve.
          +
          Returns:
          +
          the UserCredential stored using key or the default credential if the key is not found.
          +
          +
          • +
        + + + +
          +
        • +

          keySet

          +
          public java.util.Set<java.lang.String> keySet()
          +
          Returns a Set view of the keys contained in this map.
          +
          +
          Returns:
          +
          a set view of the keys contained in this map
          +
          +
          • +
        + + + +
          +
        • +

          getDefault

          +
          public UserCredential getDefault()
          +
          Returns the default UserCredential.
          +
          +
          Returns:
          +
          the default credential to return by get if a key is not found.
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/DefaultCredential.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/DefaultCredential.html new file mode 100644 index 000000000..bb2d18630 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/DefaultCredential.html @@ -0,0 +1,332 @@ + + + + + +DefaultCredential (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.credentials
    +

    Class DefaultCredential

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • nl.esciencecenter.xenon.credentials.DefaultCredential
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Credential, UserCredential
      +
      +
      +
      +
      public class DefaultCredential
+extends java.lang.Object
+implements UserCredential
      +
      This class represents the default credential that may be used by the various adaptors. + + It mainly serves as a placeholder to indicate that the adaptor must revert to whatever default behavior it defines.
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        booleanequals(java.lang.Object o) 
        java.lang.StringgetUsername() +
        Returns the user name associated with this credential.
        +
        inthashCode() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DefaultCredential

          +
          public DefaultCredential()
          +
          • +
        + + + +
          +
        • +

          DefaultCredential

          +
          public DefaultCredential(java.lang.String username)
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getUsername

          +
          public java.lang.String getUsername()
          +
          Description copied from interface: UserCredential
          +
          Returns the user name associated with this credential.
          +
          +
          Specified by:
          +
          getUsername in interface UserCredential
          +
          Returns:
          +
          the user name associated with this credential.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/KeytabCredential.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/KeytabCredential.html new file mode 100644 index 000000000..0b92526bd --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/KeytabCredential.html @@ -0,0 +1,332 @@ + + + + + +KeytabCredential (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.credentials
    +

    Class KeytabCredential

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • nl.esciencecenter.xenon.credentials.KeytabCredential
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        KeytabCredential(java.lang.String username, + java.lang.String keytabFile) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        booleanequals(java.lang.Object o) 
        java.lang.StringgetKeytabFile() 
        java.lang.StringgetUsername() +
        Returns the user name associated with this credential.
        +
        inthashCode() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          KeytabCredential

          +
          public KeytabCredential(java.lang.String username,
+                        java.lang.String keytabFile)
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getUsername

          +
          public java.lang.String getUsername()
          +
          Description copied from interface: UserCredential
          +
          Returns the user name associated with this credential.
          +
          +
          Specified by:
          +
          getUsername in interface UserCredential
          +
          Returns:
          +
          the user name associated with this credential.
          +
          +
          • +
        + + + +
          +
        • +

          getKeytabFile

          +
          public java.lang.String getKeytabFile()
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/PasswordCredential.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/PasswordCredential.html new file mode 100644 index 000000000..4dc883dec --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/PasswordCredential.html @@ -0,0 +1,393 @@ + + + + + +PasswordCredential (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.credentials
    +

    Class PasswordCredential

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • nl.esciencecenter.xenon.credentials.PasswordCredential
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        PasswordCredential(java.lang.String username, + char[] password) +
        Create a new PasswordCredential using a char array as password.
        +
        PasswordCredential(java.lang.String username, + java.lang.String password) +
        Create a new PasswordCredential using a String as password.
        +
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        booleanequals(java.lang.Object o) 
        char[]getPassword() +
        Gets the password.
        +
        java.lang.StringgetUsername() +
        Returns the user name associated with this credential.
        +
        inthashCode() 
        java.lang.StringtoString() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PasswordCredential

          +
          public PasswordCredential(java.lang.String username,
+                          java.lang.String password)
          +
          Create a new PasswordCredential using a String as password. + + This String will immediately be converted into a char array internally.
          +
          +
          Parameters:
          +
          username - the user name of the credential.
          +
          password - the password of the credential.
          +
          +
          • +
        + + + +
          +
        • +

          PasswordCredential

          +
          public PasswordCredential(java.lang.String username,
+                          char[] password)
          +
          Create a new PasswordCredential using a char array as password.
          +
          +
          Parameters:
          +
          username - the user name of the credential.
          +
          password - the password of the credential.
          +
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getPassword

          +
          public char[] getPassword()
          +
          Gets the password.
          +
          +
          Returns:
          +
          the password
          +
          +
          • +
        + + + +
          +
        • +

          getUsername

          +
          public java.lang.String getUsername()
          +
          Description copied from interface: UserCredential
          +
          Returns the user name associated with this credential.
          +
          +
          Specified by:
          +
          getUsername in interface UserCredential
          +
          Returns:
          +
          the user name associated with this credential.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/UserCredential.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/UserCredential.html new file mode 100644 index 000000000..db61b0307 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/UserCredential.html @@ -0,0 +1,234 @@ + + + + + +UserCredential (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.credentials
    +

    Interface UserCredential

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getUsername

          +
          java.lang.String getUsername()
          +
          Returns the user name associated with this credential.
          +
          +
          Returns:
          +
          the user name associated with this credential.
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/package-frame.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/package-frame.html new file mode 100644 index 000000000..59ff2836b --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/package-frame.html @@ -0,0 +1,28 @@ + + + + + +nl.esciencecenter.xenon.credentials (xenon-2.3.0 2.6.1 API) + + + + +

    nl.esciencecenter.xenon.credentials

    +
    +

    Interfaces

    + +

    Classes

    + +
    + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/package-summary.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/package-summary.html new file mode 100644 index 000000000..3af31aaf7 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/package-summary.html @@ -0,0 +1,193 @@ + + + + + +nl.esciencecenter.xenon.credentials (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Package nl.esciencecenter.xenon.credentials

    +
    +
    This package contains classes and interfaces for managing credentials.
    +
    +

    See: Description

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      Credential +
      Credential represents a user credential uses to gain access to a resource.
      +
      UserCredential 
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      CertificateCredential +
      A container for security Information based upon certificates.
      +
      CredentialMap +
      A Credential consisting of a collection of Credentials each uniquely identified by a String (typically a host name or host alias).
      +
      DefaultCredential +
      This class represents the default credential that may be used by the various adaptors.
      +
      KeytabCredential 
      PasswordCredential +
      A Credential consisting of a username + password combination.
      +
      +
      • +
    + + + +

    Package nl.esciencecenter.xenon.credentials Description

    +
    This package contains classes and interfaces for managing credentials.
    +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/package-tree.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/package-tree.html new file mode 100644 index 000000000..685010ad0 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/credentials/package-tree.html @@ -0,0 +1,149 @@ + + + + + +nl.esciencecenter.xenon.credentials Class Hierarchy (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Hierarchy For Package nl.esciencecenter.xenon.credentials

    +Package Hierarchies: + +
    +
    +

    Class Hierarchy

    + +

    Interface Hierarchy

    + +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/AttributeNotSupportedException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/AttributeNotSupportedException.html new file mode 100644 index 000000000..421913bad --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/AttributeNotSupportedException.html @@ -0,0 +1,292 @@ + + + + + +AttributeNotSupportedException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.filesystems
    +

    Class AttributeNotSupportedException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class AttributeNotSupportedException
+extends XenonException
      +
      Signals that a requested file attribute is not supported by the underlying file system implementation.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AttributeNotSupportedException

          +
          public AttributeNotSupportedException(java.lang.String adaptorName,
+                                      java.lang.String message,
+                                      java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          AttributeNotSupportedException

          +
          public AttributeNotSupportedException(java.lang.String adaptorName,
+                                      java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyCancelledException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyCancelledException.html new file mode 100644 index 000000000..eeda56cdb --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyCancelledException.html @@ -0,0 +1,273 @@ + + + + + +CopyCancelledException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.filesystems
    +

    Class CopyCancelledException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class CopyCancelledException
+extends XenonException
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        CopyCancelledException(java.lang.String adaptorName, + java.lang.String s) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CopyCancelledException

          +
          public CopyCancelledException(java.lang.String adaptorName,
+                              java.lang.String s)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyMode.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyMode.html new file mode 100644 index 000000000..e07f5b4d0 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyMode.html @@ -0,0 +1,366 @@ + + + + + +CopyMode (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.filesystems
    +

    Enum CopyMode

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<CopyMode>
        • +
      • +
          +
        • nl.esciencecenter.xenon.filesystems.CopyMode
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<CopyMode>
      +
      +
      +
      +
      public enum CopyMode
+extends java.lang.Enum<CopyMode>
      +
      CopyOption is an enumeration containing all possible options for copying a file. + + Note that the CREATE, REPLACE and IGNORE options are mutually exclusive.
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum Constant and Description
        CREATE +
        Copy to a new destination file, failing if the file already exists.
        +
        IGNORE +
        Skip the copy if the destination file if it already exists.
        +
        REPLACE +
        If the source and destination are a regular file, the destination file will be replaced.
        +
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethod and Description
        static CopyModevalueOf(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static CopyMode[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          CREATE

          +
          public static final CopyMode CREATE
          +
          Copy to a new destination file, failing if the file already exists.
          +
          • +
        + + + +
          +
        • +

          REPLACE

          +
          public static final CopyMode REPLACE
          +
          If the source and destination are a regular file, the destination file will be replaced. If the destination exists and is not a file and the source is a + file, then the destination will be (recursively) deleted before copying. + + + If the source and destination are directories then additional files in the destination directory are not touched.
          +
          • +
        + + + +
          +
        • +

          IGNORE

          +
          public static final CopyMode IGNORE
          +
          Skip the copy if the destination file if it already exists.
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static CopyMode[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (CopyMode c : CopyMode.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static CopyMode valueOf(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyStatus.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyStatus.html new file mode 100644 index 000000000..6706513aa --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyStatus.html @@ -0,0 +1,393 @@ + + + + + +CopyStatus (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.filesystems
    +

    Interface CopyStatus

    +
    +
    +
    +
      +
    • +
      +
      +
      public interface CopyStatus
      +
      CopyStatus contains status information for a specific copy operation.
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethod and Description
        longbytesCopied() +
        Get the number of bytes that have been copied.
        +
        longbytesToCopy() +
        Get the number of bytes that need to be copied for the entire copy operation.
        +
        java.lang.StringgetCopyIdentifier() +
        Get the copy identifier for which this CopyStatus was created.
        +
        XenonExceptiongetException() +
        Get the exception produced by the Copy or while retrieving the status.
        +
        java.lang.StringgetState() +
        Get the state of the Copy operation.
        +
        booleanhasException() +
        Has the Copy or status retrieval produced a exception ?
        +
        booleanisDone() +
        Is the Copy done?
        +
        booleanisRunning() +
        Is the Copy still running?
        +
        voidmaybeThrowException() +
        Throws the exception that occured during copying, if it exists.
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getCopyIdentifier

          +
          java.lang.String getCopyIdentifier()
          +
          Get the copy identifier for which this CopyStatus was created.
          +
          +
          Returns:
          +
          the Copy.
          +
          +
          • +
        + + + +
          +
        • +

          getState

          +
          java.lang.String getState()
          +
          Get the state of the Copy operation.
          +
          +
          Returns:
          +
          the state of the Copy operation.
          +
          +
          • +
        + + + +
          +
        • +

          getException

          +
          XenonException getException()
          +
          Get the exception produced by the Copy or while retrieving the status. If there was no exception, null will be returned. + + See maybeThrowException() for the possible exceptions.
          +
          +
          Returns:
          +
          the exception.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          isRunning

          +
          boolean isRunning()
          +
          Is the Copy still running?
          +
          +
          Returns:
          +
          if the Copy is running.
          +
          +
          • +
        + + + +
          +
        • +

          isDone

          +
          boolean isDone()
          +
          Is the Copy done?
          +
          +
          Returns:
          +
          if the Copy is done.
          +
          +
          • +
        + + + +
          +
        • +

          hasException

          +
          boolean hasException()
          +
          Has the Copy or status retrieval produced a exception ?
          +
          +
          Returns:
          +
          if the Copy or status retrieval produced a exception.
          +
          +
          • +
        + + + +
          +
        • +

          bytesToCopy

          +
          long bytesToCopy()
          +
          Get the number of bytes that need to be copied for the entire copy operation.
          +
          +
          Returns:
          +
          the number of bytes that need to be copied.
          +
          +
          • +
        + + + +
          +
        • +

          bytesCopied

          +
          long bytesCopied()
          +
          Get the number of bytes that have been copied.
          +
          +
          Returns:
          +
          the number of bytes that have been copied.
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/DirectoryNotEmptyException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/DirectoryNotEmptyException.html new file mode 100644 index 000000000..70d344b6e --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/DirectoryNotEmptyException.html @@ -0,0 +1,292 @@ + + + + + +DirectoryNotEmptyException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.filesystems
    +

    Class DirectoryNotEmptyException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class DirectoryNotEmptyException
+extends XenonException
      +
      Signals that directory is not empty.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        DirectoryNotEmptyException(java.lang.String adaptorName, + java.lang.String message) 
        DirectoryNotEmptyException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DirectoryNotEmptyException

          +
          public DirectoryNotEmptyException(java.lang.String adaptorName,
+                                  java.lang.String message,
+                                  java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          DirectoryNotEmptyException

          +
          public DirectoryNotEmptyException(java.lang.String adaptorName,
+                                  java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystem.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystem.html new file mode 100644 index 000000000..7af240db6 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystem.html @@ -0,0 +1,1330 @@ + + + + + +FileSystem (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.filesystems
    +

    Class FileSystem

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • nl.esciencecenter.xenon.filesystems.FileSystem
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.lang.AutoCloseable
      +
      +
      +
      +
      public abstract class FileSystem
+extends java.lang.Object
+implements java.lang.AutoCloseable
      +
      FileSystem represent a (possibly remote) file system that can be used to access data.
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethod and Description
        abstract java.io.OutputStreamappendToFile(Path file) +
        Open an existing file and return an OutputStream to append data to this file.
        +
        CopyStatuscancel(java.lang.String copyIdentifier) +
        Cancel a copy operation.
        +
        voidclose() +
        Close this FileSystem.
        +
        java.lang.Stringcopy(Path source, + FileSystem destinationFS, + Path destination, + CopyMode mode, + boolean recursive) +
        Asynchronously Copy an existing source path to a target path on a different file system.
        +
        static FileSystemcreate(java.lang.String adaptor) +
        Create a new FileSystem using the adaptor that connects to a data store at the default location using the default credentials to get access.
        +
        static FileSystemcreate(java.lang.String adaptor, + java.lang.String location) +
        Create a new FileSystem using the adaptor that connects to a data store at location using the default credentials to get + access.
        +
        static FileSystemcreate(java.lang.String adaptor, + java.lang.String location, + Credential credential) +
        Create a new FileSystem using the adaptor that connects to a data store at location using the credentials to get + access.
        +
        static FileSystemcreate(java.lang.String adaptor, + java.lang.String location, + Credential credential, + java.util.Map<java.lang.String,java.lang.String> properties) +
        Create a new FileSystem using the adaptor that connects to a data store at location using the credentials to get + access.
        +
        voidcreateDirectories(Path dir) +
        Creates a new directory, failing if the directory already exists.
        +
        abstract voidcreateDirectory(Path dir) +
        Creates a new directory, failing if the directory already exists.
        +
        abstract voidcreateFile(Path file) +
        Creates a new empty file, failing if the file already exists.
        +
        abstract voidcreateSymbolicLink(Path link, + Path target) +
        Creates a new symbolic link, failing if the link already exists (optional operation).
        +
        voiddelete(Path path, + boolean recursive) +
        Deletes an existing path.
        +
        booleanequals(java.lang.Object o) 
        abstract booleanexists(Path path) +
        Tests if a path exists.
        +
        static FileSystemAdaptorDescriptiongetAdaptorDescription(java.lang.String adaptorName) +
        Gives the description of the adaptor with the given name.
        +
        static FileSystemAdaptorDescription[]getAdaptorDescriptions() +
        Gives a list of the descriptions of the available adaptors.
        +
        java.lang.StringgetAdaptorName() +
        Get the name of the adaptor that created this FileSystem.
        +
        static java.lang.String[]getAdaptorNames() +
        Gives a list names of the available adaptors.
        +
        abstract PathAttributesgetAttributes(Path path) +
        Get the PathAttributes of an existing path.
        +
        CredentialgetCredential() +
        Get the credential that this FileSystem is using.
        +
        java.lang.StringgetLocation() +
        Get the location of the FileSystem.
        +
        java.lang.StringgetPathSeparator() +
        Get the path separator used by this file system.
        +
        java.util.Map<java.lang.String,java.lang.String>getProperties() +
        Get the properties used to create this FileSystem.
        +
        CopyStatusgetStatus(java.lang.String copyIdentifier) +
        Retrieve the status of an copy.
        +
        PathgetWorkingDirectory() +
        Get the current working directory of this file system.
        +
        inthashCode() 
        abstract booleanisOpen() +
        Return if the connection to the FileSystem is open.
        +
        java.lang.Iterable<PathAttributes>list(Path dir, + boolean recursive) +
        List all entries in the directory dir.
        +
        abstract java.io.InputStreamreadFromFile(Path file) +
        Open an existing file and return an InputStream to read from this file.
        +
        abstract PathreadSymbolicLink(Path link) +
        Reads the target of a symbolic link (optional operation).
        +
        abstract voidrename(Path source, + Path target) +
        Rename an existing source path to a non-existing target path (optional operation).
        +
        abstract voidsetPosixFilePermissions(Path path, + java.util.Set<PosixFilePermission> permissions) +
        Sets the POSIX permissions of a path (optional operation).
        +
        voidsetWorkingDirectory(Path directory) +
        Set the current working directory of this file system to directory.
        +
        CopyStatuswaitUntilDone(java.lang.String copyIdentifier, + long timeout) +
        Wait until a copy operation is done or until a timeout expires.
        +
        abstract java.io.OutputStreamwriteToFile(Path file) +
        Open a file and return an OutputStream to write to this file.
        +
        abstract java.io.OutputStreamwriteToFile(Path path, + long size) +
        Open a file and return an OutputStream to write to this file.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getAdaptorNames

          +
          public static java.lang.String[] getAdaptorNames()
          +
          Gives a list names of the available adaptors.
          +
          +
          Returns:
          +
          the list
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getAdaptorDescriptions

          +
          public static FileSystemAdaptorDescription[] getAdaptorDescriptions()
          +
          Gives a list of the descriptions of the available adaptors.
          +
          +
          Returns:
          +
          the list
          +
          +
          • +
        + + + +
          +
        • +

          create

          +
          public static FileSystem create(java.lang.String adaptor,
+                                java.lang.String location,
+                                Credential credential,
+                                java.util.Map<java.lang.String,java.lang.String> properties)
+                         throws XenonException
          +
          Create a new FileSystem using the adaptor that connects to a data store at location using the credentials to get + access. Use properties to (optionally) configure the FileSystem when it is created. + + Make sure to always close FileSystem instances by calling close(FileSystem) when you no longer need them, otherwise their associated + resources remain allocated.
          +
          +
          Parameters:
          +
          adaptor - the type of file system to connect to (e.g. "sftp" or "webdav")
          +
          location - the location of the FileSystem.
          +
          credential - the Credentials to use to get access to the FileSystem.
          +
          properties - optional properties to use when creating the FileSystem.
          +
          Returns:
          +
          the new FileSystem.
          +
          Throws:
          +
          UnknownPropertyException - If a unknown property was provided.
          +
          InvalidPropertyException - If a known property was provided with an invalid value.
          +
          UnknownAdaptorException - If the adaptor was invalid.
          +
          InvalidLocationException - If the location was invalid.
          +
          InvalidCredentialException - If the credential is invalid to access the location.
          +
          XenonException - If the creation of the FileSystem failed.
          +
          java.lang.IllegalArgumentException - If adaptor is null.
          +
          See Also:
          +
          Documentation on the supported adaptors and locations.
          +
          +
          • +
        + + + +
          +
        • +

          create

          +
          public static FileSystem create(java.lang.String adaptor,
+                                java.lang.String location,
+                                Credential credential)
+                         throws XenonException
          +
          Create a new FileSystem using the adaptor that connects to a data store at location using the credentials to get + access. + + Make sure to always close FileSystem instances by calling close(FileSystem) when you no longer need them, otherwise their associated + resources remain allocated.
          +
          +
          Parameters:
          +
          adaptor - the type of file system to connect to (e.g. "sftp" or "webdav")
          +
          location - the location of the FileSystem.
          +
          credential - the Credentials to use to get access to the FileSystem.
          +
          Returns:
          +
          the new FileSystem.
          +
          Throws:
          +
          UnknownPropertyException - If a unknown property was provided.
          +
          InvalidPropertyException - If a known property was provided with an invalid value.
          +
          UnknownAdaptorException - If the adaptor was invalid.
          +
          InvalidLocationException - If the location was invalid.
          +
          InvalidCredentialException - If the credential is invalid to access the location.
          +
          XenonException - If the creation of the FileSystem failed.
          +
          java.lang.IllegalArgumentException - If adaptor is null.
          +
          See Also:
          +
          Documentation on the supported adaptors and locations.
          +
          +
          • +
        + + + +
          +
        • +

          create

          +
          public static FileSystem create(java.lang.String adaptor,
+                                java.lang.String location)
+                         throws XenonException
          +
          Create a new FileSystem using the adaptor that connects to a data store at location using the default credentials to get + access. + + Make sure to always close FileSystem instances by calling close(FileSystem) when you no longer need them, otherwise their associated + resources remain allocated.
          +
          +
          Parameters:
          +
          adaptor - the type of file system to connect to (e.g. "sftp" or "webdav")
          +
          location - the location of the FileSystem.
          +
          Returns:
          +
          the new FileSystem.
          +
          Throws:
          +
          UnknownPropertyException - If a unknown property was provided.
          +
          InvalidPropertyException - If a known property was provided with an invalid value.
          +
          UnknownAdaptorException - If the adaptor was invalid.
          +
          InvalidLocationException - If the location was invalid.
          +
          InvalidCredentialException - If the credential is invalid to access the location.
          +
          XenonException - If the creation of the FileSystem failed.
          +
          java.lang.IllegalArgumentException - If adaptor is null.
          +
          See Also:
          +
          Documentation on the supported adaptors and locations.
          +
          +
          • +
        + + + +
          +
        • +

          create

          +
          public static FileSystem create(java.lang.String adaptor)
+                         throws XenonException
          +
          Create a new FileSystem using the adaptor that connects to a data store at the default location using the default credentials to get access. + + Note that there are very few filesystem adaptors that support a default location. The local filesystem adaptor is the prime example. + + Make sure to always close FileSystem instances by calling close(FileSystem) when you no longer need them, otherwise their associated + resources remain allocated.
          +
          +
          Parameters:
          +
          adaptor - the type of file system to connect to (e.g. "sftp" or "webdav")
          +
          Returns:
          +
          the new FileSystem.
          +
          Throws:
          +
          UnknownPropertyException - If a unknown property was provided.
          +
          InvalidPropertyException - If a known property was provided with an invalid value.
          +
          UnknownAdaptorException - If the adaptor was invalid.
          +
          InvalidLocationException - If the location was invalid.
          +
          InvalidCredentialException - If the credential is invalid to access the location.
          +
          XenonException - If the creation of the FileSystem failed.
          +
          java.lang.IllegalArgumentException - If adaptor is null.
          +
          See Also:
          +
          Documentation on the supported adaptors and locations.
          +
          +
          • +
        + + + +
          +
        • +

          getAdaptorName

          +
          public java.lang.String getAdaptorName()
          +
          Get the name of the adaptor that created this FileSystem.
          +
          +
          Returns:
          +
          the name of the adaptor.
          +
          +
          • +
        + + + +
          +
        • +

          getLocation

          +
          public java.lang.String getLocation()
          +
          Get the location of the FileSystem.
          +
          +
          Returns:
          +
          the location of the FileSystem.
          +
          +
          • +
        + + + +
          +
        • +

          getCredential

          +
          public Credential getCredential()
          +
          Get the credential that this FileSystem is using.
          +
          +
          Returns:
          +
          the credential this FileSystem is using.
          +
          +
          • +
        + + + +
          +
        • +

          getProperties

          +
          public java.util.Map<java.lang.String,java.lang.String> getProperties()
          +
          Get the properties used to create this FileSystem.
          +
          +
          Returns:
          +
          the properties used to create this FileSystem.
          +
          +
          • +
        + + + +
          +
        • +

          getWorkingDirectory

          +
          public Path getWorkingDirectory()
          +
          Get the current working directory of this file system. + + All relative paths provided to FileSystem methods are resolved against this current working directory. + + The current working directory is set when a FileSystem is created using the path specified in the location. If no path is specified in the location, an + adaptor specific default path is used, for example "/home/username".
          +
          +
          Returns:
          +
          the current working directory of this file system.
          +
          +
          • +
        + + + +
          +
        • +

          getPathSeparator

          +
          public java.lang.String getPathSeparator()
          +
          Get the path separator used by this file system. + + The path separator is set when a FileSystem is created.
          +
          +
          Returns:
          +
          the path separator used by this file system.
          +
          +
          • +
        + + + +
          +
        • +

          setWorkingDirectory

          +
          public void setWorkingDirectory(Path directory)
+                         throws XenonException
          +
          Set the current working directory of this file system to directory. + + The provided directory must exist and be a directory. Both an absolute or relative path may be provided. In the latter case, the path will + be resolved against the current working directory.
          +
          +
          Parameters:
          +
          directory - a path to which the current working directory must be set.
          +
          Throws:
          +
          NoSuchPathException - if the directory does not exist
          +
          InvalidPathException - if directory is not a directory
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - if file system is closed.
          +
          java.lang.IllegalArgumentException - if the argument is null.
          +
          XenonException - if an I/O error occurred
          +
          +
          • +
        + + + +
          +
        • +

          close

          +
          public void close()
+           throws XenonException
          +
          Close this FileSystem. If the adaptor does not support closing this is a no-op.
          +
          +
          Specified by:
          +
          close in interface java.lang.AutoCloseable
          +
          Throws:
          +
          XenonException - If the FileSystem failed to close or if an I/O error occurred.
          +
          +
          • +
        + + + +
          +
        • +

          isOpen

          +
          public abstract boolean isOpen()
+                        throws XenonException
          +
          Return if the connection to the FileSystem is open. An adaptor which does not support closing is always open.
          +
          +
          Returns:
          +
          if the connection to the FileSystem is open.
          +
          Throws:
          +
          XenonException - if the test failed or an I/O error occurred.
          +
          +
          • +
        + + + +
          +
        • +

          rename

          +
          public abstract void rename(Path source,
+                            Path target)
+                     throws XenonException
          +
          Rename an existing source path to a non-existing target path (optional operation). +

          + + This method only implements a rename operation, not a move operation. Hence, this method will not copy files and should return (almost) + instantaneously. + + The parent of the target path (e.g. target.getParent) must exist. + + If the target is equal to the source this method has no effect. + + If the source is a link, the link itself will be renamed, not the path to which it refers. + + If the source is a directory, it will be renamed to the target. This implies that a moving a directory between physical locations may fail. +

          +
          +
          Parameters:
          +
          source - the existing source path.
          +
          target - the non existing target path.
          +
          Throws:
          +
          UnsupportedOperationException - If the adapter does not support renaming.
          +
          NoSuchPathException - If the source file does not exist or the target parent directory does not exist.
          +
          PathAlreadyExistsException - If the target file already exists.
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - If the move failed.
          +
          java.lang.IllegalArgumentException - If one or both of the arguments are null.
          +
          +
          • +
        + + + +
          +
        • +

          createDirectories

          +
          public void createDirectories(Path dir)
+                       throws XenonException
          +
          Creates a new directory, failing if the directory already exists. All nonexistent parent directories are also created.
          +
          +
          Parameters:
          +
          dir - the directory to create.
          +
          Throws:
          +
          PathAlreadyExistsException - If the directory already exists or if a parent directory could not be created because a file with the same name already exists.
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - If an I/O error occurred.
          +
          java.lang.IllegalArgumentException - If one or both of the arguments are null.
          +
          +
          • +
        + + + +
          +
        • +

          createDirectory

          +
          public abstract void createDirectory(Path dir)
+                              throws XenonException
          +
          Creates a new directory, failing if the directory already exists. + + The parent directory of the file must already exists.
          +
          +
          Parameters:
          +
          dir - the directory to create.
          +
          Throws:
          +
          PathAlreadyExistsException - If the directory already exists.
          +
          NoSuchPathException - If the parent directory does not exist.
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - If an I/O error occurred.
          +
          java.lang.IllegalArgumentException - If the argument is null.
          +
          +
          • +
        + + + +
          +
        • +

          createFile

          +
          public abstract void createFile(Path file)
+                         throws XenonException
          +
          Creates a new empty file, failing if the file already exists. + + The parent directory of the file must already exists.
          +
          +
          Parameters:
          +
          file - a path referring to the file to create.
          +
          Throws:
          +
          PathAlreadyExistsException - If the file already exists.
          +
          NoSuchPathException - If the parent directory does not exist.
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - If an I/O error occurred.
          +
          java.lang.IllegalArgumentException - If one or both of the arguments are null.
          +
          +
          • +
        + + + +
          +
        • +

          createSymbolicLink

          +
          public abstract void createSymbolicLink(Path link,
+                                        Path target)
+                                 throws XenonException
          +
          Creates a new symbolic link, failing if the link already exists (optional operation). + + The target is taken as is. It may be absolute, relative path and/or non-normalized path and may or may not exist.
          +
          +
          Parameters:
          +
          link - the symbolic link to create.
          +
          target - the target the symbolic link should refer to.
          +
          Throws:
          +
          PathAlreadyExistsException - If the link already exists.
          +
          NoSuchPathException - If the target or parent directory of link does not exist
          +
          InvalidPathException - If parent of link is not a directory
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - If an I/O error occurred.
          +
          java.lang.IllegalArgumentException - If one or both of the arguments are null.
          +
          +
          • +
        + + + +
          +
        • +

          delete

          +
          public void delete(Path path,
+                   boolean recursive)
+            throws XenonException
          +
          Deletes an existing path. + + If path is a symbolic link the symbolic link is removed and the symbolic link's target is not deleted. + + If the path is a directory and recursive is set to true, the contents of the directory will also be deleted. If recursive is + set to false, a directory will only be removed if it is empty.
          +
          +
          Parameters:
          +
          path - the path to delete.
          +
          recursive - if the delete must be done recursively
          +
          Throws:
          +
          DirectoryNotEmptyException - if the directory was not empty (and the delete was not recursive).
          +
          NoSuchPathException - if the provided path does not exist.
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - if an I/O error occurred.
          +
          java.lang.IllegalArgumentException - If path is null.
          +
          +
          • +
        + + + +
          +
        • +

          exists

          +
          public abstract boolean exists(Path path)
+                        throws XenonException
          +
          Tests if a path exists.
          +
          +
          Parameters:
          +
          path - the path to test.
          +
          Returns:
          +
          If the path exists.
          +
          Throws:
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - if an I/O error occurred.
          +
          java.lang.IllegalArgumentException - If path is null.
          +
          +
          • +
        + + + +
          +
        • +

          list

          +
          public java.lang.Iterable<PathAttributes> list(Path dir,
+                                               boolean recursive)
+                                        throws XenonException
          +
          List all entries in the directory dir. + + All entries in the directory are returned, but subdirectories will not be traversed by default. Set recursive to true, include + the listing of all subdirectories. + + Symbolic links are not followed.
          +
          +
          Parameters:
          +
          dir - the target directory.
          +
          recursive - should the list recursively traverse the subdirectories ?
          +
          Returns:
          +
          a List of PathAttributes that iterates over all entries in the directory dir.
          +
          Throws:
          +
          NoSuchPathException - If a directory does not exists.
          +
          InvalidPathException - If dir is not a directory.
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - if an I/O error occurred.
          +
          java.lang.IllegalArgumentException - If path is null.
          +
          +
          • +
        + + + +
          +
        • +

          readFromFile

          +
          public abstract java.io.InputStream readFromFile(Path file)
+                                          throws XenonException
          +
          Open an existing file and return an InputStream to read from this file.
          +
          +
          Parameters:
          +
          file - the to read.
          +
          Returns:
          +
          the InputStream to read from the file.
          +
          Throws:
          +
          NoSuchPathException - If the file does not exists.
          +
          InvalidPathException - If the file is not regular file.
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - if an I/O error occurred.
          +
          java.lang.IllegalArgumentException - If path is null.
          +
          +
          • +
        + + + +
          +
        • +

          writeToFile

          +
          public abstract java.io.OutputStream writeToFile(Path path,
+                                                 long size)
+                                          throws XenonException
          +
          Open a file and return an OutputStream to write to this file. +

          + + The size of the file (once all data has been written) must be specified using the size parameter. This is required by some implementations + (typically blob-stores). + +

          +
          +
          Parameters:
          +
          path - the target file for the OutputStream.
          +
          size - the size of the file once fully written.
          +
          Returns:
          +
          the OutputStream to write to the file.
          +
          Throws:
          +
          PathAlreadyExistsException - If the target existed.
          +
          NoSuchPathException - if a parent directory does not exist.
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - if an I/O error occurred.
          +
          java.lang.IllegalArgumentException - If path is null.
          +
          +
          • +
        + + + +
          +
        • +

          writeToFile

          +
          public abstract java.io.OutputStream writeToFile(Path file)
+                                          throws XenonException
          +
          Open a file and return an OutputStream to write to this file. (optional operation) +

          + If the file already exists it will be replaced and its data will be lost. + + The amount of data that will be written to the file is not specified in advance. This operation may not be supported by all implementations. + +

          +
          +
          Parameters:
          +
          file - the target file for the OutputStream.
          +
          Returns:
          +
          the OutputStream to write to the file.
          +
          Throws:
          +
          PathAlreadyExistsException - If the target existed.
          +
          NoSuchPathException - if a parent directory does not exist.
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - if an I/O error occurred.
          +
          java.lang.IllegalArgumentException - If path is null.
          +
          +
          • +
        + + + +
          +
        • +

          appendToFile

          +
          public abstract java.io.OutputStream appendToFile(Path file)
+                                           throws XenonException
          +
          Open an existing file and return an OutputStream to append data to this file. (optional operation) +

          + If the file does not exist, an exception will be thrown. + + This operation may not be supported by all implementations. + +

          +
          +
          Parameters:
          +
          file - the target file for the OutputStream.
          +
          Returns:
          +
          the OutputStream to write to the file.
          +
          Throws:
          +
          PathAlreadyExistsException - If the target existed.
          +
          NoSuchPathException - if a parent directory does not exist.
          +
          InvalidPathException - if not a regular file
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - if an I/O error occurred.
          +
          java.lang.IllegalArgumentException - If path is null.
          +
          UnsupportedOperationException - if the adaptor does not support appending
          +
          +
          • +
        + + + +
          +
        • +

          getAttributes

          +
          public abstract PathAttributes getAttributes(Path path)
+                                      throws XenonException
          +
          Get the PathAttributes of an existing path.
          +
          +
          Parameters:
          +
          path - the existing path.
          +
          Returns:
          +
          the FileAttributes of the path.
          +
          Throws:
          +
          NoSuchPathException - If the file does not exists.
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - if an I/O error occurred.
          +
          java.lang.IllegalArgumentException - If path is null.
          +
          +
          • +
        + + + +
          +
        • +

          readSymbolicLink

          +
          public abstract Path readSymbolicLink(Path link)
+                               throws XenonException
          +
          Reads the target of a symbolic link (optional operation).
          +
          +
          Parameters:
          +
          link - the link to read.
          +
          Returns:
          +
          a Path representing the target of the link.
          +
          Throws:
          +
          NoSuchPathException - If the link does not exists.
          +
          InvalidPathException - If the source is not a link.
          +
          UnsupportedOperationException - If this FileSystem does not support symbolic links.
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - if an I/O error occurred.
          +
          java.lang.IllegalArgumentException - If path is null.
          +
          +
          • +
        + + + +
          +
        • +

          setPosixFilePermissions

          +
          public abstract void setPosixFilePermissions(Path path,
+                                             java.util.Set<PosixFilePermission> permissions)
+                                      throws XenonException
          +
          Sets the POSIX permissions of a path (optional operation).
          +
          +
          Parameters:
          +
          path - the target path.
          +
          permissions - the permissions to set.
          +
          Throws:
          +
          NoSuchPathException - If the target path does not exists.
          +
          UnsupportedOperationException - If this FileSystem does not support symbolic links.
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - if an I/O error occurred.
          +
          java.lang.IllegalArgumentException - If path is null.
          +
          +
          • +
        + + + +
          +
        • +

          copy

          +
          public java.lang.String copy(Path source,
+                             FileSystem destinationFS,
+                             Path destination,
+                             CopyMode mode,
+                             boolean recursive)
          +
          Asynchronously Copy an existing source path to a target path on a different file system. + + If the source path is a file, it will be copied to the destination file on the target file system. + + If the source path is a directory, it will only be copied if recursive is set to true. Otherwise, an exception will be thrown. + When copying recursively, the directory and its content (both files and subdirectories with content), will be copied to destination. + + Exceptions that occur during copying will not be thrown by this function, but instead are contained in a CopyStatus object which can be obtained + with getStatus(String)
          +
          +
          Parameters:
          +
          source - the source path (on this filesystem) to copy from.
          +
          destinationFS - the destination filesystem to copy to.
          +
          destination - the destination path (on the destination filesystem) to copy to.
          +
          mode - how to react if the destination already exists.
          +
          recursive - if the copy should be recursive.
          +
          Returns:
          +
          a String that identifies this copy and be used to inspect its progress.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - If source, destinationFS, destination or mode is null.
          +
          +
          • +
        + + + +
          +
        • +

          cancel

          +
          public CopyStatus cancel(java.lang.String copyIdentifier)
+                  throws XenonException
          +
          Cancel a copy operation. Afterwards, the copy is forgotten and subsequent queries with this copy string will lead to NoSuchCopyException
          +
          +
          Parameters:
          +
          copyIdentifier - the identifier of the copy operation which to cancel.
          +
          Returns:
          +
          a CopyStatus containing the status of the copy.
          +
          Throws:
          +
          NoSuchCopyException - If the copy is not known.
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - if an I/O error occurred.
          +
          java.lang.IllegalArgumentException - If the copyIdentifier is null.
          +
          +
          • +
        + + + +
          +
        • +

          waitUntilDone

          +
          public CopyStatus waitUntilDone(java.lang.String copyIdentifier,
+                                long timeout)
+                         throws XenonException
          +
          Wait until a copy operation is done or until a timeout expires. +

          + This method will wait until a copy operation is done (either gracefully or by producing an error), or until the timeout expires, whichever comes first. + If the timeout expires, the copy operation will continue to run. +

          +

          + The timeout is in milliseconds and must be >= 0. When timeout is 0, it will be ignored and this method will wait until the copy operation is done. +

          + After this operation, the copy is forgotten and subsequent queries with this copy string will lead to NoSuchCopyException +

          + A CopyStatus is returned that can be used to determine why the call returned. +

          +
          +
          Parameters:
          +
          copyIdentifier - the identifier of the copy operation to wait for.
          +
          timeout - the maximum time to wait for the copy operation in milliseconds.
          +
          Returns:
          +
          a CopyStatus containing the status of the copy.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - If argument is illegal.
          +
          NoSuchCopyException - If the copy handle is not known.
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - if an I/O error occurred.
          +
          java.lang.IllegalArgumentException - If the copyIdentifier is null or if the value of timeout is negative.
          +
          +
          • +
        + + + +
          +
        • +

          getStatus

          +
          public CopyStatus getStatus(java.lang.String copyIdentifier)
+                     throws XenonException
          +
          Retrieve the status of an copy. After obtaining the status of a completed copy, the copy is forgotten and subsequent queries with this copy string will + lead to NoSuchCopyException.
          +
          +
          Parameters:
          +
          copyIdentifier - the identifier of the copy for which to retrieve the status.
          +
          Returns:
          +
          a CopyStatus containing the status of the asynchronous copy.
          +
          Throws:
          +
          NoSuchCopyException - If the copy is not known.
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If file system is closed.
          +
          XenonException - if an I/O error occurred.
          +
          java.lang.IllegalArgumentException - If the copyIdentifier is null.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystemAdaptorDescription.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystemAdaptorDescription.html new file mode 100644 index 000000000..db6b52133 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystemAdaptorDescription.html @@ -0,0 +1,363 @@ + + + + + +FileSystemAdaptorDescription (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.filesystems
    +

    Interface FileSystemAdaptorDescription

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          supportsThirdPartyCopy

          +
          boolean supportsThirdPartyCopy()
          +
          Does this adaptor support third party copy ? + + In third party copy, a file is copied between two remote locations, without passing through the local machine first.
          +
          +
          Returns:
          +
          if this adaptor supports third party copy.
          +
          +
          • +
        + + + +
          +
        • +

          canReadSymboliclinks

          +
          boolean canReadSymboliclinks()
          +
          Can this adaptor read symbolic links ?
          +
          +
          Returns:
          +
          if this adaptor can read symbolic links.
          +
          +
          • +
        + + + +
          +
        • +

          canCreateSymboliclinks

          +
          boolean canCreateSymboliclinks()
          +
          Can this adaptor create symbolic links ? + + In third party copy, a file is copied between two remote locations, without passing through the local machine first.
          +
          +
          Returns:
          +
          if this adaptor can create symbolic links.
          +
          +
          • +
        + + + +
          +
        • +

          isConnectionless

          +
          boolean isConnectionless()
          +
          • +
        + + + +
          +
        • +

          supportsReadingPosixPermissions

          +
          boolean supportsReadingPosixPermissions()
          +
          • +
        + + + +
          +
        • +

          supportsSettingPosixPermissions

          +
          boolean supportsSettingPosixPermissions()
          +
          • +
        + + + +
          +
        • +

          supportsRename

          +
          boolean supportsRename()
          +
          • +
        + + + +
          +
        • +

          canAppend

          +
          boolean canAppend()
          +
          • +
        + + + +
          +
        • +

          needsSizeBeforehand

          +
          boolean needsSizeBeforehand()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystemClosedException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystemClosedException.html new file mode 100644 index 000000000..73698bb88 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystemClosedException.html @@ -0,0 +1,292 @@ + + + + + +FileSystemClosedException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.filesystems
    +

    Class FileSystemClosedException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class FileSystemClosedException
+extends XenonException
      +
      Signals that a unknown Copy handle was provided.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        FileSystemClosedException(java.lang.String adaptorName, + java.lang.String message) 
        FileSystemClosedException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          FileSystemClosedException

          +
          public FileSystemClosedException(java.lang.String adaptorName,
+                                 java.lang.String message,
+                                 java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          FileSystemClosedException

          +
          public FileSystemClosedException(java.lang.String adaptorName,
+                                 java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidOptionsException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidOptionsException.html new file mode 100644 index 000000000..c1ed56d37 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidOptionsException.html @@ -0,0 +1,292 @@ + + + + + +InvalidOptionsException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.filesystems
    +

    Class InvalidOptionsException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class InvalidOptionsException
+extends XenonException
      +
      Signals that an invalid combination of OpenOptions have been specified.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        InvalidOptionsException(java.lang.String adaptorName, + java.lang.String message) 
        InvalidOptionsException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InvalidOptionsException

          +
          public InvalidOptionsException(java.lang.String adaptorName,
+                               java.lang.String message,
+                               java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          InvalidOptionsException

          +
          public InvalidOptionsException(java.lang.String adaptorName,
+                               java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidPathException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidPathException.html new file mode 100644 index 000000000..a16378956 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidPathException.html @@ -0,0 +1,292 @@ + + + + + +InvalidPathException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.filesystems
    +

    Class InvalidPathException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class InvalidPathException
+extends XenonException
      +
      Signals that an end-of-file was encountered.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        InvalidPathException(java.lang.String adaptorName, + java.lang.String message) 
        InvalidPathException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InvalidPathException

          +
          public InvalidPathException(java.lang.String adaptorName,
+                            java.lang.String message,
+                            java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          InvalidPathException

          +
          public InvalidPathException(java.lang.String adaptorName,
+                            java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidResumeTargetException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidResumeTargetException.html new file mode 100644 index 000000000..d2b156a56 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidResumeTargetException.html @@ -0,0 +1,292 @@ + + + + + +InvalidResumeTargetException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.filesystems
    +

    Class InvalidResumeTargetException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class InvalidResumeTargetException
+extends XenonException
      +
      Signals that the data in the target of a resume does not match the data in the source.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        InvalidResumeTargetException(java.lang.String adaptorName, + java.lang.String message) 
        InvalidResumeTargetException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InvalidResumeTargetException

          +
          public InvalidResumeTargetException(java.lang.String adaptorName,
+                                    java.lang.String message,
+                                    java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          InvalidResumeTargetException

          +
          public InvalidResumeTargetException(java.lang.String adaptorName,
+                                    java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/NoSuchCopyException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/NoSuchCopyException.html new file mode 100644 index 000000000..ea1cfbd78 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/NoSuchCopyException.html @@ -0,0 +1,292 @@ + + + + + +NoSuchCopyException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.filesystems
    +

    Class NoSuchCopyException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class NoSuchCopyException
+extends XenonException
      +
      Signals that a unknown Copy handle was provided.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        NoSuchCopyException(java.lang.String adaptorName, + java.lang.String message) 
        NoSuchCopyException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          NoSuchCopyException

          +
          public NoSuchCopyException(java.lang.String adaptorName,
+                           java.lang.String message,
+                           java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          NoSuchCopyException

          +
          public NoSuchCopyException(java.lang.String adaptorName,
+                           java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/NoSuchPathException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/NoSuchPathException.html new file mode 100644 index 000000000..df1374193 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/NoSuchPathException.html @@ -0,0 +1,292 @@ + + + + + +NoSuchPathException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.filesystems
    +

    Class NoSuchPathException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class NoSuchPathException
+extends XenonException
      +
      Signals that a path does not exists.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        NoSuchPathException(java.lang.String adaptorName, + java.lang.String message) 
        NoSuchPathException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          NoSuchPathException

          +
          public NoSuchPathException(java.lang.String adaptorName,
+                           java.lang.String message,
+                           java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          NoSuchPathException

          +
          public NoSuchPathException(java.lang.String adaptorName,
+                           java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/Path.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/Path.html new file mode 100644 index 000000000..8f765f345 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/Path.html @@ -0,0 +1,998 @@ + + + + + +Path (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.filesystems
    +

    Class Path

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • nl.esciencecenter.xenon.filesystems.Path
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.lang.Iterable<Path>
      +
      +
      +
      +
      public class Path
+extends java.lang.Object
+implements java.lang.Iterable<Path>
      +
      Path contains a sequence of path elements separated by a separator. + + It is designed to be immutable.
      +
      +
      Since:
      +
      1.0
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Field Summary

        + + + + + + + + + + +
        Fields 
        Modifier and TypeField and Description
        static charDEFAULT_SEPARATOR +
        The default separator to use.
        +
        +
        • +
      + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        Path() +
        Create a new empty Path using the default separator.
        +
        Path(boolean isAbsolute, + java.util.List<java.lang.String> elements) +
        Create a new Path using the given path elements and the default separator.
        +
        Path(boolean isAbsolute, + java.lang.String... elements) +
        Create a new Path using the given path elements and the default separator.
        +
        Path(char separator, + boolean isAbsolute, + java.util.List<java.lang.String> elements) +
        Create a new Path using the given path separator, absoluteness, and elements.
        +
        Path(char separator, + boolean isAbsolute, + java.lang.String... elements) +
        Create a new Path using the given path elements and the provided separator.
        +
        Path(char separator, + java.lang.String path) +
        Create a new Path by parsing path using the provided separator.
        +
        Path(java.lang.String path) +
        Create a new Path by parsing path using the default separator.
        +
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        booleanendsWith(Path other) +
        Tests if this Path ends with the given Path.
        +
        booleanendsWith(java.lang.String other) +
        Tests if this Path ends with the given Path represented as a String.
        +
        booleanequals(java.lang.Object obj) 
        PathgetFileName() +
        Get the file name or null if the Path is empty.
        +
        java.lang.StringgetFileNameAsString() +
        Get the file name as a String, or null if the Path is empty.
        +
        PathgetName(int index) +
        Get an element of this Path.
        +
        intgetNameCount() +
        Get the number of elements in the Path.
        +
        PathgetParent() +
        Get the parent Path, or null if this Path does not have a parent.
        +
        chargetSeparator() +
        Get the separator.
        +
        inthashCode() 
        booleanisAbsolute() 
        booleanisEmpty() +
        Is this Path empty ?
        +
        java.util.Iterator<Path>iterator() +
        Create an Iterator that returns all possible sub Paths of this Path, in order of increasing length.
        +
        Pathnormalize() +
        Normalize this Path by removing as many redundant path elements as possible.
        +
        Pathrelativize(Path other) +
        Create a relative Path between the given Path and this Path.
        +
        Pathresolve(Path other) +
        Resolve a Path against this Path.
        +
        Pathresolve(java.lang.String other) +
        Resolve a Path represented as a String against this path.
        +
        PathresolveSibling(Path other) +
        Resolves the given Path to this paths parent Path, thereby creating a sibling to this Path.
        +
        booleanstartsWith(Path other) +
        Tests if this Path starts with the given Path.
        +
        booleanstartsWith(java.lang.String other) +
        Tests if this Path starts with the given Path represented as a String.
        +
        Pathsubpath(int beginIndex, + int endIndex) +
        Returns a Path that is a subsequence of the name elements of this path.
        +
        PathtoAbsolutePath() 
        PathtoRelativePath() 
        java.lang.StringtoString() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
          +
        • + + +

          Methods inherited from interface java.lang.Iterable

          +forEach, spliterator
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          DEFAULT_SEPARATOR

          +
          public static final char DEFAULT_SEPARATOR
          +
          The default separator to use.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Path

          +
          public Path()
          +
          Create a new empty Path using the default separator.
          +
          • +
        + + + +
          +
        • +

          Path

          +
          public Path(java.lang.String path)
          +
          Create a new Path by parsing path using the default separator. + + If path is null or an empty String, the resulting Path is empty and relative. Otherwise it will be split into multiple elements + using the default separator. If path starts with a separator, the resulting path will be absolute. Otherwise, it will be relative.
          +
          +
          Parameters:
          +
          path - the path to parse
          +
          +
          • +
        + + + +
          +
        • +

          Path

          +
          public Path(char separator,
+            java.lang.String path)
          +
          Create a new Path by parsing path using the provided separator. + + If path is null or an empty String, the resulting Path is empty and relative. Otherwise it will be split into multiple elements + using the provided separator. If path starts with a separator, the resulting path will be absolute. Otherwise, it will be relative.
          +
          +
          Parameters:
          +
          separator - the separator to use
          +
          path - the path to parse
          +
          +
          • +
        + + + +
          +
        • +

          Path

          +
          public Path(boolean isAbsolute,
+            java.lang.String... elements)
          +
          Create a new Path using the given path elements and the default separator. + + If elements is null or empty, the resulting Path is empty. The elements may not contain null or empty + Strings. The elements will not be parsed individually, and may not contain the separator character.
          +
          +
          Parameters:
          +
          isAbsolute - should the resulting path must be absolute?
          +
          elements - the path elements to use.
          +
          +
          • +
        + + + +
          +
        • +

          Path

          +
          public Path(char separator,
+            boolean isAbsolute,
+            java.lang.String... elements)
          +
          Create a new Path using the given path elements and the provided separator. + + If elements is null or empty, the resulting Path is empty. The elements may not contain null or empty + Strings. The elements will not be parsed individually, and may not contain the separator character.
          +
          +
          Parameters:
          +
          separator - the separator to use.
          +
          isAbsolute - should the resulting path must be absolute?
          +
          elements - the path elements to use.
          +
          +
          • +
        + + + +
          +
        • +

          Path

          +
          public Path(boolean isAbsolute,
+            java.util.List<java.lang.String> elements)
          +
          Create a new Path using the given path elements and the default separator. + + If elements is null or empty, the resulting Path is empty. The elements list may not contain null or + empty Strings, or Strings that contain the separator character. If they do, an IllegalArgumentException will be thrown.
          +
          +
          Parameters:
          +
          isAbsolute - should the resulting path must be absolute?
          +
          elements - the path elements to use.
          +
          +
          • +
        + + + +
          +
        • +

          Path

          +
          public Path(char separator,
+            boolean isAbsolute,
+            java.util.List<java.lang.String> elements)
          +
          Create a new Path using the given path separator, absoluteness, and elements. + + If elements is null or empty, the resulting Path is empty. The elements list may not contain null or + empty Strings, or Strings that contain the separator character. If they do, an IllegalArgumentException will be thrown.
          +
          +
          Parameters:
          +
          separator - the separator to use.
          +
          isAbsolute - should the resulting path should be absolute ?
          +
          elements - the path elements to use.
          +
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getFileName

          +
          public Path getFileName()
          +
          Get the file name or null if the Path is empty. + + The file name is the last element of the Path.
          +
          +
          Returns:
          +
          the resulting file name or null.
          +
          +
          • +
        + + + +
          +
        • +

          getFileNameAsString

          +
          public java.lang.String getFileNameAsString()
          +
          Get the file name as a String, or null if the Path is empty. + + The file name is the last element of the Path.
          +
          +
          Returns:
          +
          the resulting file name or null.
          +
          +
          • +
        + + + +
          +
        • +

          getSeparator

          +
          public char getSeparator()
          +
          Get the separator.
          +
          +
          Returns:
          +
          the separator.
          +
          +
          • +
        + + + +
          +
        • +

          getParent

          +
          public Path getParent()
          +
          Get the parent Path, or null if this Path does not have a parent. + + The parent path will contain all path elements in this pasth except the last one.
          +
          +
          Returns:
          +
          a Path representing this Paths parent.
          +
          +
          • +
        + + + +
          +
        • +

          getNameCount

          +
          public int getNameCount()
          +
          Get the number of elements in the Path.
          +
          +
          Returns:
          +
          the number of elements in the Path, or 0 if this path is empty.
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public Path getName(int index)
          +
          Get an element of this Path. Path elements indices start at 0.
          +
          +
          Parameters:
          +
          index - the index of the element
          +
          Returns:
          +
          the element at the specified index
          +
          Throws:
          +
          java.lang.IndexOutOfBoundsException - If the index is negative or greater or equal to the number of elements in the path.
          +
          +
          • +
        + + + +
          +
        • +

          subpath

          +
          public Path subpath(int beginIndex,
+                    int endIndex)
          +
          Returns a Path that is a subsequence of the name elements of this path. Path elements indices start at 0.
          +
          +
          Parameters:
          +
          beginIndex - the index of the first element, inclusive
          +
          endIndex - the index of the last element, exclusive
          +
          Returns:
          +
          a new Path that is a subsequence of the name elements in this path.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - If beginIndex is larger than or equal to the endIndex.
          +
          java.lang.ArrayIndexOutOfBoundsException - If beginIndex < 0 or beginIndex > elements.length
          +
          +
          • +
        + + + +
          +
        • +

          startsWith

          +
          public boolean startsWith(Path other)
          +
          Tests if this Path starts with the given Path. + + This method returns true if this Path starts with the same sequence of the name elements as the given Path. In addition, the absoluteness of + this Path should match the absoluteness of the given Path. + + False is returned if the given Path starts with a different sequence of elements, has more name elements than this path, or has a different absoluteness + than this path.
          +
          +
          Parameters:
          +
          other - the Path to compare to.
          +
          Returns:
          +
          If this Path start with the name elements in the other Path and has the same absoluteness.
          +
          +
          • +
        + + + +
          +
        • +

          endsWith

          +
          public boolean endsWith(Path other)
          +
          Tests if this Path ends with the given Path. + + This method returns true if this Path end with the name elements in the given Path. If the given Path has more name elements than this Path + then false is returned.
          +
          +
          Parameters:
          +
          other - the Path to compare to.
          +
          Returns:
          +
          If this Path ends with the name elements in the other Path.
          +
          +
          • +
        + + + +
          +
        • +

          startsWith

          +
          public boolean startsWith(java.lang.String other)
          +
          Tests if this Path starts with the given Path represented as a String. + + This method converts other into a Path using Path(String) and then uses startsWith(Path) to compare the + result to this Path.
          +
          +
          Parameters:
          +
          other - the path to test.
          +
          Returns:
          +
          If this Path start with the name elements in other.
          +
          +
          • +
        + + + +
          +
        • +

          endsWith

          +
          public boolean endsWith(java.lang.String other)
          +
          Tests if this Path ends with the given Path represented as a String. + + This method converts the other into a Path using Path(String) and then uses endsWith(Path) to compare the + result to this path.
          +
          +
          Parameters:
          +
          other - the path to test.
          +
          Returns:
          +
          If this Path ends with the elements in other.
          +
          +
          • +
        + + + +
          +
        • +

          resolve

          +
          public Path resolve(Path other)
          +
          Resolve a Path against this Path. + + Returns a new Path that concatenates the path elements of this Path with other. The resulting path will use the separator and absoluteness + of this path.
          +
          +
          Parameters:
          +
          other - the Path to concatenate with.
          +
          Returns:
          +
          concatenation of this Path with the other
          +
          +
          • +
        + + + +
          +
        • +

          resolve

          +
          public Path resolve(java.lang.String other)
          +
          Resolve a Path represented as a String against this path. + + Converts other into a Path using Path(char, String) and the separator of the this path. Next, resolve(Path) + is used to resolve the result against this path.
          +
          +
          Parameters:
          +
          other - the path to concatenate with.
          +
          Returns:
          +
          concatenation of this Path with the other
          +
          +
          • +
        + + + +
          +
        • +

          isEmpty

          +
          public boolean isEmpty()
          +
          Is this Path empty ?
          +
          +
          Returns:
          +
          If this Path is empty.
          +
          +
          • +
        + + + +
          +
        • +

          resolveSibling

          +
          public Path resolveSibling(Path other)
          +
          Resolves the given Path to this paths parent Path, thereby creating a sibling to this Path. + + If this Path is empty, other will be returned, unless other is null in which case an empty Path is returned. + + If this Path is not empty, but other is null or empty, the parent of this Path will be returned. + + If neither this Path and other are empty, getParent.resolve(other) will be returned.
          +
          +
          Parameters:
          +
          other - the Path to resolve as sibling.
          +
          Returns:
          +
          a Path representing the sibling.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - If the Path can not be resolved as a sibling to this Path.
          +
          +
          • +
        + + + +
          +
        • +

          relativize

          +
          public Path relativize(Path other)
          +
          Create a relative Path between the given Path and this Path. + + Relativation is the inverse of resolving. This method returns a Path that, when resolved against this Path, results in the given Path other.
          +
          +
          Parameters:
          +
          other - the Path to relativize.
          +
          Returns:
          +
          a Path representing a relative path between the given path and this path.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - If the path can not be relativized to this path.
          +
          +
          • +
        + + + +
          +
        • +

          iterator

          +
          public java.util.Iterator<Path> iterator()
          +
          Create an Iterator that returns all possible sub Paths of this Path, in order of increasing length. + + For example, for the Path "/a/b/c/d" the iterator returns "/a", "/a/b", "/a/b/c", "/a/b/c/d".
          +
          +
          Specified by:
          +
          iterator in interface java.lang.Iterable<Path>
          +
          Returns:
          +
          the iterator.
          +
          +
          • +
        + + + +
          +
        • +

          normalize

          +
          public Path normalize()
          +
          Normalize this Path by removing as many redundant path elements as possible. + + Redundant path elements are "." (indicating the current directory) and ".." (indicating the parent directory). + + Note that the resulting normalized path does may still contain ".." elements which are not redundant.
          +
          +
          Returns:
          +
          the normalize path.
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          isAbsolute

          +
          public boolean isAbsolute()
          +
          • +
        + + + +
          +
        • +

          toRelativePath

          +
          public Path toRelativePath()
          +
          • +
        + + + +
          +
        • +

          toAbsolutePath

          +
          public Path toAbsolutePath()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/PathAlreadyExistsException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/PathAlreadyExistsException.html new file mode 100644 index 000000000..b02f51fdd --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/PathAlreadyExistsException.html @@ -0,0 +1,292 @@ + + + + + +PathAlreadyExistsException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.filesystems
    +

    Class PathAlreadyExistsException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class PathAlreadyExistsException
+extends XenonException
      +
      Signals that a path already exists.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        PathAlreadyExistsException(java.lang.String adaptorName, + java.lang.String message) 
        PathAlreadyExistsException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PathAlreadyExistsException

          +
          public PathAlreadyExistsException(java.lang.String adaptorName,
+                                  java.lang.String message,
+                                  java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          PathAlreadyExistsException

          +
          public PathAlreadyExistsException(java.lang.String adaptorName,
+                                  java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/PathAttributes.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/PathAttributes.html new file mode 100644 index 000000000..1fe53bcd1 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/PathAttributes.html @@ -0,0 +1,543 @@ + + + + + +PathAttributes (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.filesystems
    +

    Interface PathAttributes

    +
    +
    +
    +
      +
    • +
      +
      +
      public interface PathAttributes
      +
      FileAttributes represents a set of attributes of a path.
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethod and Description
        longgetCreationTime() +
        Get the creation time for this file.
        +
        java.lang.StringgetGroup() +
        Get the group of this file (optional operation).
        +
        longgetLastAccessTime() +
        Get the last access time for this file.
        +
        longgetLastModifiedTime() +
        Get the last modified time for this file.
        +
        java.lang.StringgetOwner() +
        Get the owner of this file (optional operation).
        +
        PathgetPath() +
        Get the path these attributes belong to.
        +
        java.util.Set<PosixFilePermission>getPermissions() +
        Get the permissions of this file (optional operation).
        +
        longgetSize() +
        Get the size of this file in bytes.
        +
        booleanisDirectory() +
        Does the path refer to a directory ?
        +
        booleanisExecutable() +
        Does the path refer to an executable file ?
        +
        booleanisHidden() +
        Does the path refer to an hidden file ?
        +
        booleanisOther() +
        Is the path not a file, link or directory ?
        +
        booleanisReadable() +
        Does the path refer to an readable file ?
        +
        booleanisRegular() +
        Does the path refer to a regular file ?
        +
        booleanisSymbolicLink() +
        Does the path refer to a symbolic link ?
        +
        booleanisWritable() +
        Does the path refer to a writable file ?
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getPath

          +
          Path getPath()
          +
          Get the path these attributes belong to.
          +
          +
          Returns:
          +
          the path these attributes belong to.
          +
          +
          • +
        + + + +
          +
        • +

          isDirectory

          +
          boolean isDirectory()
          +
          Does the path refer to a directory ?
          +
          +
          Returns:
          +
          if the path refers to a directory.
          +
          +
          • +
        + + + +
          +
        • +

          isRegular

          +
          boolean isRegular()
          +
          Does the path refer to a regular file ?
          +
          +
          Returns:
          +
          if the path refers to a regular file.
          +
          +
          • +
        + + + +
          +
        • +

          isSymbolicLink

          +
          boolean isSymbolicLink()
          +
          Does the path refer to a symbolic link ?
          +
          +
          Returns:
          +
          if the path refers to a symbolic link.
          +
          +
          • +
        + + + +
          +
        • +

          isOther

          +
          boolean isOther()
          +
          Is the path not a file, link or directory ?
          +
          +
          Returns:
          +
          if the path does not refer to a file, link or directory.
          +
          +
          • +
        + + + +
          +
        • +

          isExecutable

          +
          boolean isExecutable()
          +
          Does the path refer to an executable file ?
          +
          +
          Returns:
          +
          if the path refers an executable file ?
          +
          +
          • +
        + + + +
          +
        • +

          isReadable

          +
          boolean isReadable()
          +
          Does the path refer to an readable file ?
          +
          +
          Returns:
          +
          if the path refers an readable file ?
          +
          +
          • +
        + + + +
          +
        • +

          isWritable

          +
          boolean isWritable()
          +
          Does the path refer to a writable file ?
          +
          +
          Returns:
          +
          if the path refers a writable file ?
          +
          +
          • +
        + + + +
          +
        • +

          isHidden

          +
          boolean isHidden()
          +
          Does the path refer to an hidden file ?
          +
          +
          Returns:
          +
          if the path refers an hidden file ?
          +
          +
          • +
        + + + +
          +
        • +

          getCreationTime

          +
          long getCreationTime()
          +
          Get the creation time for this file. + + If creationTime is not supported by the adaptor, getLastModifiedTime() will be returned instead.
          +
          +
          Returns:
          +
          the creation time for this file.
          +
          +
          • +
        + + + +
          +
        • +

          getLastAccessTime

          +
          long getLastAccessTime()
          +
          Get the last access time for this file. + + If lastAccessTime is not supported by the adaptor, use getLastModifiedTime() will be returned instead.
          +
          +
          Returns:
          +
          the last access time for this file.
          +
          +
          • +
        + + + +
          +
        • +

          getLastModifiedTime

          +
          long getLastModifiedTime()
          +
          Get the last modified time for this file. + + If lastModifiedTime is not supported by the adaptor, 0 will be returned instead.
          +
          +
          Returns:
          +
          the last modified time for this file.
          +
          +
          • +
        + + + +
          +
        • +

          getSize

          +
          long getSize()
          +
          Get the size of this file in bytes. + + If the file is not a regular file, 0 will be returned.
          +
          +
          Returns:
          +
          the size of this file.
          +
          +
          • +
        + + + + + + + + + + + + +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/PosixFilePermission.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/PosixFilePermission.html new file mode 100644 index 000000000..2ac6ff005 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/PosixFilePermission.html @@ -0,0 +1,481 @@ + + + + + +PosixFilePermission (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.filesystems
    +

    Enum PosixFilePermission

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<PosixFilePermission>
        • +
      • +
          +
        • nl.esciencecenter.xenon.filesystems.PosixFilePermission
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<PosixFilePermission>
      +
      +
      +
      +
      public enum PosixFilePermission
+extends java.lang.Enum<PosixFilePermission>
      +
      PosixFilePermission is an enumeration containing all supported Posix file permissions.
      +
      +
      Since:
      +
      1.0
      +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethod and Description
        static booleancontains(PosixFilePermission toFind, + PosixFilePermission... options) +
        Check if a sequence of PosixFilePermissions contains a specific option.
        +
        static PosixFilePermissionvalueOf(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static PosixFilePermission[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static PosixFilePermission[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (PosixFilePermission c : PosixFilePermission.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static PosixFilePermission valueOf(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          contains

          +
          public static boolean contains(PosixFilePermission toFind,
+                               PosixFilePermission... options)
          +
          Check if a sequence of PosixFilePermissions contains a specific option. + + If option or options is null, false will be returned.
          +
          +
          Parameters:
          +
          toFind - the option to find.
          +
          options - the options to check.
          +
          Returns:
          +
          if options contains option.
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/package-frame.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/package-frame.html new file mode 100644 index 000000000..3e7c70db8 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/package-frame.html @@ -0,0 +1,44 @@ + + + + + +nl.esciencecenter.xenon.filesystems (xenon-2.3.0 2.6.1 API) + + + + +

    nl.esciencecenter.xenon.filesystems

    +
    +

    Interfaces

    + +

    Classes

    + +

    Enums

    + +

    Exceptions

    + +
    + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/package-summary.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/package-summary.html new file mode 100644 index 000000000..5de500075 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/package-summary.html @@ -0,0 +1,275 @@ + + + + + +nl.esciencecenter.xenon.filesystems (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Package nl.esciencecenter.xenon.filesystems

    +
    +
    This package contains classes and interfaces for manipulating files.
    +
    +

    See: Description

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      CopyStatus +
      CopyStatus contains status information for a specific copy operation.
      +
      FileSystemAdaptorDescription 
      PathAttributes +
      FileAttributes represents a set of attributes of a path.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      FileSystem +
      FileSystem represent a (possibly remote) file system that can be used to access data.
      +
      Path +
      Path contains a sequence of path elements separated by a separator.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      CopyMode +
      CopyOption is an enumeration containing all possible options for copying a file.
      +
      PosixFilePermission +
      PosixFilePermission is an enumeration containing all supported Posix file permissions.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Exception Summary 
      ExceptionDescription
      AttributeNotSupportedException +
      Signals that a requested file attribute is not supported by the underlying file system implementation.
      +
      CopyCancelledException 
      DirectoryNotEmptyException +
      Signals that directory is not empty.
      +
      FileSystemClosedException +
      Signals that a unknown Copy handle was provided.
      +
      InvalidOptionsException +
      Signals that an invalid combination of OpenOptions have been specified.
      +
      InvalidPathException +
      Signals that an end-of-file was encountered.
      +
      InvalidResumeTargetException +
      Signals that the data in the target of a resume does not match the data in the source.
      +
      NoSuchCopyException +
      Signals that a unknown Copy handle was provided.
      +
      NoSuchPathException +
      Signals that a path does not exists.
      +
      PathAlreadyExistsException +
      Signals that a path already exists.
      +
      +
      • +
    + + + +

    Package nl.esciencecenter.xenon.filesystems Description

    +
    This package contains classes and interfaces for manipulating files.
    +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/package-tree.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/package-tree.html new file mode 100644 index 000000000..50e9e4c35 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/filesystems/package-tree.html @@ -0,0 +1,180 @@ + + + + + +nl.esciencecenter.xenon.filesystems Class Hierarchy (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Hierarchy For Package nl.esciencecenter.xenon.filesystems

    +Package Hierarchies: + +
    +
    +

    Class Hierarchy

    + +

    Interface Hierarchy

    + +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/package-frame.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/package-frame.html new file mode 100644 index 000000000..0585b5385 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/package-frame.html @@ -0,0 +1,39 @@ + + + + + +nl.esciencecenter.xenon (xenon-2.3.0 2.6.1 API) + + + + +

    nl.esciencecenter.xenon

    +
    +

    Interfaces

    + +

    Classes

    + +

    Enums

    + +

    Exceptions

    + +
    + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/package-summary.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/package-summary.html new file mode 100644 index 000000000..e996630fc --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/package-summary.html @@ -0,0 +1,249 @@ + + + + + +nl.esciencecenter.xenon (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Package nl.esciencecenter.xenon

    +
    +
    This package is the main entry point into the Xenon API.
    +
    +

    See: Description

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      AdaptorDescription +
      AdaptorStatus contains information on a specific adaptor.
      +
      +
      • +
    • + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      XenonPropertyDescription +
      XenonPropertyDescription contains all necessary information about a property that is recognized by Xenon
      +
      +
      • +
    • + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      XenonPropertyDescription.Type +
      This Type enumeration lists all possible types of properties recognized by Xenon.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Exception Summary 
      ExceptionDescription
      InvalidCredentialException +
      Signals that an invalid credential was used to access a resource.
      +
      InvalidLocationException +
      Signals that an invalid location was provided.
      +
      InvalidPropertyException +
      Signals that a property has a different type than the get method it was retrieved with.
      +
      PropertyTypeException +
      Signals that a property has a different type than the get method it was retrieved with.
      +
      UnknownAdaptorException +
      Thrown when an unknown adaptor name is provided.
      +
      UnknownPropertyException +
      Signals that a property has a different type than the get method it was retrieved with.
      +
      UnsupportedOperationException +
      Throw when an unsupported optional operation is called.
      +
      XenonException +
      XenonException is the parent exception for all exceptions raised in Xenon.
      +
      XenonRuntimeException +
      XenonRuntimeException is the parent for all runtime exceptions raised in Xenon.
      +
      +
      • +
    + + + +

    Package nl.esciencecenter.xenon Description

    +
    This package is the main entry point into the Xenon API.
    +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/package-tree.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/package-tree.html new file mode 100644 index 000000000..54cc84e47 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/package-tree.html @@ -0,0 +1,174 @@ + + + + + +nl.esciencecenter.xenon Class Hierarchy (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Hierarchy For Package nl.esciencecenter.xenon

    +Package Hierarchies: + +
    +
    +

    Class Hierarchy

    + +

    Interface Hierarchy

    + +

    Enum Hierarchy

    +
      +
    • java.lang.Object + +
      • +
    +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/IncompleteJobDescriptionException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/IncompleteJobDescriptionException.html new file mode 100644 index 000000000..e0662127b --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/IncompleteJobDescriptionException.html @@ -0,0 +1,292 @@ + + + + + +IncompleteJobDescriptionException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.schedulers
    +

    Class IncompleteJobDescriptionException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class IncompleteJobDescriptionException
+extends XenonException
      +
      Signals that a JobDescription is missing required options.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          IncompleteJobDescriptionException

          +
          public IncompleteJobDescriptionException(java.lang.String adaptorName,
+                                         java.lang.String message,
+                                         java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          IncompleteJobDescriptionException

          +
          public IncompleteJobDescriptionException(java.lang.String adaptorName,
+                                         java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/InvalidJobDescriptionException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/InvalidJobDescriptionException.html new file mode 100644 index 000000000..e2771fba2 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/InvalidJobDescriptionException.html @@ -0,0 +1,292 @@ + + + + + +InvalidJobDescriptionException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.schedulers
    +

    Class InvalidJobDescriptionException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class InvalidJobDescriptionException
+extends XenonException
      +
      Signals that a JobDescription contains invalid values for certain options.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InvalidJobDescriptionException

          +
          public InvalidJobDescriptionException(java.lang.String adaptorName,
+                                      java.lang.String message,
+                                      java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          InvalidJobDescriptionException

          +
          public InvalidJobDescriptionException(java.lang.String adaptorName,
+                                      java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/JobDescription.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/JobDescription.html new file mode 100644 index 000000000..af7b68658 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/JobDescription.html @@ -0,0 +1,1173 @@ + + + + + +JobDescription (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.schedulers
    +

    Class JobDescription

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • nl.esciencecenter.xenon.schedulers.JobDescription
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Direct Known Subclasses:
      +
      JavaJobDescription
      +
      +
      +
      +
      public class JobDescription
+extends java.lang.Object
      +
      JobDescription contains a description of a job that can be submitted to a Scheduler.
      +
      +
      Since:
      +
      1.0
      +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        JobDescription() +
        Create a JobDescription.
        +
        JobDescription(JobDescription original) +
        Create a JobDescription by copying an existing one.
        +
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        voidaddArgument(java.lang.String argument) +
        Add a command line argument for the executable.
        +
        voidaddEnvironment(java.lang.String key, + java.lang.String value) +
        Add a variable to the environment of the executable.
        +
        voidaddJobOption(java.lang.String key, + java.lang.String value) +
        Add a job option to the job.
        +
        voidaddSchedulerArgument(java.lang.String argument) +
        Add a scheduler specific argument.
        +
        booleanequals(java.lang.Object obj) 
        java.util.List<java.lang.String>getArguments() +
        Get the command line arguments of the executable.
        +
        java.util.Map<java.lang.String,java.lang.String>getEnvironment() +
        Get the environment of the executable.
        +
        java.lang.StringgetExecutable() +
        Get the path to the executable.
        +
        java.util.Map<java.lang.String,java.lang.String>getJobOptions() +
        Get a copy of the job options of this job.
        +
        intgetMaxMemory() +
        Get the amount of memory needed for process (in MBytes).
        +
        intgetMaxRuntime() +
        Get the maximum job duration time in minutes.
        +
        java.lang.StringgetName() +
        Get the job name.
        +
        intgetNodeCount() +
        Get the number of nodes.
        +
        intgetProcessesPerNode() +
        Get the number of processes to start on each node.
        +
        java.lang.StringgetQueueName() +
        Get the queue name;
        +
        java.util.List<java.lang.String>getSchedulerArguments() +
        Get the scheduler specific arguments.
        +
        java.lang.StringgetStderr() +
        Gets the path to the file to which the executable must redirect stderr.
        +
        java.lang.StringgetStdin() +
        Gets the path to the file from which the executable must redirect stdin.
        +
        java.lang.StringgetStdout() +
        Gets the path to the file to which the executable must redirect stdout.
        +
        intgetThreadsPerProcess() +
        Get the number of threads needed per process.
        +
        java.lang.StringgetWorkingDirectory() +
        Gets the path of the working directory for the executable.
        +
        inthashCode() 
        booleanisStartSingleProcess() +
        Is only a single process started?
        +
        voidsetArguments(java.lang.String... arguments) +
        Sets the command line arguments of the executable.
        +
        voidsetEnvironment(java.util.Map<java.lang.String,java.lang.String> environment) +
        Sets the environment of the executable.
        +
        voidsetExecutable(java.lang.String executable) +
        Sets the path to the executable.
        +
        voidsetJobOptions(java.util.Map<java.lang.String,java.lang.String> options) +
        Sets the job options of the job.
        +
        voidsetMaxMemory(int maxMemoryInMB) +
        Set the amount of memory needed for process (in MBytes).
        +
        voidsetMaxRuntime(int minutes) +
        Set the maximum job duration in minutes.
        +
        voidsetName(java.lang.String name) +
        Set the name of the job.
        +
        voidsetNodeCount(int nodeCount) +
        Set the number of nodes.
        +
        voidsetProcessesPerNode(int processesPerNode) +
        Set the number of processes started on each node.
        +
        voidsetQueueName(java.lang.String queueName) +
        Set the queue name;
        +
        voidsetSchedulerArguments(java.lang.String... arguments) +
        Sets the scheduler specific arguments for this job.
        +
        voidsetStartSingleProcess(boolean startSingleProcess) +
        Set if only a single process is started, instead of nodeCount * processesPerNode.
        +
        voidsetStderr(java.lang.String stderr) +
        Sets the path to the file to which the executable must redirect stderr.
        +
        voidsetStdin(java.lang.String stdin) +
        Sets the path to the file from which the executable must redirect stdin.
        +
        voidsetStdout(java.lang.String stdout) +
        Sets the path to the file to which the executable must redirect stdout.
        +
        voidsetThreadsPerProcess(int threadsPerProcess) +
        Set the number of threads needed per process.
        +
        voidsetWorkingDirectory(java.lang.String workingDirectory) +
        Sets the path of the working directory for the executable.
        +
        java.lang.StringtoString() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          DEFAULT_MAX_RUN_TIME_IN_MINUTES

          +
          public static final int DEFAULT_MAX_RUN_TIME_IN_MINUTES
          +
          The default maximum run time
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          JobDescription

          +
          public JobDescription()
          +
          Create a JobDescription.
          +
          • +
        + + + +
          +
        • +

          JobDescription

          +
          public JobDescription(JobDescription original)
          +
          Create a JobDescription by copying an existing one.
          +
          +
          Parameters:
          +
          original - JobDescription to copy
          +
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Get the job name.
          +
          +
          Returns:
          +
          the job name.
          +
          +
          • +
        + + + +
          +
        • +

          setName

          +
          public void setName(java.lang.String name)
          +
          Set the name of the job.
          +
          +
          Parameters:
          +
          name - the name of the job;
          +
          +
          • +
        + + + +
          +
        • +

          getNodeCount

          +
          public int getNodeCount()
          +
          Get the number of nodes.
          +
          +
          Returns:
          +
          the number of nodes.
          +
          +
          • +
        + + + +
          +
        • +

          setNodeCount

          +
          public void setNodeCount(int nodeCount)
          +
          Set the number of nodes.
          +
          +
          Parameters:
          +
          nodeCount - the number of nodes;
          +
          +
          • +
        + + + +
          +
        • +

          getProcessesPerNode

          +
          public int getProcessesPerNode()
          +
          Get the number of processes to start on each node.
          +
          +
          Returns:
          +
          the number of processesPerNode.
          +
          +
          • +
        + + + +
          +
        • +

          setProcessesPerNode

          +
          public void setProcessesPerNode(int processesPerNode)
          +
          Set the number of processes started on each node.
          +
          +
          Parameters:
          +
          processesPerNode - the number of processes started on each node.
          +
          +
          • +
        + + + +
          +
        • +

          getThreadsPerProcess

          +
          public int getThreadsPerProcess()
          +
          Get the number of threads needed per process.
          +
          +
          Returns:
          +
          the number of threads per process.
          +
          +
          • +
        + + + +
          +
        • +

          setThreadsPerProcess

          +
          public void setThreadsPerProcess(int threadsPerProcess)
          +
          Set the number of threads needed per process.
          +
          +
          Parameters:
          +
          threadsPerProcess - the number of threads needed per process.
          +
          +
          • +
        + + + +
          +
        • +

          getMaxMemory

          +
          public int getMaxMemory()
          +
          Get the amount of memory needed for process (in MBytes).
          +
          +
          Returns:
          +
          the amount of memory needed.
          +
          +
          • +
        + + + +
          +
        • +

          setMaxMemory

          +
          public void setMaxMemory(int maxMemoryInMB)
          +
          Set the amount of memory needed for process (in MBytes).
          +
          +
          Parameters:
          +
          maxMemoryInMB - the amount of memory needed per node/process.
          +
          +
          • +
        + + + +
          +
        • +

          isStartSingleProcess

          +
          public boolean isStartSingleProcess()
          +
          Is only a single process started?
          +
          +
          Returns:
          +
          if only a single process is started.
          +
          +
          • +
        + + + +
          +
        • +

          setStartSingleProcess

          +
          public void setStartSingleProcess(boolean startSingleProcess)
          +
          Set if only a single process is started, instead of nodeCount * processesPerNode. Resources are still reserved, but it is up to the user to start all the + processes. Mainly useful for MPI.
          +
          +
          Parameters:
          +
          startSingleProcess - if only a single process is started.
          +
          +
          • +
        + + + +
          +
        • +

          getQueueName

          +
          public java.lang.String getQueueName()
          +
          Get the queue name;
          +
          +
          Returns:
          +
          the queue name;
          +
          +
          • +
        + + + +
          +
        • +

          setQueueName

          +
          public void setQueueName(java.lang.String queueName)
          +
          Set the queue name;
          +
          +
          Parameters:
          +
          queueName - the queue name;
          +
          +
          • +
        + + + +
          +
        • +

          getMaxRuntime

          +
          public int getMaxRuntime()
          +
          Get the maximum job duration time in minutes.
          +
          +
          Returns:
          +
          the maximum job duration.
          +
          +
          • +
        + + + +
          +
        • +

          setMaxRuntime

          +
          public void setMaxRuntime(int minutes)
          +
          Set the maximum job duration in minutes.
          +
          +
          Parameters:
          +
          minutes - the maximum job duration in minutes.
          +
          +
          • +
        + + + +
          +
        • +

          getExecutable

          +
          public java.lang.String getExecutable()
          +
          Get the path to the executable.
          +
          +
          Returns:
          +
          the path to the executable.
          +
          +
          • +
        + + + +
          +
        • +

          setExecutable

          +
          public void setExecutable(java.lang.String executable)
          +
          Sets the path to the executable.
          +
          +
          Parameters:
          +
          executable - the path to the executable.
          +
          +
          • +
        + + + +
          +
        • +

          getArguments

          +
          public java.util.List<java.lang.String> getArguments()
          +
          Get the command line arguments of the executable.
          +
          +
          Returns:
          +
          Returns the arguments of the executable.
          +
          +
          • +
        + + + +
          +
        • +

          setArguments

          +
          public void setArguments(java.lang.String... arguments)
          +
          Sets the command line arguments of the executable.
          +
          +
          Parameters:
          +
          arguments - the command line arguments of the executable.
          +
          +
          • +
        + + + +
          +
        • +

          addArgument

          +
          public void addArgument(java.lang.String argument)
          +
          Add a command line argument for the executable. + + The argument may not be null or empty.
          +
          +
          Parameters:
          +
          argument - the command line argument to add.
          +
          +
          • +
        + + + +
          +
        • +

          getSchedulerArguments

          +
          public java.util.List<java.lang.String> getSchedulerArguments()
          +
          Get the scheduler specific arguments.
          +
          +
          Returns:
          +
          Returns the scheduler specific arguments.
          +
          +
          • +
        + + + +
          +
        • +

          setSchedulerArguments

          +
          public void setSchedulerArguments(java.lang.String... arguments)
          +
          Sets the scheduler specific arguments for this job. + + Some jobs require extra arguments to be provided to the scheduler, for example to select a certain type of node. These arguments tend to be very + scheduler and location specific and are therefore hard to generalize. + + This method provides a simple mechanism to add such arguments to a JobDescription. These arguments are typically copied into the scheduler specific + section of a generated submit script.
          +
          +
          Parameters:
          +
          arguments - the scheduler specific arguments.
          +
          +
          • +
        + + + +
          +
        • +

          addSchedulerArgument

          +
          public void addSchedulerArgument(java.lang.String argument)
          +
          Add a scheduler specific argument. + + The argument may not be null or empty.
          +
          +
          Parameters:
          +
          argument - the scheduler specific argument.
          +
          +
          • +
        + + + +
          +
        • +

          getEnvironment

          +
          public java.util.Map<java.lang.String,java.lang.String> getEnvironment()
          +
          Get the environment of the executable. + + The environment of the executable consists of a Map of environment variables with their values (for example: "JAVA_HOME", "/path/to/java").
          +
          +
          Returns:
          +
          the environment of the executable.
          +
          +
          • +
        + + + +
          +
        • +

          setEnvironment

          +
          public void setEnvironment(java.util.Map<java.lang.String,java.lang.String> environment)
          +
          Sets the environment of the executable. + + The environment of the executable consists of a Map of environment variables with their values (for example: "JAVA_HOME", "/path/to/java").
          +
          +
          Parameters:
          +
          environment - environment of the executable.
          +
          +
          • +
        + + + +
          +
        • +

          addEnvironment

          +
          public void addEnvironment(java.lang.String key,
+                           java.lang.String value)
          +
          Add a variable to the environment of the executable. + + The environment of the executable consists of a Map of environment variables with their values (for example: "JAVA_HOME", "/path/to/java"). + + The key of an environment variable may not be null or empty.
          +
          +
          Parameters:
          +
          key - the unique key under which to store the value.
          +
          value - the value to store the value.
          +
          +
          • +
        + + + +
          +
        • +

          getJobOptions

          +
          public java.util.Map<java.lang.String,java.lang.String> getJobOptions()
          +
          Get a copy of the job options of this job. + + The job options consist of a Map of options variables with their values (for example: "PE", "MPI").
          +
          +
          Returns:
          +
          the job options of the job.
          +
          +
          • +
        + + + +
          +
        • +

          setJobOptions

          +
          public void setJobOptions(java.util.Map<java.lang.String,java.lang.String> options)
          +
          Sets the job options of the job. + + The job options consist of a Map of options variables with their values (for example: "PE", "MPI").
          +
          +
          Parameters:
          +
          options - job options of the job.
          +
          +
          • +
        + + + +
          +
        • +

          addJobOption

          +
          public void addJobOption(java.lang.String key,
+                         java.lang.String value)
          +
          Add a job option to the job. + + The job option consist of a key-value pair (for example: "PE", "MPI"). + + Neither the key or value of a job option may be null or empty.
          +
          +
          Parameters:
          +
          key - the unique key under which to store the job option.
          +
          value - the value of the option to store.
          +
          +
          • +
        + + + +
          +
        • +

          setStdin

          +
          public void setStdin(java.lang.String stdin)
          +
          Sets the path to the file from which the executable must redirect stdin.
          +
          +
          Parameters:
          +
          stdin - the path.
          +
          +
          • +
        + + + +
          +
        • +

          setStdout

          +
          public void setStdout(java.lang.String stdout)
          +
          Sets the path to the file to which the executable must redirect stdout.
          +
          +
          Parameters:
          +
          stdout - the path.
          +
          +
          • +
        + + + +
          +
        • +

          setStderr

          +
          public void setStderr(java.lang.String stderr)
          +
          Sets the path to the file to which the executable must redirect stderr.
          +
          +
          Parameters:
          +
          stderr - the path.
          +
          +
          • +
        + + + +
          +
        • +

          setWorkingDirectory

          +
          public void setWorkingDirectory(java.lang.String workingDirectory)
          +
          Sets the path of the working directory for the executable.
          +
          +
          Parameters:
          +
          workingDirectory - path of the working directory.
          +
          +
          • +
        + + + +
          +
        • +

          getStdin

          +
          public java.lang.String getStdin()
          +
          Gets the path to the file from which the executable must redirect stdin.
          +
          +
          Returns:
          +
          the path.
          +
          +
          • +
        + + + +
          +
        • +

          getStdout

          +
          public java.lang.String getStdout()
          +
          Gets the path to the file to which the executable must redirect stdout.
          +
          +
          Returns:
          +
          the path.
          +
          +
          • +
        + + + +
          +
        • +

          getStderr

          +
          public java.lang.String getStderr()
          +
          Gets the path to the file to which the executable must redirect stderr.
          +
          +
          Returns:
          +
          the path.
          +
          +
          • +
        + + + +
          +
        • +

          getWorkingDirectory

          +
          public java.lang.String getWorkingDirectory()
          +
          Gets the path of the working directory for the executable.
          +
          +
          Returns:
          +
          workingDirectory path of the working directory.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/JobStatus.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/JobStatus.html new file mode 100644 index 000000000..ff02e0d8a --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/JobStatus.html @@ -0,0 +1,415 @@ + + + + + +JobStatus (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.schedulers
    +

    Interface JobStatus

    +
    +
    +
    +
      +
    • +
      +
      +
      public interface JobStatus
      +
      JobStatus contains status information for a specific job.
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethod and Description
        XenonExceptiongetException() +
        Get the exception produced by the Job or while retrieving the status.
        +
        java.lang.IntegergetExitCode() +
        Get the exit code for the Job.
        +
        java.lang.StringgetJobIdentifier() +
        Get the job identifier of the Job for which this JobStatus was created.
        +
        java.lang.StringgetName() +
        Get the name of the Job for which this JobStatus was created.
        +
        java.util.Map<java.lang.String,java.lang.String>getSchedulerSpecificInformation() +
        Get scheduler specific information on the Job.
        +
        java.lang.StringgetState() +
        Get the state of the Job.
        +
        booleanhasException() +
        Has the Job or job retrieval produced a exception ?
        +
        booleanisDone() +
        Is the Job done.
        +
        booleanisRunning() +
        Is the Job running.
        +
        voidmaybeThrowException() +
        Throws the exception produced by the Job or while retrieving the status, if it exists.
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getJobIdentifier

          +
          java.lang.String getJobIdentifier()
          +
          Get the job identifier of the Job for which this JobStatus was created.
          +
          +
          Returns:
          +
          the identifier of the Job.
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          java.lang.String getName()
          +
          Get the name of the Job for which this JobStatus was created.
          +
          +
          Returns:
          +
          the name of the Job.
          +
          +
          • +
        + + + +
          +
        • +

          getState

          +
          java.lang.String getState()
          +
          Get the state of the Job. + + The state is a scheduler specific string, generally intended to be human readable. Very different state strings can be returned depending on which + scheduler is used. Therefore, this method should only be used to provide feedback to the user. To programmatically inspect the state of the job use + {isRunning(), isDone() or hasException() instead.
          +
          +
          Returns:
          +
          the state of the Job.
          +
          +
          • +
        + + + +
          +
        • +

          getExitCode

          +
          java.lang.Integer getExitCode()
          +
          Get the exit code for the Job.
          +
          +
          Returns:
          +
          the exit code for the Job.
          +
          +
          • +
        + + + +
          +
        • +

          getException

          +
          XenonException getException()
          +
          Get the exception produced by the Job or while retrieving the status. If no exception occurred, null will be returned. + + See maybeThrowException() for the possible exceptions.
          +
          +
          Returns:
          +
          the exception.
          +
          +
          • +
        + + + +
          +
        • +

          maybeThrowException

          +
          void maybeThrowException()
+                  throws XenonException
          +
          Throws the exception produced by the Job or while retrieving the status, if it exists. Otherwise continue.
          +
          +
          Throws:
          +
          nl.esciencecenter.xenon.adaptors.schedulers.JobCanceledException - if the job was cancelled
          +
          NoSuchJobException - if the job of which the status was requested does not exist
          +
          XenonException - if an I/O error occurred.
          +
          +
          • +
        + + + +
          +
        • +

          isRunning

          +
          boolean isRunning()
          +
          Is the Job running.
          +
          +
          Returns:
          +
          if the Job is running.
          +
          +
          • +
        + + + +
          +
        • +

          isDone

          +
          boolean isDone()
          +
          Is the Job done.
          +
          +
          Returns:
          +
          if the Job is done.
          +
          +
          • +
        + + + +
          +
        • +

          hasException

          +
          boolean hasException()
          +
          Has the Job or job retrieval produced a exception ?
          +
          +
          Returns:
          +
          if the Job has an exception.
          +
          +
          • +
        + + + +
          +
        • +

          getSchedulerSpecificInformation

          +
          java.util.Map<java.lang.String,java.lang.String> getSchedulerSpecificInformation()
          +
          Get scheduler specific information on the Job.
          +
          +
          Returns:
          +
          scheduler specific information on the Job.
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/NoSuchJobException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/NoSuchJobException.html new file mode 100644 index 000000000..5a6dd07d4 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/NoSuchJobException.html @@ -0,0 +1,292 @@ + + + + + +NoSuchJobException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.schedulers
    +

    Class NoSuchJobException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class NoSuchJobException
+extends XenonException
      +
      Signals that a Job was not found.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        NoSuchJobException(java.lang.String adaptorName, + java.lang.String message) 
        NoSuchJobException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          NoSuchJobException

          +
          public NoSuchJobException(java.lang.String adaptorName,
+                          java.lang.String message,
+                          java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          NoSuchJobException

          +
          public NoSuchJobException(java.lang.String adaptorName,
+                          java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/NoSuchQueueException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/NoSuchQueueException.html new file mode 100644 index 000000000..30df9deb8 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/NoSuchQueueException.html @@ -0,0 +1,292 @@ + + + + + +NoSuchQueueException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.schedulers
    +

    Class NoSuchQueueException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class NoSuchQueueException
+extends XenonException
      +
      Signals that a unknown queue was provided.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        NoSuchQueueException(java.lang.String adaptorName, + java.lang.String message) 
        NoSuchQueueException(java.lang.String adaptorName, + java.lang.String message, + java.lang.Throwable t) 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          NoSuchQueueException

          +
          public NoSuchQueueException(java.lang.String adaptorName,
+                            java.lang.String message,
+                            java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          NoSuchQueueException

          +
          public NoSuchQueueException(java.lang.String adaptorName,
+                            java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/QueueStatus.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/QueueStatus.html new file mode 100644 index 000000000..5484584e7 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/QueueStatus.html @@ -0,0 +1,330 @@ + + + + + +QueueStatus (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.schedulers
    +

    Interface QueueStatus

    +
    +
    +
    +
      +
    • +
      +
      +
      public interface QueueStatus
      +
      QueueStatus contains status information for a specific queue.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getScheduler

          +
          Scheduler getScheduler()
          +
          Get the Scheduler that produced this QueueStatus.
          +
          +
          Returns:
          +
          the Scheduler.
          +
          +
          • +
        + + + +
          +
        • +

          getQueueName

          +
          java.lang.String getQueueName()
          +
          Get the queue name.
          +
          +
          Returns:
          +
          the queue name.
          +
          +
          • +
        + + + +
          +
        • +

          hasException

          +
          boolean hasException()
          +
          Did the queue produce an exception ?
          +
          +
          Returns:
          +
          if the queue produced an exception ?
          +
          +
          • +
        + + + +
          +
        • +

          getException

          +
          XenonException getException()
          +
          Get the exception produced by the queue, or null if hasException() returns false. + + See maybeThrowException() for the possible exceptions.
          +
          +
          Returns:
          +
          the exception.
          +
          +
          • +
        + + + +
          +
        • +

          maybeThrowException

          +
          void maybeThrowException()
+                  throws XenonException
          +
          Throws the exception produced by the queue if it exists. Otherwise continue.
          +
          +
          Throws:
          +
          NoSuchQueueException - if the requested queue does not exist
          +
          XenonException - if an I/O error occurred.
          +
          +
          • +
        + + + +
          +
        • +

          getSchedulerSpecificInformation

          +
          java.util.Map<java.lang.String,java.lang.String> getSchedulerSpecificInformation()
          +
          Get scheduler specific information on the queue.
          +
          +
          Returns:
          +
          Scheduler specific information on the queue.
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/Scheduler.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/Scheduler.html new file mode 100644 index 000000000..2a8765b33 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/Scheduler.html @@ -0,0 +1,1010 @@ + + + + + +Scheduler (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.schedulers
    +

    Class Scheduler

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • nl.esciencecenter.xenon.schedulers.Scheduler
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.lang.AutoCloseable
      +
      +
      +
      +
      public abstract class Scheduler
+extends java.lang.Object
+implements java.lang.AutoCloseable
      +
      Scheduler represents a (possibly remote) scheduler that can be used to submit jobs and retrieve queue information.
      +
      +
      Since:
      +
      1.0
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethod and Description
        abstract JobStatuscancelJob(java.lang.String jobIdentifier) +
        Cancel a job.
        +
        abstract voidclose() +
        Close this Scheduler.
        +
        static Schedulercreate(java.lang.String adaptor) +
        Create a new Scheduler using the adaptor connecting to the default location and using the default credentials to get access.
        +
        static Schedulercreate(java.lang.String adaptor, + java.lang.String location) +
        Create a new Scheduler using the adaptor connecting to the location using the default credentials to get access.
        +
        static Schedulercreate(java.lang.String adaptor, + java.lang.String location, + Credential credential) +
        Create a new Scheduler using the adaptor connecting to the location using credentials to get access.
        +
        static Schedulercreate(java.lang.String adaptor, + java.lang.String location, + Credential credential, + java.util.Map<java.lang.String,java.lang.String> properties) +
        Create a new Scheduler using the adaptor connecting to the location using credentials to get access.
        +
        booleanequals(java.lang.Object o) 
        static SchedulerAdaptorDescriptiongetAdaptorDescription(java.lang.String adaptorName) +
        Gives the description of the adaptor with the given name.
        +
        static SchedulerAdaptorDescription[]getAdaptorDescriptions() +
        Gives a list of the descriptions of the available adaptors.
        +
        java.lang.StringgetAdaptorName() +
        Get the name of the adaptor that created this Scheduler.
        +
        static java.lang.String[]getAdaptorNames() +
        Gives a list names of the available adaptors.
        +
        CredentialgetCredential() +
        Get the credential that this Scheduler is using.
        +
        abstract java.lang.StringgetDefaultQueueName() +
        Get the name of the default queue.
        +
        abstract FileSystemgetFileSystem() +
        Retrieve the FileSystem used internally by this Scheduler.
        +
        abstract java.lang.String[]getJobs(java.lang.String... queueNames) +
        Get all job identifier of jobs currently in (one ore more) queues.
        +
        abstract JobStatusgetJobStatus(java.lang.String jobIdentifier) +
        Get the status of a Job.
        +
        JobStatus[]getJobStatuses(java.lang.String... jobIdentifiers) +
        Get the status of all specified jobs.
        +
        java.lang.StringgetLocation() +
        Get the location that this Scheduler is connected to.
        +
        java.util.Map<java.lang.String,java.lang.String>getProperties() +
        Get the properties used to create this Scheduler.
        +
        abstract java.lang.String[]getQueueNames() +
        Get the queue names supported by this Scheduler.
        +
        abstract QueueStatusgetQueueStatus(java.lang.String queueName) +
        Get the status of the queue.
        +
        abstract QueueStatus[]getQueueStatuses(java.lang.String... queueNames) +
        Get the status of all queues.
        +
        inthashCode() 
        abstract booleanisOpen() +
        Test if the connection of this Scheduler is open.
        +
        abstract java.lang.StringsubmitBatchJob(JobDescription description) +
        Submit a batch job.
        +
        abstract StreamssubmitInteractiveJob(JobDescription description) +
        Submit an interactive job (optional operation).
        +
        abstract JobStatuswaitUntilDone(java.lang.String jobIdentifier, + long timeout) +
        Wait until a job is done or until a timeout expires.
        +
        abstract JobStatuswaitUntilRunning(java.lang.String jobIdentifier, + long timeout) +
        Wait until a job starts running, or until a timeout expires.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getAdaptorNames

          +
          public static java.lang.String[] getAdaptorNames()
          +
          Gives a list names of the available adaptors.
          +
          +
          Returns:
          +
          the list
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getAdaptorDescriptions

          +
          public static SchedulerAdaptorDescription[] getAdaptorDescriptions()
          +
          Gives a list of the descriptions of the available adaptors.
          +
          +
          Returns:
          +
          the list
          +
          +
          • +
        + + + +
          +
        • +

          create

          +
          public static Scheduler create(java.lang.String adaptor,
+                               java.lang.String location,
+                               Credential credential,
+                               java.util.Map<java.lang.String,java.lang.String> properties)
+                        throws XenonException
          +
          Create a new Scheduler using the adaptor connecting to the location using credentials to get access. Use + properties to (optionally) configure the scheduler when it is created. + + Make sure to always close Scheduler instances by calling Scheduler.close() when you no longer need them, otherwise their associated + resources may remain allocated.
          +
          +
          Parameters:
          +
          adaptor - the adaptor used to access the Scheduler.
          +
          location - the location of the Scheduler.
          +
          credential - the Credentials to use to get access to the Scheduler.
          +
          properties - optional properties to configure the Scheduler when it is created.
          +
          Returns:
          +
          the new Scheduler.
          +
          Throws:
          +
          UnknownPropertyException - If a unknown property was provided.
          +
          InvalidPropertyException - If a known property was provided with an invalid value.
          +
          InvalidLocationException - If the location was invalid.
          +
          InvalidCredentialException - If the credential is invalid to access the location.
          +
          XenonException - If the creation of the Scheduler failed.
          +
          java.lang.IllegalArgumentException - If adaptor is null.
          +
          See Also:
          +
          Documentation on the supported adaptors and locations.
          +
          +
          • +
        + + + +
          +
        • +

          create

          +
          public static Scheduler create(java.lang.String adaptor,
+                               java.lang.String location,
+                               Credential credential)
+                        throws XenonException
          +
          Create a new Scheduler using the adaptor connecting to the location using credentials to get access. + + Make sure to always close Scheduler instances by calling Scheduler.close() when you no longer need them, otherwise their associated + resources may remain allocated.
          +
          +
          Parameters:
          +
          adaptor - the adaptor used to access the Scheduler.
          +
          location - the location of the Scheduler.
          +
          credential - the Credentials to use to get access to the Scheduler.
          +
          Returns:
          +
          the new Scheduler.
          +
          Throws:
          +
          UnknownPropertyException - If a unknown property was provided.
          +
          InvalidPropertyException - If a known property was provided with an invalid value.
          +
          InvalidLocationException - If the location was invalid.
          +
          InvalidCredentialException - If the credential is invalid to access the location.
          +
          XenonException - If the creation of the Scheduler failed.
          +
          java.lang.IllegalArgumentException - If adaptor is null.
          +
          See Also:
          +
          Documentation on the supported adaptors and locations.
          +
          +
          • +
        + + + +
          +
        • +

          create

          +
          public static Scheduler create(java.lang.String adaptor,
+                               java.lang.String location)
+                        throws XenonException
          +
          Create a new Scheduler using the adaptor connecting to the location using the default credentials to get access. + + Make sure to always close Scheduler instances by calling Scheduler.close() when you no longer need them, otherwise their associated + resources may remain allocated.
          +
          +
          Parameters:
          +
          adaptor - the adaptor used to access the Scheduler.
          +
          location - the location of the Scheduler.
          +
          Returns:
          +
          the new Scheduler.
          +
          Throws:
          +
          UnknownPropertyException - If a unknown property was provided.
          +
          InvalidPropertyException - If a known property was provided with an invalid value.
          +
          InvalidLocationException - If the location was invalid.
          +
          InvalidCredentialException - If the credential is invalid to access the location.
          +
          XenonException - If the creation of the Scheduler failed.
          +
          java.lang.IllegalArgumentException - If adaptor is null.
          +
          See Also:
          +
          Documentation on the supported adaptors and locations.
          +
          +
          • +
        + + + +
          +
        • +

          create

          +
          public static Scheduler create(java.lang.String adaptor)
+                        throws XenonException
          +
          Create a new Scheduler using the adaptor connecting to the default location and using the default credentials to get access. + + Note that there are very few adaptors that support a default scheduler location. The local scheduler adaptor is the prime example. + + Make sure to always close Scheduler instances by calling Scheduler.close() when you no longer need them, otherwise their associated + resources may remain allocated.
          +
          +
          Parameters:
          +
          adaptor - the adaptor used to access the Scheduler.
          +
          Returns:
          +
          the new Scheduler.
          +
          Throws:
          +
          UnknownPropertyException - If a unknown property was provided.
          +
          InvalidPropertyException - If a known property was provided with an invalid value.
          +
          InvalidLocationException - If the location was invalid.
          +
          InvalidCredentialException - If the credential is invalid to access the location.
          +
          XenonException - If the creation of the Scheduler failed.
          +
          java.lang.IllegalArgumentException - If adaptor is null.
          +
          See Also:
          +
          Documentation on the supported adaptors and locations.
          +
          +
          • +
        + + + +
          +
        • +

          getAdaptorName

          +
          public java.lang.String getAdaptorName()
          +
          Get the name of the adaptor that created this Scheduler.
          +
          +
          Returns:
          +
          the name of the adaptor.
          +
          +
          • +
        + + + +
          +
        • +

          getLocation

          +
          public java.lang.String getLocation()
          +
          Get the location that this Scheduler is connected to.
          +
          +
          Returns:
          +
          the location this Scheduler is connected to.
          +
          +
          • +
        + + + +
          +
        • +

          getCredential

          +
          public Credential getCredential()
          +
          Get the credential that this Scheduler is using.
          +
          +
          Returns:
          +
          the credential this Scheduler is using.
          +
          +
          • +
        + + + +
          +
        • +

          getProperties

          +
          public java.util.Map<java.lang.String,java.lang.String> getProperties()
          +
          Get the properties used to create this Scheduler.
          +
          +
          Returns:
          +
          the properties used to create this Scheduler.
          +
          +
          • +
        + + + +
          +
        • +

          getQueueNames

          +
          public abstract java.lang.String[] getQueueNames()
+                                          throws XenonException
          +
          Get the queue names supported by this Scheduler.
          +
          +
          Returns:
          +
          the queue names supported by this Scheduler.
          +
          Throws:
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If scheduler is closed.
          +
          XenonException - If an I/O error occurred.
          +
          +
          • +
        + + + +
          +
        • +

          close

          +
          public abstract void close()
+                    throws XenonException
          +
          Close this Scheduler.
          +
          +
          Specified by:
          +
          close in interface java.lang.AutoCloseable
          +
          Throws:
          +
          XenonException - If the Scheduler failed to close.
          +
          +
          • +
        + + + +
          +
        • +

          isOpen

          +
          public abstract boolean isOpen()
+                        throws XenonException
          +
          Test if the connection of this Scheduler is open.
          +
          +
          Returns:
          +
          true if the connection of this Scheduler is still open, false otherwise.
          +
          Throws:
          +
          XenonException - If an I/O error occurred.
          +
          +
          • +
        + + + +
          +
        • +

          getDefaultQueueName

          +
          public abstract java.lang.String getDefaultQueueName()
+                                              throws XenonException
          +
          Get the name of the default queue.
          +
          +
          Returns:
          +
          the name of the default queue for this scheduler, or null if no default queue is available.
          +
          Throws:
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If scheduler is closed.
          +
          XenonException - If an I/O error occurred.
          +
          +
          • +
        + + + +
          +
        • +

          getJobs

          +
          public abstract java.lang.String[] getJobs(java.lang.String... queueNames)
+                                    throws XenonException
          +
          Get all job identifier of jobs currently in (one ore more) queues. + + If no queue names are specified, the job identifiers for all queues are returned. + + Note that job identifiers of jobs submitted by other users or other schedulers may also be returned.
          +
          +
          Parameters:
          +
          queueNames - the names of the queues.
          +
          Returns:
          +
          an array containing the resulting job identifiers .
          +
          Throws:
          +
          nl.esciencecenter.xenon.adaptors.NotConnectedException - If scheduler is closed.
          +
          NoSuchQueueException - If the queue does not exist in the scheduler.
          +
          XenonException - If the Scheduler failed to get jobs.
          +
          +
          • +
        + + + +
          +
        • +

          getQueueStatus

          +
          public abstract QueueStatus getQueueStatus(java.lang.String queueName)
+                                    throws XenonException
          +
          Get the status of the queue.
          +
          +
          Parameters:
          +
          queueName - the name of the queue.
          +
          Returns:
          +
          the resulting QueueStatus.
          +
          Throws:
          +
          NoSuchQueueException - If the queue does not exist in the scheduler.
          +
          XenonException - If the Scheduler failed to get its status.
          +
          +
          • +
        + + + +
          +
        • +

          getQueueStatuses

          +
          public abstract QueueStatus[] getQueueStatuses(java.lang.String... queueNames)
+                                        throws XenonException
          +
          Get the status of all queues. + + Note that this method will only throw an exception when this exception will influence all status requests. For example, if the scheduler is no longer + connected. + + Exceptions that only refer to a single queue are returned in the QueueStatus returned for that queue.
          +
          +
          Parameters:
          +
          queueNames - the names of the queues.
          +
          Returns:
          +
          an array containing the resulting QueueStatus.
          +
          Throws:
          +
          XenonException - If the Scheduler failed to get the statuses.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          getJobStatus

          +
          public abstract JobStatus getJobStatus(java.lang.String jobIdentifier)
+                                throws XenonException
          +
          Get the status of a Job.
          +
          +
          Parameters:
          +
          jobIdentifier - the job identifier of the job to get the status for.
          +
          Returns:
          +
          the status of the Job.
          +
          Throws:
          +
          NoSuchJobException - If the job is not known.
          +
          XenonException - If the status of the job could not be retrieved.
          +
          +
          • +
        + + + +
          +
        • +

          getJobStatuses

          +
          public JobStatus[] getJobStatuses(java.lang.String... jobIdentifiers)
+                           throws XenonException
          +
          Get the status of all specified jobs. +

          + The array of JobStatus contains one entry for each of the jobs. The order of the elements in the returned + JobStatus array corresponds to the order in which the jobs are passed as parameters. If a job is + null, the corresponding entry in the JobStatus array will also be null. If the retrieval of the + JobStatus fails for a job, the exception will be stored in the corresponding JobsStatus entry. +

          +
          +
          Parameters:
          +
          jobIdentifiers - the job identifiers for which to retrieve the status.
          +
          Returns:
          +
          an array of the resulting JobStatuses.
          +
          Throws:
          +
          XenonException - If an I/O error occurred
          +
          +
          • +
        + + + +
          +
        • +

          cancelJob

          +
          public abstract JobStatus cancelJob(java.lang.String jobIdentifier)
+                             throws XenonException
          +
          Cancel a job. +

          + A status is returned that indicates the state of the job after the cancel. If the job was already done it cannot be cancelled. +

          +

          + A JobStatus is returned that can be used to determine the state of the job after cancelJob returns. Note that it may take some time before the + job has actually terminated. The waitUntilDone method can be used to wait until the job is terminated. +

          +
          +
          Parameters:
          +
          jobIdentifier - the identifier of job to kill.
          +
          Returns:
          +
          the status of the Job.
          +
          Throws:
          +
          NoSuchJobException - If the job is not known.
          +
          XenonException - If the status of the job could not be retrieved.
          +
          +
          • +
        + + + +
          +
        • +

          waitUntilDone

          +
          public abstract JobStatus waitUntilDone(java.lang.String jobIdentifier,
+                                        long timeout)
+                                 throws XenonException
          +
          Wait until a job is done or until a timeout expires. +

          + This method will wait until a job is done (either gracefully or by being killed or producing an error), or until the timeout expires, whichever comes + first. If the timeout expires, the job will continue to run. +

          +

          + The timeout is in milliseconds and must be >= 0. When timeout is 0, it will be ignored and this method will wait until the jobs is done. +

          +

          + A JobStatus is returned that can be used to determine why the call returned. +

          +
          +
          Parameters:
          +
          jobIdentifier - the identifier of the to wait for.
          +
          timeout - the maximum time to wait for the job in milliseconds.
          +
          Returns:
          +
          the status of the Job.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - If the value of timeout is negative
          +
          NoSuchJobException - If the job is not known.
          +
          XenonException - If the status of the job could not be retrieved.
          +
          +
          • +
        + + + +
          +
        • +

          waitUntilRunning

          +
          public abstract JobStatus waitUntilRunning(java.lang.String jobIdentifier,
+                                           long timeout)
+                                    throws XenonException
          +
          Wait until a job starts running, or until a timeout expires. +

          + This method will return as soon as the job is no longer waiting in the queue, or when the timeout expires, whichever comes first. If the job is no longer + waiting in the queue, it may be running, but it may also be killed, finished or have produced an error. If the timeout expires, the job will continue to + be queued normally. +

          +

          + The timeout is in milliseconds and must be >= 0. When timeout is 0, it will be ignored and this method will wait until the job is no longer queued. +

          +

          + A JobStatus is returned that can be used to determine why the call returned. +

          +
          +
          Parameters:
          +
          jobIdentifier - the identifier of the to wait for.
          +
          timeout - the maximum time to wait in milliseconds.
          +
          Returns:
          +
          the status of the Job.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - If the value of timeout is negative
          +
          NoSuchJobException - If the job is not known.
          +
          XenonException - If the status of the job could not be retrieved.
          +
          +
          • +
        + + + +
          +
        • +

          getFileSystem

          +
          public abstract FileSystem getFileSystem()
+                                  throws XenonException
          +
          Retrieve the FileSystem used internally by this Scheduler. +

          + Often, a Scheduler needs to access files or directories on the machine it will schedule jobs. For example, to ensure a working directory + exists, or to redirect the stdin, stdout or stderr streams used by a job. +

          +

          + This method returns this FileSystem so it can also be used by the application to prepare input files for the jobs, or retrieve the output + files produced by the jobs. +

          +
          +
          Returns:
          +
          the FileSystem used by this Scheduler.
          +
          Throws:
          +
          XenonException - if this Scheduler does not use a FileSystem internally.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/SchedulerAdaptorDescription.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/SchedulerAdaptorDescription.html new file mode 100644 index 000000000..14667d9f9 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/SchedulerAdaptorDescription.html @@ -0,0 +1,320 @@ + + + + + +SchedulerAdaptorDescription (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.schedulers
    +

    Interface SchedulerAdaptorDescription

    +
    +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethod and Description
        booleanisEmbedded() +
        Is this an embedded scheduler ? + + Embedded schedulers are implemented inside the Xenon process itself.
        +
        booleansupportsBatch() +
        Does this Scheduler support the submission of batch jobs ? + + For batch jobs the standard streams of the jobs are redirected from and to files.
        +
        booleansupportsInteractive() +
        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.
        +
        booleanusesFileSystem() +
        Does this Scheduler create a FileSystem to support the submission of jobs ? + + Many scheduler implementations use a FileSystem internally to handle job submission, for example to store submission scripts or handle the standard I/O + streams of a process.
        +
        + +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isEmbedded

          +
          boolean isEmbedded()
          +
          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.
          +
          +
          Returns:
          +
          if this scheduler is embedded.
          +
          +
          • +
        + + + +
          +
        • +

          supportsBatch

          +
          boolean supportsBatch()
          +
          Does this Scheduler support the submission of batch jobs ? + + For batch jobs the standard streams of the jobs are redirected from and to files.
          +
          +
          Returns:
          +
          if this scheduler supports the submission of batch jobs ?
          +
          +
          • +
        + + + +
          +
        • +

          supportsInteractive

          +
          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. Failing to do so may cause the job to hang indefinitely.
          +
          +
          Returns:
          +
          if this scheduler supports the submission of interactive jobs ?
          +
          +
          • +
        + + + +
          +
        • +

          usesFileSystem

          +
          boolean usesFileSystem()
          +
          Does this Scheduler create a FileSystem to support the submission of jobs ? + + Many scheduler implementations use a FileSystem internally to handle job submission, for example to store submission scripts or handle the standard I/O + streams of a process. This FileSystem can optionally be retrieved by the user to perform other tasks, such as staging in and output data of the job. To + do so use Scheduler.getFileSystem() method.
          +
          +
          Returns:
          +
          does this Scheduler create a FileSystem to support the submission of jobs ?
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/Streams.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/Streams.html new file mode 100644 index 000000000..a0c4e8552 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/Streams.html @@ -0,0 +1,292 @@ + + + + + +Streams (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.schedulers
    +

    Interface Streams

    +
    +
    +
    +
      +
    • +
      +
      +
      public interface Streams
      +
      Streams is a container for the standard input, output and error streams of a job. + + Note that these standard streams are only available for interactive jobs.
      +
      +
      Since:
      +
      1.0
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethod and Description
        java.lang.StringgetJobIdentifier() +
        Get the identifier of the job for which this Streams was created.
        +
        java.io.InputStreamgetStderr() +
        Returns the standard error stream of job.
        +
        java.io.OutputStreamgetStdin() +
        Returns the standard input stream of job.
        +
        java.io.InputStreamgetStdout() +
        Returns the standard output stream of job.
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getJobIdentifier

          +
          java.lang.String getJobIdentifier()
          +
          Get the identifier of the job for which this Streams was created.
          +
          +
          Returns:
          +
          the identifier of the ob.
          +
          +
          • +
        + + + +
          +
        • +

          getStdout

          +
          java.io.InputStream getStdout()
          +
          Returns the standard output stream of job.
          +
          +
          Returns:
          +
          the standard output stream of job.
          +
          +
          • +
        + + + +
          +
        • +

          getStderr

          +
          java.io.InputStream getStderr()
          +
          Returns the standard error stream of job.
          +
          +
          Returns:
          +
          the standard error stream of job.
          +
          +
          • +
        + + + +
          +
        • +

          getStdin

          +
          java.io.OutputStream getStdin()
          +
          Returns the standard input stream of job.
          +
          +
          Returns:
          +
          the standard input stream of this job.
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/UnsupportedJobDescriptionException.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/UnsupportedJobDescriptionException.html new file mode 100644 index 000000000..71c1e7264 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/UnsupportedJobDescriptionException.html @@ -0,0 +1,292 @@ + + + + + +UnsupportedJobDescriptionException (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.schedulers
    +

    Class UnsupportedJobDescriptionException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class UnsupportedJobDescriptionException
+extends XenonException
      +
      Signals that a combination of options used in a JobDescription is not supported by a resource.
      +
      +
      Since:
      +
      1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnsupportedJobDescriptionException

          +
          public UnsupportedJobDescriptionException(java.lang.String adaptorName,
+                                          java.lang.String message,
+                                          java.lang.Throwable t)
          +
          • +
        + + + +
          +
        • +

          UnsupportedJobDescriptionException

          +
          public UnsupportedJobDescriptionException(java.lang.String adaptorName,
+                                          java.lang.String message)
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/package-frame.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/package-frame.html new file mode 100644 index 000000000..33b118fa0 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/package-frame.html @@ -0,0 +1,35 @@ + + + + + +nl.esciencecenter.xenon.schedulers (xenon-2.3.0 2.6.1 API) + + + + +

    nl.esciencecenter.xenon.schedulers

    +
    +

    Interfaces

    + +

    Classes

    + +

    Exceptions

    + +
    + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/package-summary.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/package-summary.html new file mode 100644 index 000000000..0a2074e5e --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/package-summary.html @@ -0,0 +1,230 @@ + + + + + +nl.esciencecenter.xenon.schedulers (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Package nl.esciencecenter.xenon.schedulers

    +
    +
    This package contains the classes and interfaces used to run jobs.
    +
    +

    See: Description

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      JobStatus +
      JobStatus contains status information for a specific job.
      +
      QueueStatus +
      QueueStatus contains status information for a specific queue.
      +
      SchedulerAdaptorDescription 
      Streams +
      Streams is a container for the standard input, output and error streams of a job.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      JobDescription +
      JobDescription contains a description of a job that can be submitted to a Scheduler.
      +
      Scheduler +
      Scheduler represents a (possibly remote) scheduler that can be used to submit jobs and retrieve queue information.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Exception Summary 
      ExceptionDescription
      IncompleteJobDescriptionException +
      Signals that a JobDescription is missing required options.
      +
      InvalidJobDescriptionException +
      Signals that a JobDescription contains invalid values for certain options.
      +
      NoSuchJobException +
      Signals that a Job was not found.
      +
      NoSuchQueueException +
      Signals that a unknown queue was provided.
      +
      UnsupportedJobDescriptionException +
      Signals that a combination of options used in a JobDescription is not supported by a resource.
      +
      +
      • +
    + + + +

    Package nl.esciencecenter.xenon.schedulers Description

    +
    This package contains the classes and interfaces used to run jobs.
    +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/package-tree.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/package-tree.html new file mode 100644 index 000000000..0ac2ee549 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/schedulers/package-tree.html @@ -0,0 +1,163 @@ + + + + + +nl.esciencecenter.xenon.schedulers Class Hierarchy (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Hierarchy For Package nl.esciencecenter.xenon.schedulers

    +Package Hierarchies: + +
    +
    +

    Class Hierarchy

    + +

    Interface Hierarchy

    + +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/InputWriter.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/InputWriter.html new file mode 100644 index 000000000..95c96dcd3 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/InputWriter.html @@ -0,0 +1,371 @@ + + + + + +InputWriter (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.utils
    +

    Class InputWriter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Thread
        • +
      • +
          +
        • nl.esciencecenter.xenon.utils.InputWriter
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.lang.Runnable
      +
      +
      +
      +
      public final class InputWriter
+extends java.lang.Thread
      +
      A simple input writer that uses a daemon thread to write from an String to an OutputStream. + Once the end of the string is reached, the destination stream will be closed.
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from class java.lang.Thread

          +java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
          • +
        +
        • +
      + +
        +
      • + + +

        Field Summary

        +
          +
        • + + +

          Fields inherited from class java.lang.Thread

          +MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        InputWriter(java.lang.String content, + java.io.OutputStream destination) +
        Create a new InputWriter that writes content to the destination.
        +
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        booleanisFinished() +
        Poll if the InputWriter has finished writing.
        +
        voidrun() +
        Entry point for the Daemon thread.
        +
        voidwaitUntilFinished() +
        Wait until the InputWriter has finished writing.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Thread

          +activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InputWriter

          +
          public InputWriter(java.lang.String content,
+                   java.io.OutputStream destination)
          +
          Create a new InputWriter that writes content to the destination.
          +
          +
          Parameters:
          +
          content - the data to write to the destination.
          +
          destination - the destination to write to.
          +
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isFinished

          +
          public boolean isFinished()
          +
          Poll if the InputWriter has finished writing.
          +
          +
          Returns:
          +
          if the InputWriter has finished writing.
          +
          +
          • +
        + + + +
          +
        • +

          waitUntilFinished

          +
          public void waitUntilFinished()
          +
          Wait until the InputWriter has finished writing.
          +
          • +
        + + + +
          +
        • +

          run

          +
          public void run()
          +
          Entry point for the Daemon thread.
          +
          +
          Specified by:
          +
          run in interface java.lang.Runnable
          +
          Overrides:
          +
          run in class java.lang.Thread
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/JavaJobDescription.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/JavaJobDescription.html new file mode 100644 index 000000000..602d87086 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/JavaJobDescription.html @@ -0,0 +1,700 @@ + + + + + +JavaJobDescription (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.utils
    +

    Class JavaJobDescription

    +
    +
    + +
    +
      +
    • +
      +
      +
      public class JavaJobDescription
+extends JobDescription
      +
      A JobDescription specialized in Java applications. + + A JavaJobDescription will use the Java specific information provided by the user to build the command line arguments of the JobDescription.
      +
      +
      Since:
      +
      1.0
      +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          JavaJobDescription

          +
          public JavaJobDescription()
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getJavaOptions

          +
          public java.util.List<java.lang.String> getJavaOptions()
          +
          Returns the JVM options.
          +
          +
          Returns:
          +
          the JVM options.
          +
          +
          • +
        + + + +
          +
        • +

          setJavaOptions

          +
          public void setJavaOptions(java.lang.String... options)
          +
          Sets the JVM options.
          +
          +
          Parameters:
          +
          options - the JVM options.
          +
          +
          • +
        + + + +
          +
        • +

          addJavaOption

          +
          public void addJavaOption(java.lang.String option)
          +
          Adds a JVM option.
          +
          +
          Parameters:
          +
          option - the JVM option.
          +
          +
          • +
        + + + +
          +
        • +

          getJavaSystemProperties

          +
          public java.util.Map<java.lang.String,java.lang.String> getJavaSystemProperties()
          +
          Returns the java system properties.
          +
          +
          Returns:
          +
          the java system properties.
          +
          +
          • +
        + + + +
          +
        • +

          setJavaSystemProperties

          +
          public void setJavaSystemProperties(java.util.Map<java.lang.String,java.lang.String> systemProperties)
          +
          Sets the system properties. A system property should be passed as a key value pair <"a", "b">, not as <"-Da", "b">, Xenon will add the -D to + the property.
          +
          +
          Parameters:
          +
          systemProperties - the system properties.
          +
          +
          • +
        + + + +
          +
        • +

          addJavaSystemProperty

          +
          public void addJavaSystemProperty(java.lang.String key,
+                                  java.lang.String value)
          +
          Adds a system property to the current set of system properties. The key of the system property should not start with "-D".
          +
          +
          Parameters:
          +
          key - the key of the system property to be added
          +
          value - the value belonging to the key of the system property to be added
          +
          +
          • +
        + + + +
          +
        • +

          getJavaMain

          +
          public java.lang.String getJavaMain()
          +
          Returns the main class of the java application.
          +
          +
          Returns:
          +
          the main class.
          +
          +
          • +
        + + + +
          +
        • +

          setJavaMain

          +
          public void setJavaMain(java.lang.String main)
          +
          Sets the main class.
          +
          +
          Parameters:
          +
          main - the main class.
          +
          +
          • +
        + + + +
          +
        • +

          getJavaArguments

          +
          public java.util.List<java.lang.String> getJavaArguments()
          +
          Returns the arguments for the main class.
          +
          +
          Returns:
          +
          the arguments for the main class
          +
          +
          • +
        + + + +
          +
        • +

          setJavaArguments

          +
          public void setJavaArguments(java.lang.String... javaArguments)
          +
          Sets the arguments of the java main class.
          +
          +
          Parameters:
          +
          javaArguments - the arguments of the java main class.
          +
          +
          • +
        + + + +
          +
        • +

          addJavaArgument

          +
          public void addJavaArgument(java.lang.String javaArgument)
          +
          • +
        + + + + + + + +
          +
        • +

          getArguments

          +
          public java.util.List<java.lang.String> getArguments()
          +
          Constructs the command line arguments from the class path, the JVM options, the system properties, the main and the java arguments.
          +
          +
          Overrides:
          +
          getArguments in class JobDescription
          +
          Returns:
          +
          the command line arguments
          +
          +
          • +
        + + + +
          +
        • +

          getArguments

          +
          public java.util.List<java.lang.String> getArguments(char pathSeparator)
          +
          Constructs the command line arguments from the class path, the JVM options, the system properties, the main and the java arguments.
          +
          +
          Parameters:
          +
          pathSeparator - the seperator to use in the classpath. Defaults to the unix path seperator ':'
          +
          Returns:
          +
          the command line arguments
          +
          +
          • +
        + + + +
          +
        • +

          getExecutable

          +
          public java.lang.String getExecutable()
          +
          Returns the executable. If no executable is set the default executable will be "java".
          +
          +
          Overrides:
          +
          getExecutable in class JobDescription
          +
          Returns:
          +
          Returns the executable.
          +
          +
          • +
        + + + +
          +
        • +

          getJavaClasspath

          +
          public java.util.List<java.lang.String> getJavaClasspath()
          +
          Returns the java class path.
          +
          +
          Returns:
          +
          the java class path.
          +
          +
          • +
        + + + +
          +
        • +

          setJavaClasspath

          +
          public void setJavaClasspath(java.lang.String... javaClasspath)
          +
          Sets the java class path. Will automatically add separators when multiple elements are given.
          +
          +
          Parameters:
          +
          javaClasspath - the class path to be set.
          +
          +
          • +
        + + + +
          +
        • +

          addJavaClasspathElement

          +
          public void addJavaClasspathElement(java.lang.String element)
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          equals

          +
          public boolean equals(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class JobDescription
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/LocalFileSystemUtils.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/LocalFileSystemUtils.html new file mode 100644 index 000000000..037d32b0b --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/LocalFileSystemUtils.html @@ -0,0 +1,582 @@ + + + + + +LocalFileSystemUtils (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.utils
    +

    Class LocalFileSystemUtils

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • nl.esciencecenter.xenon.utils.LocalFileSystemUtils
        • +
      +
      • +
    +
    +
      +
    • +
      +
      +
      public class LocalFileSystemUtils
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethod and Description
        static java.lang.StringexpandTilde(java.lang.String path) +
        Expand the tilde in a String representation of a path by the users home directory, as provided by the user.home property.
        +
        static FileSystem[]getLocalFileSystems() +
        Returns all local FileSystems.
        +
        static java.lang.StringgetLocalRoot(java.lang.String p) +
        Return the locally valid root element of an String representation of an absolute path.
        +
        static java.lang.StringgetLocalRootlessPath(java.lang.String path) +
        Return the local root less path of an absolute path.
        +
        static chargetLocalSeparator() +
        Returns the local file system path separator character.
        +
        static booleanisLinux() +
        Returns if we are currently running on Linux.
        +
        static booleanisLinuxRoot(java.lang.String root) +
        Check if root only contains a valid Linux root element, which is "/".
        +
        static booleanisLocalRoot(java.lang.String root) +
        Check if root contains a locally valid root element, such as "C:" on Windows or "/" on Linux and OSX.
        +
        static booleanisOSX() +
        Returns if we are currently running on OSX.
        +
        static booleanisOSXRoot(java.lang.String root) +
        Check if root contains a valid OSX root element, which is "/".
        +
        static booleanisWindows() +
        Returns if we are currently running on Windows.
        +
        static booleanisWindowsRoot(java.lang.String root) +
        Check if root only contains a valid Windows root element such as "C:".
        +
        static booleanstartsWithLinuxRoot(java.lang.String path) +
        Checks if the provide path starts with a valid Linux root, that is "/".
        +
        static booleanstartWithRoot(java.lang.String path) +
        Checks if the provide path starts with a valid root, such as "/" or "C:".
        +
        static booleanstartWithWindowsRoot(java.lang.String path) +
        Checks if the provide path starts with a valid Windows root, for example "C:".
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isWindows

          +
          public static boolean isWindows()
          +
          Returns if we are currently running on Windows.
          +
          +
          Returns:
          +
          if we are currently running on Window.
          +
          +
          • +
        + + + +
          +
        • +

          isOSX

          +
          public static boolean isOSX()
          +
          Returns if we are currently running on OSX.
          +
          +
          Returns:
          +
          if we are currently running on OSX.
          +
          +
          • +
        + + + +
          +
        • +

          isLinux

          +
          public static boolean isLinux()
          +
          Returns if we are currently running on Linux.
          +
          +
          Returns:
          +
          if we are currently running on Linux.
          +
          +
          • +
        + + + +
          +
        • +

          isWindowsRoot

          +
          public static boolean isWindowsRoot(java.lang.String root)
          +
          Check if root only contains a valid Windows root element such as "C:". + + If root is null or empty, false will be returned. If root contains more than just a root element, + false will be returned.
          +
          +
          Parameters:
          +
          root - The root to check.
          +
          Returns:
          +
          If root only contains a valid Windows root element.
          +
          +
          • +
        + + + +
          +
        • +

          isLinuxRoot

          +
          public static boolean isLinuxRoot(java.lang.String root)
          +
          Check if root only contains a valid Linux root element, which is "/". + + If root is null or empty, false will be returned. If root contains more than just a root element, + false will be returned.
          +
          +
          Parameters:
          +
          root - The root to check.
          +
          Returns:
          +
          If root only contains a valid Linux root element.
          +
          +
          • +
        + + + +
          +
        • +

          isOSXRoot

          +
          public static boolean isOSXRoot(java.lang.String root)
          +
          Check if root contains a valid OSX root element, which is "/". + + If root is null or empty, false will be returned. If root contains more than just a root element, + false will be returned.
          +
          +
          Parameters:
          +
          root - The root to check.
          +
          Returns:
          +
          If root only contains a valid OSX root element.
          +
          +
          • +
        + + + +
          +
        • +

          isLocalRoot

          +
          public static boolean isLocalRoot(java.lang.String root)
          +
          Check if root contains a locally valid root element, such as "C:" on Windows or "/" on Linux and OSX. + + If root is null or empty, false will be returned. If root contains more than just a root element, + false will be returned. + + Note that the result of this method depends on the OS the application is running on.
          +
          +
          Parameters:
          +
          root - The root to check.
          +
          Returns:
          +
          If root only contains a valid OSX root element.
          +
          +
          • +
        + + + +
          +
        • +

          startsWithLinuxRoot

          +
          public static boolean startsWithLinuxRoot(java.lang.String path)
          +
          Checks if the provide path starts with a valid Linux root, that is "/".
          +
          +
          Parameters:
          +
          path - The path to check.
          +
          Returns:
          +
          If the provide path starts with a valid Linux root.
          +
          +
          • +
        + + + +
          +
        • +

          startWithWindowsRoot

          +
          public static boolean startWithWindowsRoot(java.lang.String path)
          +
          Checks if the provide path starts with a valid Windows root, for example "C:".
          +
          +
          Parameters:
          +
          path - The path to check.
          +
          Returns:
          +
          If the provide path starts with a valid Windows root.
          +
          +
          • +
        + + + +
          +
        • +

          startWithRoot

          +
          public static boolean startWithRoot(java.lang.String path)
          +
          Checks if the provide path starts with a valid root, such as "/" or "C:".
          +
          +
          Parameters:
          +
          path - The path to check.
          +
          Returns:
          +
          If the provide path starts with a valid root.
          +
          +
          • +
        + + + +
          +
        • +

          getLocalRoot

          +
          public static java.lang.String getLocalRoot(java.lang.String p)
+                                     throws InvalidLocationException
          +
          Return the locally valid root element of an String representation of an absolute path. + + Examples of a root elements are "/" or "C:". If the provided path does not contain a locally valid root element, an exception will be thrown. For + example, providing "/user/local" will return "/" on Linux or OSX, but throw an exception on Windows; providing "C:\test" will return "C:" on Windows but + throw an exception on Linux or OSX. + + If the provided string is null or empty, the default root element for this OS will be returned, i.e,. "/" on Linux or OSX and "C:" on + windows.
          +
          +
          Parameters:
          +
          p - The absolute path for which to determine the root element.
          +
          Returns:
          +
          The locally valid root element.
          +
          Throws:
          +
          InvalidLocationException - If the provided path is not absolute, or does not contain a locally valid root.
          +
          +
          • +
        + + + +
          +
        • +

          expandTilde

          +
          public static java.lang.String expandTilde(java.lang.String path)
          +
          Expand the tilde in a String representation of a path by the users home directory, as provided by the user.home property. + + The tilde will only be replaced if it is the first character in the path and either the only character in the path or directly followed by the local + separator character or directly followed by the local user name (as provided by the user.name property). + + For example, if user.name is set to "john" and user.home is set to "/home/john", then "~" will be expanded to "/home/john", + "~/foo" or "~john/foo" will be expanded to "/home/john/foo". + + However, in paths like "/foo/bar", "~matt/foo" or "/foo/~" the tilde will not be expanded, and the provided path is returned unchanged. This includes a + path that is null. + + If the user.home property is not set, the tilde will not be expanded and the provided path will be returned unchanged. If the + user.name property is not set, the combined tilde-username expansion will not be performed.
          +
          +
          Parameters:
          +
          path - the path in which to replace the tilde (if possible).
          +
          Returns:
          +
          the path with the tilde replaced by the user home property, or the unchanged path if replacement was not triggered.
          +
          +
          • +
        + + + +
          +
        • +

          getLocalRootlessPath

          +
          public static java.lang.String getLocalRootlessPath(java.lang.String path)
          +
          Return the local root less path of an absolute path.
          +
          +
          Parameters:
          +
          path - The absolute path from which to remove the root element.
          +
          Returns:
          +
          The path without the root element.
          +
          +
          • +
        + + + +
          +
        • +

          getLocalSeparator

          +
          public static char getLocalSeparator()
          +
          Returns the local file system path separator character.
          +
          +
          Returns:
          +
          The local file system path separator character.
          +
          +
          • +
        + + + +
          +
        • +

          getLocalFileSystems

          +
          public static FileSystem[] getLocalFileSystems()
+                                        throws XenonException
          +
          Returns all local FileSystems. + + This method detects all local file system roots, and returns one or more FileSystems representing each of these roots.
          +
          +
          Returns:
          +
          all local FileSystems.
          +
          Throws:
          +
          XenonException - If the creation of the FileSystem failed.
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
      +
    • Detail: 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/OutputReader.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/OutputReader.html new file mode 100644 index 000000000..06c51e722 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/OutputReader.html @@ -0,0 +1,414 @@ + + + + + +OutputReader (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.utils
    +

    Class OutputReader

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Thread
        • +
      • +
          +
        • nl.esciencecenter.xenon.utils.OutputReader
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.lang.Runnable
      +
      +
      +
      +
      public final class OutputReader
+extends java.lang.Thread
      +
      A simple output reader that uses a daemon thread to read from an InputStream and buffer this data. Once + end-of-stream is reached, this data will be made available as a String. + + Note that since the data is buffered in memory, so it is not advisable to use this OutputReader to read large amounts of data.
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from class java.lang.Thread

          +java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
          • +
        +
        • +
      + +
        +
      • + + +

        Field Summary

        +
          +
        • + + +

          Fields inherited from class java.lang.Thread

          +MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        OutputReader(java.io.InputStream source) +
        Create an OutputReader that reads from source.
        +
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        byte[]getResult() +
        Returns the data that has been read from the InputStream as a byte array.
        +
        java.lang.StringgetResultAsString() +
        Returns the data that has been read from the InputStream as a String.
        +
        booleanisFinished() +
        Returns if the OutputReader has finished (i.e., has reached the end-of-stream on the input).
        +
        voidrun() +
        Entry method for daemon thread.
        +
        voidwaitUntilFinished() +
        Waits until the OutputReader has finished (i.e., has reached the end-of-stream on the input).
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Thread

          +activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          OutputReader

          +
          public OutputReader(java.io.InputStream source)
          +
          Create an OutputReader that reads from source.
          +
          +
          Parameters:
          +
          source - the {#link InputStream} to read from.
          +
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isFinished

          +
          public boolean isFinished()
          +
          Returns if the OutputReader has finished (i.e., has reached the end-of-stream on the input). If so, the data that has been + read is now available through getResultAsString().
          +
          +
          Returns:
          +
          if the OutputReader has finished reading.
          +
          +
          • +
        + + + +
          +
        • +

          waitUntilFinished

          +
          public void waitUntilFinished()
          +
          Waits until the OutputReader has finished (i.e., has reached the end-of-stream on the input). After this method returns, + the data that has been read is available through getResultAsString().
          +
          • +
        + + + +
          +
        • +

          run

          +
          public void run()
          +
          Entry method for daemon thread.
          +
          +
          Specified by:
          +
          run in interface java.lang.Runnable
          +
          Overrides:
          +
          run in class java.lang.Thread
          +
          +
          • +
        + + + +
          +
        • +

          getResultAsString

          +
          public java.lang.String getResultAsString()
          +
          Returns the data that has been read from the InputStream as a String. If the + OutputReader has not finished reading, this method will block until end-of-stream has been reached.
          +
          +
          Returns:
          +
          the data that has been read.
          +
          +
          • +
        + + + +
          +
        • +

          getResult

          +
          public byte[] getResult()
          +
          Returns the data that has been read from the InputStream as a byte array. If the + OutputReader has not finished reading, this method will block until end-of-stream has been reached.
          +
          +
          Returns:
          +
          the data that has been read.
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/StreamForwarder.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/StreamForwarder.html new file mode 100644 index 000000000..b461f2cfe --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/StreamForwarder.html @@ -0,0 +1,384 @@ + + + + + +StreamForwarder (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    nl.esciencecenter.xenon.utils
    +

    Class StreamForwarder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Thread
        • +
      • +
          +
        • nl.esciencecenter.xenon.utils.StreamForwarder
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.lang.Runnable
      +
      +
      +
      +
      public final class StreamForwarder
+extends java.lang.Thread
      +
      A simple stream forwarder that uses a daemon thread to read from an InputStream and write it to a OutputStream. A small + buffer is used (typically 1 KB) to improve performance. Any exceptions will be ignored.
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from class java.lang.Thread

          +java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
          • +
        +
        • +
      + +
        +
      • + + +

        Field Summary

        +
          +
        • + + +

          Fields inherited from class java.lang.Thread

          +MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
          • +
        +
        • +
      + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        StreamForwarder(java.io.InputStream in, + java.io.OutputStream out) +
        Create a new StreamForwarder and start it immediately.
        +
        StreamForwarder(java.lang.String name, + java.io.InputStream in, + java.io.OutputStream out, + int bufferSize) +
        Create a new StreamForwarder and start it immediately.
        +
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        voidrun() +
        Main entry method for the daemon thread.
        +
        voidterminate(long timeout) +
        Wait for a given timeout for the StreamForwarder to terminate by reading an end-of-stream on the input.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Thread

          +activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          StreamForwarder

          +
          public StreamForwarder(java.lang.String name,
+                       java.io.InputStream in,
+                       java.io.OutputStream out,
+                       int bufferSize)
          +
          Create a new StreamForwarder and start it immediately.
          +
          +
          Parameters:
          +
          name - the name of the thread
          +
          in - the InputStream to read from.
          +
          out - the OutputStream to write to, or null to discard the output.
          +
          bufferSize - the buffer size to use, or 0 to use the default.
          +
          +
          • +
        + + + +
          +
        • +

          StreamForwarder

          +
          public StreamForwarder(java.io.InputStream in,
+                       java.io.OutputStream out)
          +
          Create a new StreamForwarder and start it immediately.
          +
          +
          Parameters:
          +
          in - the InputStream to read from.
          +
          out - the OutputStream to write to.
          +
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          terminate

          +
          public void terminate(long timeout)
          +
          Wait for a given timeout for the StreamForwarder to terminate by reading an end-of-stream on the input. When the timeout expires both input and output + streams will be closed, regardless of whether the input has reached end-of-line.
          +
          +
          Parameters:
          +
          timeout - The number of milliseconds to wait for termination.
          +
          +
          • +
        + + + +
          +
        • +

          run

          +
          public void run()
          +
          Main entry method for the daemon thread.
          +
          +
          Specified by:
          +
          run in interface java.lang.Runnable
          +
          Overrides:
          +
          run in class java.lang.Thread
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/package-frame.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/package-frame.html new file mode 100644 index 000000000..c0eba89ec --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/package-frame.html @@ -0,0 +1,23 @@ + + + + + +nl.esciencecenter.xenon.utils (xenon-2.3.0 2.6.1 API) + + + + +

    nl.esciencecenter.xenon.utils

    +
    +

    Classes

    + +
    + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/package-summary.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/package-summary.html new file mode 100644 index 000000000..a1f76cbef --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/package-summary.html @@ -0,0 +1,172 @@ + + + + + +nl.esciencecenter.xenon.utils (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Package nl.esciencecenter.xenon.utils

    +
    +
    This package is contains several utility classes.
    +
    +

    See: Description

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      InputWriter +
      A simple input writer that uses a daemon thread to write from an String to an OutputStream.
      +
      JavaJobDescription +
      A JobDescription specialized in Java applications.
      +
      LocalFileSystemUtils 
      OutputReader +
      A simple output reader that uses a daemon thread to read from an InputStream and buffer this data.
      +
      StreamForwarder +
      A simple stream forwarder that uses a daemon thread to read from an InputStream and write it to a OutputStream.
      +
      +
      • +
    + + + +

    Package nl.esciencecenter.xenon.utils Description

    +
    This package is contains several utility classes.
    +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/package-tree.html b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/package-tree.html new file mode 100644 index 000000000..4f01804dc --- /dev/null +++ b/docs/versions/2.6.1/javadoc/nl/esciencecenter/xenon/utils/package-tree.html @@ -0,0 +1,146 @@ + + + + + +nl.esciencecenter.xenon.utils Class Hierarchy (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Hierarchy For Package nl.esciencecenter.xenon.utils

    +Package Hierarchies: + +
    +
    +

    Class Hierarchy

    + +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/overview-frame.html b/docs/versions/2.6.1/javadoc/overview-frame.html new file mode 100644 index 000000000..a00959007 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/overview-frame.html @@ -0,0 +1,24 @@ + + + + + +Overview List (xenon-2.3.0 2.6.1 API) + + + + +
    All Classes
    +
    +

    Packages

    + +
    +

     

    + + diff --git a/docs/versions/2.6.1/javadoc/overview-summary.html b/docs/versions/2.6.1/javadoc/overview-summary.html new file mode 100644 index 000000000..f29b4f038 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/overview-summary.html @@ -0,0 +1,740 @@ + + + + + +Overview (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + +
    +

    xenon-2.3.0 2.6.1 API

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

    See: Description

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Packages 
    PackageDescription
    nl.esciencecenter.xenon +
    This package is the main entry point into the Xenon API.
    +
    nl.esciencecenter.xenon.credentials +
    This package contains classes and interfaces for managing credentials.
    +
    nl.esciencecenter.xenon.filesystems +
    This package contains classes and interfaces for manipulating files.
    +
    nl.esciencecenter.xenon.schedulers +
    This package contains the classes and interfaces used to run jobs.
    +
    nl.esciencecenter.xenon.utils +
    This package is contains several utility classes.
    +
    +
    +
    + + +
    A middleware abstraction library that provides a simple programming interface to various compute and storage resources. +

    The main entry points are

    +

    Adaptor Documentation

    +

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

    + +

    Schedulers

    +

    local

    +

    The local jobs adaptor implements all functionality by emulating a local queue.

    +

    Supported locations:

    +Supported locations for Scheduler.create(type, location, credential, properties) method.
      +
    • [/workdir]
      • +
    +

    Supported properties:

    +Supported properties for Scheduler.create(type, location, credential, properties) method. + + + + + + + + + + + + + +
    NameDescriptionExpected typeDefault
    xenon.adaptors.schedulers.local.queue.pollingDelay
    		The polling delay for monitoring running jobs (in milliseconds).LONG1000
    xenon.adaptors.schedulers.local.queue.multi.maxConcurrentJobs
    		The maximum number of concurrent jobs in the multiq.INTEGER4
    +

    Supported features

      +
    • Batch: true
      • +
    • Interactive: true
      • +
    • Embedded: true
      • +
    • Uses a filesystem: true
      • +
    +

    ssh

    +

    The SSH job adaptor implements all functionality to start jobs on ssh servers.

    +

    Supported locations:

    +Supported locations for Scheduler.create(type, location, credential, properties) method.
      +
    • host[:port][/workdir][ via:otherhost[:port]]*
      • +
    +

    Supported properties:

    +Supported properties for Scheduler.create(type, location, credential, properties) method. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionExpected typeDefault
    xenon.adaptors.schedulers.ssh.strictHostKeyChecking
    		Enable strict host key checking.BOOLEANtrue
    xenon.adaptors.schedulers.ssh.loadKnownHosts
    		Load the standard known_hosts file.BOOLEANtrue
    xenon.adaptors.schedulers.ssh.loadSshConfig
    		Load the OpenSSH config file.BOOLEANtrue
    xenon.adaptors.schedulers.ssh.agent
    		Use a (local) ssh-agent.BOOLEANfalse
    xenon.adaptors.schedulers.ssh.agentForwarding
    		Use ssh-agent forwardingBOOLEANfalse
    xenon.adaptors.schedulers.ssh.timeout
    		The timeout for the connection setup and authetication (in milliseconds).LONG10000
    xenon.adaptors.schedulers.ssh.queue.pollingDelay
    		The polling delay for monitoring running jobs (in milliseconds).LONG1000
    xenon.adaptors.schedulers.ssh.queue.multi.maxConcurrentJobs
    		The maximum number of concurrent jobs in the multiq..INTEGER4
    +

    Supported features

      +
    • Batch: true
      • +
    • Interactive: true
      • +
    • Embedded: true
      • +
    • Uses a filesystem: true
      • +
    +

    gridengine

    +

    The SGE Adaptor submits jobs to a (Sun/Oracle/Univa) Grid Engine scheduler. This adaptor uses either the local or the ssh scheduler adaptor to run commands on the machine running Grid Engine, and the file or the stfp filesystem adaptor to gain access to the filesystem of that machine.

    +

    Supported locations:

    +Supported locations for Scheduler.create(type, location, credential, properties) method.
      +
    • local://[/workdir]
      • +
    • ssh://host[:port][/workdir][ via:otherhost[:port]]*
      • +
    +

    Supported properties:

    +Supported properties for Scheduler.create(type, location, credential, properties) method. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionExpected typeDefault
    xenon.adaptors.schedulers.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!BOOLEANfalse
    xenon.adaptors.schedulers.gridengine.accounting.grace.time
    		Number of milliseconds a job is allowed to take going from the queue to the qacct output.LONG60000
    xenon.adaptors.schedulers.gridengine.poll.delay
    		Number of milliseconds between polling the status of a job.LONG1000
    xenon.adaptors.schedulers.ssh.strictHostKeyChecking
    		Enable strict host key checking.BOOLEANtrue
    xenon.adaptors.schedulers.ssh.loadKnownHosts
    		Load the standard known_hosts file.BOOLEANtrue
    xenon.adaptors.schedulers.ssh.loadSshConfig
    		Load the OpenSSH config file.BOOLEANtrue
    xenon.adaptors.schedulers.ssh.agent
    		Use a (local) ssh-agent.BOOLEANfalse
    xenon.adaptors.schedulers.ssh.agentForwarding
    		Use ssh-agent forwardingBOOLEANfalse
    xenon.adaptors.schedulers.ssh.timeout
    		The timeout for the connection setup and authetication (in milliseconds).LONG10000
    xenon.adaptors.schedulers.ssh.queue.pollingDelay
    		The polling delay for monitoring running jobs (in milliseconds).LONG1000
    xenon.adaptors.schedulers.ssh.queue.multi.maxConcurrentJobs
    		The maximum number of concurrent jobs in the multiq..INTEGER4
    xenon.adaptors.schedulers.local.queue.pollingDelay
    		The polling delay for monitoring running jobs (in milliseconds).LONG1000
    xenon.adaptors.schedulers.local.queue.multi.maxConcurrentJobs
    		The maximum number of concurrent jobs in the multiq.INTEGER4
    +

    Supported features

      +
    • Batch: true
      • +
    • Interactive: false
      • +
    • Embedded: false
      • +
    • Uses a filesystem: true
      • +
    +

    slurm

    +

    The Slurm Adaptor submits jobs to a Slurm scheduler. This adaptor uses either the local or the ssh scheduler adaptor to run commands on the machine running Slurm, and the file or the stfp filesystem adaptor to gain access to the filesystem of that machine.

    +

    Supported locations:

    +Supported locations for Scheduler.create(type, location, credential, properties) method.
      +
    • local://[/workdir]
      • +
    • ssh://host[:port][/workdir][ via:otherhost[:port]]*
      • +
    +

    Supported properties:

    +Supported properties for Scheduler.create(type, location, credential, properties) method. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionExpected typeDefault
    xenon.adaptors.schedulers.slurm.disable.accounting.usage
    		Do not use accounting info of slurm, even when available. Mostly for testing purposesBOOLEANfalse
    xenon.adaptors.schedulers.slurm.poll.delay
    		Number of milliseconds between polling the status of a job.LONG1000
    xenon.adaptors.schedulers.ssh.strictHostKeyChecking
    		Enable strict host key checking.BOOLEANtrue
    xenon.adaptors.schedulers.ssh.loadKnownHosts
    		Load the standard known_hosts file.BOOLEANtrue
    xenon.adaptors.schedulers.ssh.loadSshConfig
    		Load the OpenSSH config file.BOOLEANtrue
    xenon.adaptors.schedulers.ssh.agent
    		Use a (local) ssh-agent.BOOLEANfalse
    xenon.adaptors.schedulers.ssh.agentForwarding
    		Use ssh-agent forwardingBOOLEANfalse
    xenon.adaptors.schedulers.ssh.timeout
    		The timeout for the connection setup and authetication (in milliseconds).LONG10000
    xenon.adaptors.schedulers.ssh.queue.pollingDelay
    		The polling delay for monitoring running jobs (in milliseconds).LONG1000
    xenon.adaptors.schedulers.ssh.queue.multi.maxConcurrentJobs
    		The maximum number of concurrent jobs in the multiq..INTEGER4
    xenon.adaptors.schedulers.local.queue.pollingDelay
    		The polling delay for monitoring running jobs (in milliseconds).LONG1000
    xenon.adaptors.schedulers.local.queue.multi.maxConcurrentJobs
    		The maximum number of concurrent jobs in the multiq.INTEGER4
    +

    Supported features

      +
    • Batch: true
      • +
    • Interactive: true
      • +
    • Embedded: false
      • +
    • Uses a filesystem: true
      • +
    +

    torque

    +

    The Torque Adaptor submits jobs to a TORQUE batch system. This adaptor uses either the local or the ssh scheduler adaptor to run commands on the machine running TORQUE, and the file or the stfp filesystem adaptor to gain access to the filesystem of that machine.

    +

    Supported locations:

    +Supported locations for Scheduler.create(type, location, credential, properties) method.
      +
    • local://[/workdir]
      • +
    • ssh://host[:port][/workdir][ via:otherhost[:port]]*
      • +
    +

    Supported properties:

    +Supported properties for Scheduler.create(type, location, credential, properties) method. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionExpected typeDefault
    xenon.adaptors.schedulers.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!BOOLEANfalse
    xenon.adaptors.schedulers.torque.accounting.grace.time
    		Number of milliseconds a job is allowed to take going from the queue to the accinfo output.LONG60000
    xenon.adaptors.schedulers.torque.poll.delay
    		Number of milliseconds between polling the status of a job.LONG1000
    xenon.adaptors.schedulers.ssh.strictHostKeyChecking
    		Enable strict host key checking.BOOLEANtrue
    xenon.adaptors.schedulers.ssh.loadKnownHosts
    		Load the standard known_hosts file.BOOLEANtrue
    xenon.adaptors.schedulers.ssh.loadSshConfig
    		Load the OpenSSH config file.BOOLEANtrue
    xenon.adaptors.schedulers.ssh.agent
    		Use a (local) ssh-agent.BOOLEANfalse
    xenon.adaptors.schedulers.ssh.agentForwarding
    		Use ssh-agent forwardingBOOLEANfalse
    xenon.adaptors.schedulers.ssh.timeout
    		The timeout for the connection setup and authetication (in milliseconds).LONG10000
    xenon.adaptors.schedulers.ssh.queue.pollingDelay
    		The polling delay for monitoring running jobs (in milliseconds).LONG1000
    xenon.adaptors.schedulers.ssh.queue.multi.maxConcurrentJobs
    		The maximum number of concurrent jobs in the multiq..INTEGER4
    xenon.adaptors.schedulers.local.queue.pollingDelay
    		The polling delay for monitoring running jobs (in milliseconds).LONG1000
    xenon.adaptors.schedulers.local.queue.multi.maxConcurrentJobs
    		The maximum number of concurrent jobs in the multiq.INTEGER4
    +

    Supported features

      +
    • Batch: true
      • +
    • Interactive: false
      • +
    • Embedded: false
      • +
    • Uses a filesystem: true
      • +
    +

    File systems

    +

    file

    +

    This is the local file adaptor that implements file functionality for local access.

    +

    Supported locations:

    +Supported locations for FileSystem.create(type, location, credential, properties) method. +
  • (null)
    • +
  • (empty string)
    • +
  • [/workdir]
    • +
  • driveletter:[/workdir]
    • + +

    Supported properties:

    +Supported properties for FileSystem.create(type, location, credential, properties) method. + + + + + + + +
    NameDescriptionExpected typeDefault
    xenon.adaptors.filesystems.file.bufferSize
    		The buffer size to use when copying files (in bytes).SIZE64K
    +

    Supported features

      +
    • Read symbolic links: true
      • +
    • Create symbolic links: true
      • +
    • Third party copy: false
      • +
    +

    ftp

    +

    The FTP adaptor implements file access on remote ftp servers.

    +

    Supported locations:

    +Supported locations for FileSystem.create(type, location, credential, properties) method. +
  • host[:port][/workdir]
    • + +

    Supported properties:

    +Supported properties for FileSystem.create(type, location, credential, properties) method. + + + + + + + +
    NameDescriptionExpected typeDefault
    xenon.adaptors.filesystems.ftp.bufferSize
    		The buffer size to use when copying files (in bytes).SIZE64K
    +

    Supported features

      +
    • Read symbolic links: true
      • +
    • Create symbolic links: false
      • +
    • Third party copy: false
      • +
    +

    sftp

    +

    The SFTP adaptor implements all file access functionality to remote SFTP servers

    +

    Supported locations:

    +Supported locations for FileSystem.create(type, location, credential, properties) method. +
  • host[:port][/workdir]
    • + +

    Supported properties:

    +Supported properties for FileSystem.create(type, location, credential, properties) method. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionExpected typeDefault
    xenon.adaptors.filesystems.sftp.strictHostKeyChecking
    		Enable strict host key checking.BOOLEANtrue
    xenon.adaptors.filesystems.sftp.loadKnownHosts
    		Load the standard known_hosts file.BOOLEANtrue
    xenon.adaptors.filesystems.sftp.loadSshConfig
    		Load the OpenSSH config file.BOOLEANtrue
    xenon.adaptors.filesystems.sftp.agent
    		Use a (local) ssh-agent.BOOLEANfalse
    xenon.adaptors.filesystems.sftp.agentForwarding
    		Use ssh-agent forwarding when setting up a connection.BOOLEANfalse
    xenon.adaptors.filesystems.sftp.connection.timeout
    		The timeout for creating and authenticating connections (in milliseconds).NATURAL10000
    xenon.adaptors.filesystems.sftp.bufferSize
    		The buffer size to use when copying files (in bytes).SIZE64K
    +

    Supported features

      +
    • Read symbolic links: true
      • +
    • Create symbolic links: true
      • +
    • Third party copy: false
      • +
    +

    webdav

    +

    The webdav file adaptor implements file access to remote webdav servers.

    +

    Supported locations:

    +Supported locations for FileSystem.create(type, location, credential, properties) method. +
  • http://host[:port][/workdir]
    • +
  • https://host[:port][/workdir]
    • + +

    Supported properties:

    +Supported properties for FileSystem.create(type, location, credential, properties) method. + + + + + + + +
    NameDescriptionExpected typeDefault
    xenon.adaptors.filesystems.webdav.bufferSize
    		The buffer size to use when copying files (in bytes).SIZE64K
    +

    Supported features

      +
    • Read symbolic links: false
      • +
    • Create symbolic links: false
      • +
    • Third party copy: false
      • +
    +

    s3

    +

    The JClouds adaptor uses Apache JClouds to talk to s3 and others

    +

    Supported locations:

    +Supported locations for FileSystem.create(type, location, credential, properties) method. +
  • [http://host[:port]]/bucketname[/workdir]
    • + +

    Supported properties:

    +Supported properties for FileSystem.create(type, location, credential, properties) method. + + + + + + + +
    NameDescriptionExpected typeDefault
    xenon.adaptors.filesystems.s3.bufferSize
    		The buffer size to use when copying files (in bytes).SIZE64K
    +

    Supported features

      +
    • Read symbolic links: false
      • +
    • Create symbolic links: false
      • +
    • Third party copy: false
      • +
    +

    hdfs

    +

    Adaptor for the Apache Hadoop file system

    +

    Supported locations:

    +Supported locations for FileSystem.create(type, location, credential, properties) method. +
  • hdfs://host[:port]
    • + +

    Supported properties:

    +Supported properties for FileSystem.create(type, location, credential, properties) method. + + + + + + + + + + + + + +
    NameDescriptionExpected typeDefault
    xenon.adaptors.filesystems.hdfs.bufferSize
    		The buffer size to use when copying files (in bytes).SIZE64K
    xenon.adaptors.filesystems.hdfs.hadoopSettingsFile
    		The path to the file with the hadoop settings, i.e. "/home/xenon/core-site.xml".STRING
    +

    Supported features

      +
    • Read symbolic links: false
      • +
    • Create symbolic links: false
      • +
    • Third party copy: false
      • +
    +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/overview-tree.html b/docs/versions/2.6.1/javadoc/overview-tree.html new file mode 100644 index 000000000..52fffc179 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/overview-tree.html @@ -0,0 +1,234 @@ + + + + + +Class Hierarchy (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + +
    +

    Hierarchy For All Packages

    +Package Hierarchies: + +
    +
    +

    Class Hierarchy

    + +

    Interface Hierarchy

    + +

    Enum Hierarchy

    + +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/package-list b/docs/versions/2.6.1/javadoc/package-list new file mode 100644 index 000000000..9cbac2f80 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/package-list @@ -0,0 +1,5 @@ +nl.esciencecenter.xenon +nl.esciencecenter.xenon.credentials +nl.esciencecenter.xenon.filesystems +nl.esciencecenter.xenon.schedulers +nl.esciencecenter.xenon.utils diff --git a/docs/versions/2.6.1/javadoc/script.js b/docs/versions/2.6.1/javadoc/script.js new file mode 100644 index 000000000..b34635693 --- /dev/null +++ b/docs/versions/2.6.1/javadoc/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/docs/versions/2.6.1/javadoc/serialized-form.html b/docs/versions/2.6.1/javadoc/serialized-form.html new file mode 100644 index 000000000..303e2d3bb --- /dev/null +++ b/docs/versions/2.6.1/javadoc/serialized-form.html @@ -0,0 +1,373 @@ + + + + + +Serialized Form (xenon-2.3.0 2.6.1 API) + + + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + +
    +

    Serialized Form

    +
    +
    + +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + + + diff --git a/docs/versions/2.6.1/javadoc/stylesheet.css b/docs/versions/2.6.1/javadoc/stylesheet.css new file mode 100644 index 000000000..98055b22d --- /dev/null +++ b/docs/versions/2.6.1/javadoc/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/gradle/common.gradle b/gradle/common.gradle index f0d4456cd..59f6a4341 100644 --- a/gradle/common.gradle +++ b/gradle/common.gradle @@ -5,7 +5,7 @@ defaultTasks 'clean', 'assemble', 'test' // METADATA // ============== -version = '2.6.0' +version = '2.6.1' description = 'Xenon: a middleware abstraction library that provides a simple programming interface to various compute and storage resources.' // will generate a warning with JDK 8, since the runtime jar (rt.jar) of